Package net.sf.jasperreports.engine
Interface JRQueryChunk
-
- All Superinterfaces:
Cloneable
,JRCloneable
- All Known Implementing Classes:
JRBaseQueryChunk
,JRDesignQueryChunk
public interface JRQueryChunk extends JRCloneable
- Author:
- Teodor Danciu (teodord@users.sourceforge.net)
-
-
Field Summary
Fields Modifier and Type Field Description static String
PROPERTY_CHUNK_TOKEN_SEPARATOR
A property that specifies the list of token separators fortokenized query clauses
.static byte
TYPE_CLAUSE_TOKENS
A$X{..}
query clause containing one or several tokens.static byte
TYPE_PARAMETER
static byte
TYPE_PARAMETER_CLAUSE
static byte
TYPE_TEXT
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getText()
String[]
getTokens()
Returns the chunk tokens forclause
chunks.Character
getTokenSeparator()
Returns the chunk tokens separator character forclause
chunks.byte
getType()
-
Methods inherited from interface net.sf.jasperreports.engine.JRCloneable
clone
-
-
-
-
Field Detail
-
PROPERTY_CHUNK_TOKEN_SEPARATOR
static final String PROPERTY_CHUNK_TOKEN_SEPARATOR
A property that specifies the list of token separators fortokenized query clauses
.The default separators are the comma (
','
), the semicolon (';'
) and the vertical bar ('|'
).- See Also:
- Constant Field Values
-
TYPE_TEXT
static final byte TYPE_TEXT
- See Also:
- Constant Field Values
-
TYPE_PARAMETER
static final byte TYPE_PARAMETER
- See Also:
- Constant Field Values
-
TYPE_PARAMETER_CLAUSE
static final byte TYPE_PARAMETER_CLAUSE
- See Also:
- Constant Field Values
-
TYPE_CLAUSE_TOKENS
static final byte TYPE_CLAUSE_TOKENS
A$X{..}
query clause containing one or several tokens.The clause will be processed by the query executer. The default implementation treats the first token as a function ID and delegates the processing to a
function
registered for the ID.The clause text is tokenized in the following manner:
- The first appearance of any separator (as specified by
PROPERTY_CHUNK_TOKEN_SEPARATOR
) if located in the clause text. - This separator is then used to tokenize the entire text, including the remaining separators characters in tokens.
- The first appearance of any separator (as specified by
-
-