Class QLParser

java.lang.Object

org.apache.cayenne.ql.QLParser

All Implemented Interfaces:

QLParserConstants, QLParserTreeConstants

public class QLParser
extends Object
implements QLParserTreeConstants, QLParserConstants

Parser of Cayenne expressions and queries. Has two entry points: expression() that parses a standalone expression, and query() that parses a full select query, whose clauses embed the same expressions. parse(String, ParseFunction) runs either of them over a String.

Since:

5.0 renamed from ExpressionParser and extended to parse queries.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QLParser.ParseFunction<T>	A function run over a fresh parser, see query() or expression().

Field Summary

Fields

Modifier and Type	Field	Description
Token	jj_nt	Next token.
protected JJTQLParserState	jjtree
Token	token	Current token.
QLParserTokenManager	token_source	Generated Token Manager.

Fields inherited from interface QLParserConstants

ABS, AGGREGATE, ASTERISK, AVG, CONCAT, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DAY, DAY_OF_MONTH, DAY_OF_WEEK, DAY_OF_YEAR, DEC_DIGITS, DEC_FLT, DEFAULT, DIGIT, DISTINCT, DOLLAR_SIGN, DOUBLE_QUOTED_STRING, EOF, ESC, EXISTS, EXPONENT, FALSE, FLOAT_LITERAL, FLT_SUFF, FUNCTION, HOUR, IDENTIFIER, INT_LITERAL, LENGTH, LETTER, LOCATE, LOWER, MAX, MIN, MINUTE, MOD, MONTH, NOT_EXISTS, NULL, OPERATOR, PROPERTY_PATH, SECOND, SELF, SINGLE_QUOTED_STRING, SQRT, STRING_ESC, SUBSTRING, SUM, tokenImage, TRIM, TRUE, UPPER, WEEK, WithinDoubleQuoteLiteral, WithinSingleQuoteLiteral, YEAR

Fields inherited from interface QLParserTreeConstants

JJTABSEXP, JJTADDEXP, JJTALLEXP, JJTANDEXP, JJTANYEXP, JJTASTERISKEXP, JJTAVGEXP, JJTBETWEENEXP, JJTBITWISEANDEXP, JJTBITWISELEFTSHIFTEXP, JJTBITWISENOTEXP, JJTBITWISEOREXP, JJTBITWISERIGHTSHIFTEXP, JJTBITWISEXOREXP, JJTCONCATEXP, JJTCOUNTEXP, JJTCURRENTDATEEXP, JJTCURRENTTIMEEXP, JJTCURRENTTIMESTAMPEXP, JJTCUSTOMAGGREGATEEXP, JJTCUSTOMFUNCTIONEXP, JJTCUSTOMOPERATOREXP, JJTDBIDPATHEXP, JJTDBPATHEXP, JJTDISTINCTEXP, JJTDIVIDEEXP, JJTENCLOSINGOBJECTEXP, JJTEQUALEXP, JJTEXISTSEXP, JJTEXTRACTEXP, JJTFALSEEXP, JJTFULLOBJECTEXP, JJTGREATEREXP, JJTGREATEROREQUALEXP, JJTINEXP, JJTLENGTHEXP, JJTLESSEXP, JJTLESSOREQUALEXP, JJTLIKEEXP, JJTLIKEIGNORECASEEXP, JJTLISTEXP, JJTLOCATEEXP, JJTLOWEREXP, JJTMAXEXP, JJTMINEXP, JJTMODEXP, JJTMULTIPLYEXP, JJTNEGATEEXP, jjtNodeName, JJTNOTBETWEENEXP, JJTNOTEQUALEXP, JJTNOTEXISTSEXP, JJTNOTEXP, JJTNOTINEXP, JJTNOTLIKEEXP, JJTNOTLIKEIGNORECASEEXP, JJTOBJPATHEXP, JJTOREXP, JJTSQRTEXP, JJTSUBSTRINGEXP, JJTSUBTRACTEXP, JJTSUMEXP, JJTTRIMEXP, JJTTRUEEXP, JJTUPPEREXP, JJTVOID

Constructor Summary

Constructors

Constructor	Description
QLParser(InputStream stream)	Constructor with InputStream.
QLParser(InputStream stream, String encoding)	Constructor with InputStream and supplied encoding
QLParser(Reader stream)	Constructor.
QLParser(QLParserTokenManager tm)	Constructor with generated Token Manager.

Method Summary

Modifier and Type	Method	Description
final void	abs()
final void	aggregateExpression()
final void	allSubquery()
final void	andCondition()
final void	anySubquery()
final void	arithmeticExp()
final void	asterisk()
final void	avg()
final void	bitwiseAnd()
final void	bitwiseOr()
final void	bitwiseShift()
final void	bitwiseXor()
void	checkParametersBound()	Should be called when the parsing is finished to ensure all positional values were consumed.
final void	column(org.apache.cayenne.ql.QLSelectBuilder builder)
final void	comparisonOperand()
final void	concat()
final void	conditionExpression()
final void	count()
final void	currentDate()
final void	currentTime()
final void	currentTimestamp()
final void	customAggregate()
final void	customFunction()
final void	customOperator()
final void	dateTimeExtractingFunction()
final void	dateTimeFunction()
final void	disable_tracing()	Disable tracing.
final void	distinct()
final void	enable_tracing()	Enable tracing.
final void	enclosing()
final Expression	expression()
final void	fromClause(org.apache.cayenne.ql.QLSelectBuilder builder)
final void	functionsReturningNumerics()
final void	functionsReturningStrings()
ParseException	generateParseException()	Generate ParseException.
final Token	getNextToken()	Get the next Token.
final Token	getToken(int index)	Get the specific Token.
final void	inOperand()
final void	keyword(String keyword)
final void	length()
final void	limitClause(org.apache.cayenne.ql.QLSelectBuilder builder)
final void	locate()
final void	lower()
final void	max()
final void	min()
final void	mod()
final void	multiplySubtractExp()
final String	name()
final void	namedParameter()
final void	notCondition()
final void	numericExpression()
final void	numericPrimary()
final void	numericTerm()
final void	numericTermExt()
final void	offsetClause(org.apache.cayenne.ql.QLSelectBuilder builder)
final void	orCondition()
final void	orderClause(org.apache.cayenne.ql.QLSelectBuilder builder)
final void	ordering(org.apache.cayenne.ql.QLSelectBuilder builder)
static <T> T	parse(String text, QLParser.ParseFunction<T> function)	Build a parser and let the caller decide how to process the result.
final void	pathExpression()
final Token	pathToken()
final void	prefetch(org.apache.cayenne.ql.QLSelectBuilder builder)
final void	prefetchClause(org.apache.cayenne.ql.QLSelectBuilder builder)
final FluentSelect<?,?>	query()
void	ReInit(InputStream stream)	Reinitialise.
void	ReInit(InputStream stream, String encoding)	Reinitialise.
void	ReInit(Reader stream)	Reinitialise.
void	ReInit(QLParserTokenManager tm)	Reinitialise.
final void	scalarCommaList()
final void	scalarConstExpression()
final void	scalarExpression()
final FluentSelect<?,?>	select(boolean root)
final void	selectClause(org.apache.cayenne.ql.QLSelectBuilder builder)
void	setParameters(Object... parameters)	Sets positional values to bind in place of the "$name" tokens, in the order of the first occurrence of the names in the parsed String.
void	setParameters(Map<String,?> parameters)	Sets the values to bind in place of the "$name" tokens by name.
final void	simpleCondition()
final void	simpleNotCondition()
final void	sqrt()
final void	stringExpression()
final void	stringLiteral()
final void	stringParameter()
final void	subquery()
final void	substring()
final void	sum()
final boolean	trace_enabled()	Trace enabled.
final void	trim()
final void	upper()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

jjtree

protected JJTQLParserState jjtree

token_source

public QLParserTokenManager token_source

Generated Token Manager.

token

public Token token

Current token.

jj_nt

public Token jj_nt

Next token.

Constructor Details

QLParser

public QLParser(InputStream stream)

Constructor with InputStream.

QLParser

public QLParser(InputStream stream,
 String encoding)

Constructor with InputStream and supplied encoding

QLParser

public QLParser(Reader stream)

Constructor.

QLParser

public QLParser(QLParserTokenManager tm)

Constructor with generated Token Manager.

Method Details

parse

public static <T> T parse(String text,
 QLParser.ParseFunction<T> function)

Build a parser and let the caller decide how to process the result. Any error is rethrown as an ExpressionException with the original error as its cause.

Since:

5.0

setParameters

public void setParameters(Object... parameters)

Sets positional values to bind in place of the "$name" tokens, in the order of the first occurrence of the names in the parsed String. A name that occurs more than once consumes a single value. If neither this nor setParameters(Map) is called, the parameters are preserved in the parsed tree.

setParameters

public void setParameters(Map<String,?> parameters)

Sets the values to bind in place of the "$name" tokens by name. Unlike the positional values, a name missing from the map is not an error: the parameter is preserved, and the smallest condition of a "where" or "having" clause that contains it is pruned, in the main query and in the subqueries alike. A null value in the map is bound as is.

checkParametersBound

public void checkParametersBound()

Should be called when the parsing is finished to ensure all positional values were consumed.

expression

public final Expression expression()
                            throws ParseException

Throws:

ParseException

query

public final FluentSelect<?,?> query()
                              throws ParseException

Throws:

ParseException

select

public final FluentSelect<?,?> select(boolean root)
                               throws ParseException

Throws:

ParseException

keyword

public final void keyword(String keyword)
                   throws ParseException

Throws:

ParseException

name

public final String name()
                  throws ParseException

Throws:

ParseException

selectClause

public final void selectClause(org.apache.cayenne.ql.QLSelectBuilder builder)
                        throws ParseException

Throws:

ParseException

column

public final void column(org.apache.cayenne.ql.QLSelectBuilder builder)
                  throws ParseException

Throws:

ParseException

fromClause

public final void fromClause(org.apache.cayenne.ql.QLSelectBuilder builder)
                      throws ParseException

Throws:

ParseException

orderClause

public final void orderClause(org.apache.cayenne.ql.QLSelectBuilder builder)
                       throws ParseException

Throws:

ParseException

ordering

public final void ordering(org.apache.cayenne.ql.QLSelectBuilder builder)
                    throws ParseException

Throws:

ParseException

limitClause

public final void limitClause(org.apache.cayenne.ql.QLSelectBuilder builder)
                       throws ParseException

Throws:

ParseException

offsetClause

public final void offsetClause(org.apache.cayenne.ql.QLSelectBuilder builder)
                        throws ParseException

Throws:

ParseException

prefetchClause

public final void prefetchClause(org.apache.cayenne.ql.QLSelectBuilder builder)
                          throws ParseException

Throws:

ParseException

prefetch

public final void prefetch(org.apache.cayenne.ql.QLSelectBuilder builder)
                    throws ParseException

Throws:

ParseException

subquery

public final void subquery()
                    throws ParseException

Throws:

ParseException

allSubquery

public final void allSubquery()
                       throws ParseException

Throws:

ParseException

anySubquery

public final void anySubquery()
                       throws ParseException

Throws:

ParseException

comparisonOperand

public final void comparisonOperand()
                             throws ParseException

Throws:

ParseException

inOperand

public final void inOperand()
                     throws ParseException

Throws:

ParseException

orCondition

public final void orCondition()
                       throws ParseException

Throws:

ParseException

andCondition

public final void andCondition()
                        throws ParseException

Throws:

ParseException

notCondition

public final void notCondition()
                        throws ParseException

Throws:

ParseException

simpleCondition

public final void simpleCondition()
                           throws ParseException

Throws:

ParseException

simpleNotCondition

public final void simpleNotCondition()
                              throws ParseException

Throws:

ParseException

scalarCommaList

public final void scalarCommaList()
                           throws ParseException

Throws:

ParseException

conditionExpression

public final void conditionExpression()
                               throws ParseException

Throws:

ParseException

stringParameter

public final void stringParameter()
                           throws ParseException

Throws:

ParseException

stringLiteral

public final void stringLiteral()
                         throws ParseException

Throws:

ParseException

stringExpression

public final void stringExpression()
                            throws ParseException

Throws:

ParseException

scalarExpression

public final void scalarExpression()
                            throws ParseException

Throws:

ParseException

scalarConstExpression

public final void scalarConstExpression()
                                 throws ParseException

Throws:

ParseException

numericExpression

public final void numericExpression()
                             throws ParseException

Throws:

ParseException

bitwiseOr

public final void bitwiseOr()
                     throws ParseException

Throws:

ParseException

bitwiseXor

public final void bitwiseXor()
                      throws ParseException

Throws:

ParseException

bitwiseAnd

public final void bitwiseAnd()
                      throws ParseException

Throws:

ParseException

bitwiseShift

public final void bitwiseShift()
                        throws ParseException

Throws:

ParseException

arithmeticExp

public final void arithmeticExp()
                         throws ParseException

Throws:

ParseException

multiplySubtractExp

public final void multiplySubtractExp()
                               throws ParseException

Throws:

ParseException

numericTermExt

public final void numericTermExt()
                          throws ParseException

Throws:

ParseException

numericTerm

public final void numericTerm()
                       throws ParseException

Throws:

ParseException

numericPrimary

public final void numericPrimary()
                          throws ParseException

Throws:

ParseException

enclosing

public final void enclosing()
                     throws ParseException

Throws:

ParseException

functionsReturningStrings

public final void functionsReturningStrings()
                                     throws ParseException

Throws:

ParseException

customFunction

public final void customFunction()
                          throws ParseException

Throws:

ParseException

customOperator

public final void customOperator()
                          throws ParseException

Throws:

ParseException

customAggregate

public final void customAggregate()
                           throws ParseException

Throws:

ParseException

concat

public final void concat()
                  throws ParseException

Throws:

ParseException

substring

public final void substring()
                     throws ParseException

Throws:

ParseException

trim

public final void trim()
                throws ParseException

Throws:

ParseException

lower

public final void lower()
                 throws ParseException

Throws:

ParseException

upper

public final void upper()
                 throws ParseException

Throws:

ParseException

functionsReturningNumerics

public final void functionsReturningNumerics()
                                      throws ParseException

Throws:

ParseException

length

public final void length()
                  throws ParseException

Throws:

ParseException

locate

public final void locate()
                  throws ParseException

Throws:

ParseException

abs

public final void abs()
               throws ParseException

Throws:

ParseException

sqrt

public final void sqrt()
                throws ParseException

Throws:

ParseException

mod

public final void mod()
               throws ParseException

Throws:

ParseException

aggregateExpression

public final void aggregateExpression()
                               throws ParseException

Throws:

ParseException

asterisk

public final void asterisk()
                    throws ParseException

Throws:

ParseException

count

public final void count()
                 throws ParseException

Throws:

ParseException

avg

public final void avg()
               throws ParseException

Throws:

ParseException

max

public final void max()
               throws ParseException

Throws:

ParseException

min

public final void min()
               throws ParseException

Throws:

ParseException

sum

public final void sum()
               throws ParseException

Throws:

ParseException

dateTimeFunction

public final void dateTimeFunction()
                            throws ParseException

Throws:

ParseException

currentDate

public final void currentDate()
                       throws ParseException

Throws:

ParseException

currentTime

public final void currentTime()
                       throws ParseException

Throws:

ParseException

currentTimestamp

public final void currentTimestamp()
                            throws ParseException

Throws:

ParseException

dateTimeExtractingFunction

public final void dateTimeExtractingFunction()
                                      throws ParseException

Throws:

ParseException

distinct

public final void distinct()
                    throws ParseException

Throws:

ParseException

namedParameter

public final void namedParameter()
                          throws ParseException

Throws:

ParseException

pathExpression

public final void pathExpression()
                          throws ParseException

Throws:

ParseException

pathToken

public final Token pathToken()
                      throws ParseException

Throws:

ParseException

ReInit

public void ReInit(InputStream stream)

Reinitialise.

ReInit

public void ReInit(InputStream stream,
 String encoding)

Reinitialise.

ReInit

public void ReInit(Reader stream)

Reinitialise.

ReInit

public void ReInit(QLParserTokenManager tm)

Reinitialise.

getNextToken

public final Token getNextToken()

Get the next Token.

getToken

public final Token getToken(int index)

Get the specific Token.

generateParseException

public ParseException generateParseException()

Generate ParseException.

trace_enabled

public final boolean trace_enabled()

Trace enabled.

enable_tracing

public final void enable_tracing()

Enable tracing.

disable_tracing

public final void disable_tracing()

Disable tracing.