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

public Class HqlBaseParser

extends LLkParser
implements HqlTokenTypes
Class Inheritance
All Implemented Interfaces
org.hibernate.hql.antlr.HqlTokenTypes
Known Direct Subclasses
org.hibernate.hql.ast.HqlParser
Imports
org.hibernate.hql.ast.*, org.hibernate.hql.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[]
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
public static final BitSet
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
protected
HqlBaseParser(TokenStream lexer, int k)

public
public

Method Summary

Modifier and TypeMethod and Description
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
atom()

public final void
protected void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
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 overriden in the sub class in order to provide the 'keyword as identifier' hack.

public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
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
public final void
public final void
public final void
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
private static final long[]
public final void
public final void
public AST
negateNode(AST
The expression to negate.
x
)

Returns the negated equivalent of the expression.

public final void
public final void
public final void
public final void
public final void
public final void
public final void
path()

public final void
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
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public final void
public void
setFilter(boolean
True for a filter query, false for a normal query.
f
)

Sets the filter flag.

public final void
public final void
public final void
public final void
public final void
public final void
public final void
public void
public final void
public final void
public final void
Inherited from antlr.LLkParser:
consumeLALTtraceIntraceOut

Field Detail

_tokenNamesback to summary
public static final String[] _tokenNames
_tokenSet_0back to summary
public static final BitSet _tokenSet_0
_tokenSet_1back to summary
public static final BitSet _tokenSet_1
_tokenSet_10back to summary
public static final BitSet _tokenSet_10
_tokenSet_11back to summary
public static final BitSet _tokenSet_11
_tokenSet_12back to summary
public static final BitSet _tokenSet_12
_tokenSet_13back to summary
public static final BitSet _tokenSet_13
_tokenSet_14back to summary
public static final BitSet _tokenSet_14
_tokenSet_15back to summary
public static final BitSet _tokenSet_15
_tokenSet_16back to summary
public static final BitSet _tokenSet_16
_tokenSet_17back to summary
public static final BitSet _tokenSet_17
_tokenSet_18back to summary
public static final BitSet _tokenSet_18
_tokenSet_19back to summary
public static final BitSet _tokenSet_19
_tokenSet_2back to summary
public static final BitSet _tokenSet_2
_tokenSet_20back to summary
public static final BitSet _tokenSet_20
_tokenSet_21back to summary
public static final BitSet _tokenSet_21
_tokenSet_22back to summary
public static final BitSet _tokenSet_22
_tokenSet_23back to summary
public static final BitSet _tokenSet_23
_tokenSet_24back to summary
public static final BitSet _tokenSet_24
_tokenSet_25back to summary
public static final BitSet _tokenSet_25
_tokenSet_26back to summary
public static final BitSet _tokenSet_26
_tokenSet_27back to summary
public static final BitSet _tokenSet_27
_tokenSet_28back to summary
public static final BitSet _tokenSet_28
_tokenSet_29back to summary
public static final BitSet _tokenSet_29
_tokenSet_3back to summary
public static final BitSet _tokenSet_3
_tokenSet_30back to summary
public static final BitSet _tokenSet_30
_tokenSet_31back to summary
public static final BitSet _tokenSet_31
_tokenSet_32back to summary
public static final BitSet _tokenSet_32
_tokenSet_33back to summary
public static final BitSet _tokenSet_33
_tokenSet_34back to summary
public static final BitSet _tokenSet_34
_tokenSet_35back to summary
public static final BitSet _tokenSet_35
_tokenSet_4back to summary
public static final BitSet _tokenSet_4
_tokenSet_5back to summary
public static final BitSet _tokenSet_5
_tokenSet_6back to summary
public static final BitSet _tokenSet_6
_tokenSet_7back to summary
public static final BitSet _tokenSet_7
_tokenSet_8back to summary
public static final BitSet _tokenSet_8
_tokenSet_9back to summary
public static final BitSet _tokenSet_9
filterback to summary
private boolean filter

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

Constructor Detail

HqlBaseParserback to summary
protected HqlBaseParser(TokenBuffer tokenBuf, int k)
HqlBaseParserback to summary
public HqlBaseParser(TokenBuffer tokenBuf)
HqlBaseParserback to summary
protected HqlBaseParser(TokenStream lexer, int k)
HqlBaseParserback to summary
public HqlBaseParser(TokenStream lexer)
HqlBaseParserback to summary
public HqlBaseParser(ParserSharedInputState state)

Method Detail

additiveExpressionback to summary
public final void additiveExpression() throws RecognitionException, TokenStreamException
aggregateback to summary
public final void aggregate() throws RecognitionException, TokenStreamException
aliasback to summary
public final void alias() throws RecognitionException, TokenStreamException
aliasedExpressionback to summary
public final void aliasedExpression() throws RecognitionException, TokenStreamException
altWhenClauseback to summary
public final void altWhenClause() throws RecognitionException, TokenStreamException
asAliasback to summary
public final void asAlias() throws RecognitionException, TokenStreamException
ascendingOrDescendingback to summary
public final void ascendingOrDescending() throws RecognitionException, TokenStreamException
assignmentback to summary
public final void assignment() throws RecognitionException, TokenStreamException
atomback to summary
public final void atom() throws RecognitionException, TokenStreamException
betweenListback to summary
public final void betweenList() throws RecognitionException, TokenStreamException
buildTokenTypeASTClassMapback to summary
protected void buildTokenTypeASTClassMap()
caseExpressionback to summary
public final void caseExpression() throws RecognitionException, TokenStreamException
collectionExprback to summary
public final void collectionExpr() throws RecognitionException, TokenStreamException
compoundExprback to summary
public final void compoundExpr() throws RecognitionException, TokenStreamException
concatenationback to summary
public final void concatenation() throws RecognitionException, TokenStreamException
constantback to summary
public final void constant() throws RecognitionException, TokenStreamException
deleteStatementback to summary
public final void deleteStatement() throws RecognitionException, TokenStreamException
elseClauseback to summary
public final void elseClause() throws RecognitionException, TokenStreamException
equalityExpressionback to summary
public final void equalityExpression() throws RecognitionException, TokenStreamException
expressionback to summary
public final void expression() throws RecognitionException, TokenStreamException
expressionOrVectorback to summary
public final void expressionOrVector() throws RecognitionException, TokenStreamException
exprListback to summary
public final void exprList() throws RecognitionException, TokenStreamException
fromClassOrOuterQueryPathback to summary
public final void fromClassOrOuterQueryPath() throws RecognitionException, TokenStreamException
fromClauseback to summary
public final void fromClause() throws RecognitionException, TokenStreamException
fromJoinback to summary
public final void fromJoin() throws RecognitionException, TokenStreamException
fromRangeback to summary
public final void fromRange() throws RecognitionException, TokenStreamException
groupByClauseback to summary
public final void groupByClause() throws RecognitionException, TokenStreamException
handleDotIdentback to summary
public void handleDotIdent() throws TokenStreamException

This method looks ahead and converts . into . IDENT when appropriate.

handleIdentifierErrorback to summary
public AST handleIdentifierError(Token token, RecognitionException ex) throws RecognitionException, TokenStreamException

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

Parameters
token:Token

The token to retry as an identifier.

ex:RecognitionException

The exception to throw if it cannot be retried as an identifier.

havingClauseback to summary
public final void havingClause() throws RecognitionException, TokenStreamException
identifierback to summary
public final void identifier() throws RecognitionException, TokenStreamException
identPrimaryback to summary
public final void identPrimary() throws RecognitionException, TokenStreamException
inClassDeclarationback to summary
public final void inClassDeclaration() throws RecognitionException, TokenStreamException
inCollectionDeclarationback to summary
public final void inCollectionDeclaration() throws RecognitionException, TokenStreamException
inCollectionElementsDeclarationback to summary
public final void inCollectionElementsDeclaration() throws RecognitionException, TokenStreamException
inListback to summary
public final void inList() throws RecognitionException, TokenStreamException
insertablePropertySpecback to summary
public final void insertablePropertySpec() throws RecognitionException, TokenStreamException
insertStatementback to summary
public final void insertStatement() throws RecognitionException, TokenStreamException
intoClauseback to summary
public final void intoClause() throws RecognitionException, TokenStreamException
isFilterback to summary
public boolean isFilter()

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

Returns:boolean

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

likeEscapeback to summary
public final void likeEscape() throws RecognitionException, TokenStreamException
logicalAndExpressionback to summary
public final void logicalAndExpression() throws RecognitionException, TokenStreamException
logicalExpressionback to summary
public final void logicalExpression() throws RecognitionException, TokenStreamException
logicalOrExpressionback to summary
public final void logicalOrExpression() throws RecognitionException, TokenStreamException
mk_tokenSet_0back to summary
private static final long[] mk_tokenSet_0()
mk_tokenSet_1back to summary
private static final long[] mk_tokenSet_1()
mk_tokenSet_10back to summary
private static final long[] mk_tokenSet_10()
mk_tokenSet_11back to summary
private static final long[] mk_tokenSet_11()
mk_tokenSet_12back to summary
private static final long[] mk_tokenSet_12()
mk_tokenSet_13back to summary
private static final long[] mk_tokenSet_13()
mk_tokenSet_14back to summary
private static final long[] mk_tokenSet_14()
mk_tokenSet_15back to summary
private static final long[] mk_tokenSet_15()
mk_tokenSet_16back to summary
private static final long[] mk_tokenSet_16()
mk_tokenSet_17back to summary
private static final long[] mk_tokenSet_17()
mk_tokenSet_18back to summary
private static final long[] mk_tokenSet_18()
mk_tokenSet_19back to summary
private static final long[] mk_tokenSet_19()
mk_tokenSet_2back to summary
private static final long[] mk_tokenSet_2()
mk_tokenSet_20back to summary
private static final long[] mk_tokenSet_20()
mk_tokenSet_21back to summary
private static final long[] mk_tokenSet_21()
mk_tokenSet_22back to summary
private static final long[] mk_tokenSet_22()
mk_tokenSet_23back to summary
private static final long[] mk_tokenSet_23()
mk_tokenSet_24back to summary
private static final long[] mk_tokenSet_24()
mk_tokenSet_25back to summary
private static final long[] mk_tokenSet_25()
mk_tokenSet_26back to summary
private static final long[] mk_tokenSet_26()
mk_tokenSet_27back to summary
private static final long[] mk_tokenSet_27()
mk_tokenSet_28back to summary
private static final long[] mk_tokenSet_28()
mk_tokenSet_29back to summary
private static final long[] mk_tokenSet_29()
mk_tokenSet_3back to summary
private static final long[] mk_tokenSet_3()
mk_tokenSet_30back to summary
private static final long[] mk_tokenSet_30()
mk_tokenSet_31back to summary
private static final long[] mk_tokenSet_31()
mk_tokenSet_32back to summary
private static final long[] mk_tokenSet_32()
mk_tokenSet_33back to summary
private static final long[] mk_tokenSet_33()
mk_tokenSet_34back to summary
private static final long[] mk_tokenSet_34()
mk_tokenSet_35back to summary
private static final long[] mk_tokenSet_35()
mk_tokenSet_4back to summary
private static final long[] mk_tokenSet_4()
mk_tokenSet_5back to summary
private static final long[] mk_tokenSet_5()
mk_tokenSet_6back to summary
private static final long[] mk_tokenSet_6()
mk_tokenSet_7back to summary
private static final long[] mk_tokenSet_7()
mk_tokenSet_8back to summary
private static final long[] mk_tokenSet_8()
mk_tokenSet_9back to summary
private static final long[] mk_tokenSet_9()
multiplyExpressionback to summary
public final void multiplyExpression() throws RecognitionException, TokenStreamException
negatedExpressionback to summary
public final void negatedExpression() throws RecognitionException, TokenStreamException
negateNodeback to summary
public AST negateNode(AST x)

Returns the negated equivalent of the expression.

Parameters
x:AST

The expression to negate.

newExpressionback to summary
public final void newExpression() throws RecognitionException, TokenStreamException
newValueback to summary
public final void newValue() throws RecognitionException, TokenStreamException
optionalFromTokenFromClauseback to summary
public final void optionalFromTokenFromClause() throws RecognitionException, TokenStreamException
orderByClauseback to summary
public final void orderByClause() throws RecognitionException, TokenStreamException
orderElementback to summary
public final void orderElement() throws RecognitionException, TokenStreamException
parameterback to summary
public final void parameter() throws RecognitionException, TokenStreamException
pathback to summary
public final void path() throws RecognitionException, TokenStreamException
primaryExpressionback to summary
public final void primaryExpression() throws RecognitionException, TokenStreamException
processEqualityExpressionback to summary
public AST processEqualityExpression(AST x) throws RecognitionException

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

Parameters
x:AST

The comparison operator to clean up.

processMemberOfback to summary
public void processMemberOf(Token n, AST p, ASTPair currentAST)
propertyFetchback to summary
public final void propertyFetch() throws RecognitionException, TokenStreamException
quantifiedExpressionback to summary
public final void quantifiedExpression() throws RecognitionException, TokenStreamException
queryRuleback to summary
public final void queryRule() throws RecognitionException, TokenStreamException
relationalExpressionback to summary
public final void relationalExpression() throws RecognitionException, TokenStreamException
selectClauseback to summary
public final void selectClause() throws RecognitionException, TokenStreamException
selectedPropertiesListback to summary
public final void selectedPropertiesList() throws RecognitionException, TokenStreamException
selectFromback to summary
public final void selectFrom() throws RecognitionException, TokenStreamException
selectObjectback to summary
public final void selectObject() throws RecognitionException, TokenStreamException
selectStatementback to summary
public final void selectStatement() throws RecognitionException, TokenStreamException
setClauseback to summary
public final void setClause() throws RecognitionException, TokenStreamException
setFilterback to summary
public void setFilter(boolean f)

Sets the filter flag.

Parameters
f:boolean

True for a filter query, false for a normal query.

stateFieldback to summary
public final void stateField() throws RecognitionException, TokenStreamException
statementback to summary
public final void statement() throws RecognitionException, TokenStreamException
subQueryback to summary
public final void subQuery() throws RecognitionException, TokenStreamException
unaryExpressionback to summary
public final void unaryExpression() throws RecognitionException, TokenStreamException
unionback to summary
public final void union() throws RecognitionException, TokenStreamException
updateStatementback to summary
public final void updateStatement() throws RecognitionException, TokenStreamException
vectorExprback to summary
public final void vectorExpr() throws RecognitionException, TokenStreamException
weakKeywordsback to summary
public void weakKeywords() throws TokenStreamException
whenClauseback to summary
public final void whenClause() throws RecognitionException, TokenStreamException
whereClauseback to summary
public final void whereClause() throws RecognitionException, TokenStreamException
withClauseback to summary
public final void withClause() throws RecognitionException, TokenStreamException