Top Description Fields Constructors Methods
org.hibernate.hql.internal.antlr

public Class HqlBaseParser

extends LLkParser
implements HqlTokenTypes
Class Inheritance
All Implemented Interfaces
org.hibernate.hql.internal.antlr.HqlTokenTypes
Known Direct Subclasses
org.hibernate.hql.internal.ast.HqlParser
Imports
org.hibernate.hql.internal.ast.*, org.hibernate.hql.internal.ast.util.*, antlr.TokenBuffer, .TokenStreamException, .TokenStreamIOException, .ANTLRException, .LLkParser, .Token, .TokenStream, .RecognitionException, .NoViableAltException, .MismatchedTokenException, .SemanticException, .ParserSharedInputState, .ASTFactory, .ASTPair, antlr.collections.impl.BitSet, .ASTArray, antlr.collections.AST, java.util.Hashtable
Hibernate Query Language Grammar
This grammar parses the query language for Hibernate (an Open Source, Object-Relational mapping library). A partial BNF grammar description is available for reference here: http://www.hibernate.org/Documentation/HQLBNF Text from the original reference BNF is prefixed with '//##'.
Author
Joshua Davis ([email protected])

Field Summary

Modifier and TypeField and Description
public static final String[]
_tokenNames

public static final BitSet
_tokenSet_0

public static final BitSet
_tokenSet_1

public static final BitSet
_tokenSet_10

public static final BitSet
_tokenSet_11

public static final BitSet
_tokenSet_12

public static final BitSet
_tokenSet_13

public static final BitSet
_tokenSet_14

public static final BitSet
_tokenSet_15

public static final BitSet
_tokenSet_16

public static final BitSet
_tokenSet_17

public static final BitSet
_tokenSet_18

public static final BitSet
_tokenSet_19

public static final BitSet
_tokenSet_2

public static final BitSet
_tokenSet_20

public static final BitSet
_tokenSet_21

public static final BitSet
_tokenSet_22

public static final BitSet
_tokenSet_23

public static final BitSet
_tokenSet_24

public static final BitSet
_tokenSet_25

public static final BitSet
_tokenSet_26

public static final BitSet
_tokenSet_27

public static final BitSet
_tokenSet_28

public static final BitSet
_tokenSet_29

public static final BitSet
_tokenSet_3

public static final BitSet
_tokenSet_30

public static final BitSet
_tokenSet_31

public static final BitSet
_tokenSet_32

public static final BitSet
_tokenSet_33

public static final BitSet
_tokenSet_34

public static final BitSet
_tokenSet_35

public static final BitSet
_tokenSet_36

public static final BitSet
_tokenSet_37

public static final BitSet
_tokenSet_38

public static final BitSet
_tokenSet_39

public static final BitSet
_tokenSet_4

public static final BitSet
_tokenSet_40

public static final BitSet
_tokenSet_41

public static final BitSet
_tokenSet_42

public static final BitSet
_tokenSet_43

public static final BitSet
_tokenSet_44

public static final BitSet
_tokenSet_45

public static final BitSet
_tokenSet_46

public static final BitSet
_tokenSet_47

public static final BitSet
_tokenSet_48

public static final BitSet
_tokenSet_5

public static final BitSet
_tokenSet_6

public static final BitSet
_tokenSet_7

public static final BitSet
_tokenSet_8

public static final BitSet
_tokenSet_9

private boolean
filter

True if this is a filter query (allow no FROM clause).

Constructor Summary

AccessConstructor and Description
protected
HqlBaseParser(TokenBuffer tokenBuf, int k)

public
HqlBaseParser(TokenBuffer tokenBuf)

protected
HqlBaseParser(TokenStream lexer, int k)

public
HqlBaseParser(TokenStream lexer)

public
HqlBaseParser(ParserSharedInputState state)

Method Summary

Modifier and TypeMethod and Description
public final void
additiveExpression()

public final void
aggregate()

public final void
alias()

public final void
aliasedExpression()

public final void
asAlias()

public final void
ascendingOrDescending()

public final void
assignment()

public final void
atom()

public final void
betweenList()

protected void
buildTokenTypeASTClassMap()

public final void
caseExpression()

public final void
castedIdentPrimaryBase()

public final void
castedJoinPath()

Represents the JPA 2.1 TREAT construct when applied to a join.

public final void
castFunction()

public final void
castTargetType()

public final void
collectionExpr()

public final void
collectionPath()

public final void
collectionPathQualifier()

public final void
collectionSizeFunction()

public final void
compoundExpr()

public final void
concatenation()

public final void
constant()

public final void
deleteStatement()

public final void
elseClause()

public final void
equalityExpression()

public void
expectNamedParameterName()

Called after we have recognized ':'.

public final void
expression()

public final void
expressionOrVector()

public final void
exprList()

public void
firstPathTokenWeakKeywords()

public final void
fkRefPath()

public final void
fromClassOrOuterQueryPath()

public final void
fromClause()

public final void
fromJoin()

public final void
fromRange()

public final void
groupByClause()

public void
handleDotIdent()

This method looks ahead and converts .

public AST
handleIdentifierError(Token
The token to retry as an identifier.
token, RecognitionException
The exception to throw if it cannot be retried as an identifier.
ex)

This method is overridden in the sub class in order to provide the 'keyword as identifier' hack.

public void
handlePrimaryExpressionDotIdent()

public final void
havingClause()

public final void
identifier()

public final void
identPrimary()

public final void
identPrimaryBase()

public final void
inClassDeclaration()

public final void
inCollectionDeclaration()

public final void
inCollectionElementsDeclaration()

public final void
inList()

public final void
insertablePropertySpec()

public final void
insertStatement()

public final void
intoClause()

public boolean

Returns:

true if this is a filter query, false if not.
isFilter()

Returns true if this is a filter query, false if not.

public final void
joinPath()

public final void
jpaFunctionSyntax()

public final void
likeEscape()

public final void
logicalAndExpression()

public final void
logicalExpression()

public final void
logicalOrExpression()

public void
matchOptionalFrom()

Manages the case of an optional FROM allowing the path to start with the "from" keyword

public final void
memberOfPath()

private static final long[]
mk_tokenSet_0()

private static final long[]
mk_tokenSet_1()

private static final long[]
mk_tokenSet_10()

private static final long[]
mk_tokenSet_11()

private static final long[]
mk_tokenSet_12()

private static final long[]
mk_tokenSet_13()

private static final long[]
mk_tokenSet_14()

private static final long[]
mk_tokenSet_15()

private static final long[]
mk_tokenSet_16()

private static final long[]
mk_tokenSet_17()

private static final long[]
mk_tokenSet_18()

private static final long[]
mk_tokenSet_19()

private static final long[]
mk_tokenSet_2()

private static final long[]
mk_tokenSet_20()

private static final long[]
mk_tokenSet_21()

private static final long[]
mk_tokenSet_22()

private static final long[]
mk_tokenSet_23()

private static final long[]
mk_tokenSet_24()

private static final long[]
mk_tokenSet_25()

private static final long[]
mk_tokenSet_26()

private static final long[]
mk_tokenSet_27()

private static final long[]
mk_tokenSet_28()

private static final long[]
mk_tokenSet_29()

private static final long[]
mk_tokenSet_3()

private static final long[]
mk_tokenSet_30()

private static final long[]
mk_tokenSet_31()

private static final long[]
mk_tokenSet_32()

private static final long[]
mk_tokenSet_33()

private static final long[]
mk_tokenSet_34()

private static final long[]
mk_tokenSet_35()

private static final long[]
mk_tokenSet_36()

private static final long[]
mk_tokenSet_37()

private static final long[]
mk_tokenSet_38()

private static final long[]
mk_tokenSet_39()

private static final long[]
mk_tokenSet_4()

private static final long[]
mk_tokenSet_40()

private static final long[]
mk_tokenSet_41()

private static final long[]
mk_tokenSet_42()

private static final long[]
mk_tokenSet_43()

private static final long[]
mk_tokenSet_44()

private static final long[]
mk_tokenSet_45()

private static final long[]
mk_tokenSet_46()

private static final long[]
mk_tokenSet_47()

private static final long[]
mk_tokenSet_48()

private static final long[]
mk_tokenSet_5()

private static final long[]
mk_tokenSet_6()

private static final long[]
mk_tokenSet_7()

private static final long[]
mk_tokenSet_8()

private static final long[]
mk_tokenSet_9()

public final void
multiplyExpression()

public final void
negatedExpression()

public AST
negateNode(AST
The expression to negate.
x)

Returns the negated equivalent of the expression.

public final void
newExpression()

public final void
newValue()

public final void
nullOrdering()

public final void
nullPrecedence()

public final void
optionalFromTokenFromClause()

public final void
optionalVersioned()

public final void
orderByClause()

public final void
orderElement()

public final void
parameter()

public final void
path()

public final void
primaryExpression()

public AST
processEqualityExpression(AST
The comparison operator to clean up.
x)

Returns the 'cleaned up' version of a comparison operator sub-tree.

public void
processMemberOf(Token n, AST p, ASTPair currentAST)

public final void
propertyFetch()

public final void
quantifiedExpression()

public final void
queryRule()

protected void
registerTreat(AST pathToTreat, AST treatAs)

public final void
relationalExpression()

protected String
retrieveLookAheadText(int lookAheadPosition)

public final void
searchedCaseStatement()

public final void
searchedCaseWhenClause()

public final void
selectClause()

public final void
selectedPropertiesList()

public final void
selectFrom()

public final void
selectObject()

public final void
selectStatement()

public final void
setClause()

public void
setFilter(boolean
True for a filter query, false for a normal query.
f)

Sets the filter flag.

public final void
simpleCaseStatement()

public final void
simpleCaseWhenClause()

public final void
stateField()

public final void
statement()

public final void
subQuery()

public final void
unaryExpression()

protected String
unquote(String text)

public final void
updateStatement()

protected boolean
validateLookAheadText(int lookAheadPosition, String text)

protected boolean
validateSoftKeyword(String text)

public final void
vectorExpr()

public void
weakKeywords()

public final void
whereClause()

public final void
withClause()

Inherited from antlr.LLkParser:
consumeLALTtraceIntraceOut