01: /*
02: * ============================================================================
03: * GNU Lesser General Public License
04: * ============================================================================
05: *
06: * JasperReports - Free Java report-generating library.
07: * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
08: *
09: * This library is free software; you can redistribute it and/or
10: * modify it under the terms of the GNU Lesser General Public
11: * License as published by the Free Software Foundation; either
12: * version 2.1 of the License, or (at your option) any later version.
13: *
14: * This library is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17: * Lesser General Public License for more details.
18: *
19: * You should have received a copy of the GNU Lesser General Public
20: * License along with this library; if not, write to the Free Software
21: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22: *
23: * JasperSoft Corporation
24: * 303 Second Street, Suite 450 North
25: * San Francisco, CA 94107
26: * http://www.jaspersoft.com
27: */
28: package net.sf.jasperreports.engine;
29:
30: import net.sf.jasperreports.engine.query.JRClauseFunction;
31:
32: /**
33: * @author Teodor Danciu (teodord@users.sourceforge.net)
34: * @version $Id: JRQueryChunk.java 1683 2007-03-29 16:04:15Z lucianc $
35: */
36: public interface JRQueryChunk {
37:
38: /**
39: *
40: */
41: public static final byte TYPE_TEXT = 1;
42: public static final byte TYPE_PARAMETER = 2;
43: public static final byte TYPE_PARAMETER_CLAUSE = 3;
44:
45: /**
46: * A <code>$X{..}</code> query clause containing one or several comma-separated tokens.
47: * <p>
48: * The clause will be processed by the query executer.
49: * The default implementation treats the first token as a function ID and delegates the processing
50: * to a {@link JRClauseFunction function} registered for the ID.
51: * </p>
52: * @see #getTokens()
53: */
54: public static final byte TYPE_CLAUSE_TOKENS = 4;
55:
56: /**
57: *
58: */
59: public byte getType();
60:
61: /**
62: *
63: */
64: public String getText();
65:
66: /**
67: * Returns the chunk tokens for {@link #TYPE_CLAUSE_TOKENS clause} chunks.
68: *
69: * @return the chunk tokens
70: */
71: public String[] getTokens();
72: }
|