org.hibernate.hql.internal.ast

Class HqlParser

java.lang.Object

antlr.Parser

antlr.LLkParser

org.hibernate.hql.internal.antlr.HqlBaseParser

org.hibernate.hql.internal.ast.HqlParser

All Implemented Interfaces:

HqlTokenTypes

public final class HqlParser
extends HqlBaseParser

Implements the semantic action methods defined in the HQL base parser to keep the grammar source file a little cleaner. Extends the parser class generated by ANTLR.

Author:

Joshua Davis (pgmjsd@sourceforge.net)

Field Summary

Fields inherited from class org.hibernate.hql.internal.antlr.HqlBaseParser

_tokenNames, _tokenSet_0, _tokenSet_1, _tokenSet_10, _tokenSet_11, _tokenSet_12, _tokenSet_13, _tokenSet_14, _tokenSet_15, _tokenSet_16, _tokenSet_17, _tokenSet_18, _tokenSet_19, _tokenSet_2, _tokenSet_20, _tokenSet_21, _tokenSet_22, _tokenSet_23, _tokenSet_24, _tokenSet_25, _tokenSet_26, _tokenSet_27, _tokenSet_28, _tokenSet_29, _tokenSet_3, _tokenSet_30, _tokenSet_31, _tokenSet_32, _tokenSet_33, _tokenSet_34, _tokenSet_35, _tokenSet_36, _tokenSet_37, _tokenSet_38, _tokenSet_39, _tokenSet_4, _tokenSet_40, _tokenSet_41, _tokenSet_42, _tokenSet_43, _tokenSet_44, _tokenSet_45, _tokenSet_5, _tokenSet_6, _tokenSet_7, _tokenSet_8, _tokenSet_9

Fields inherited from class antlr.Parser

astFactory, inputState, returnAST, tokenNames, tokenTypeToASTClassMap

Fields inherited from interface org.hibernate.hql.internal.antlr.HqlTokenTypes

AGGREGATE, ALIAS, ALL, AND, ANY, AS, ASCENDING, AVG, BETWEEN, BOTH, CASE, CASE2, CAST, CLASS, CLOSE, CLOSE_BRACKET, COLON, COMMA, CONCAT, CONSTANT, CONSTRUCTOR, COUNT, DELETE, DESCENDING, DISTINCT, DIV, DOT, ELEMENTS, ELSE, EMPTY, END, ENTRY, EOF, EQ, ESCAPE, ESCqs, EXISTS, EXPONENT, EXPR_LIST, FALSE, FETCH, FILTER_ENTITY, FIRST, FLOAT_SUFFIX, FROM, FULL, GE, GROUP, GT, HAVING, HEX_DIGIT, ID_LETTER, ID_START_LETTER, IDENT, IN, IN_LIST, INDEX_OP, INDICES, INNER, INSERT, INTO, IS, IS_NOT_NULL, IS_NULL, JAVA_CONSTANT, JOIN, KEY, LAST, LE, LEADING, LEFT, LIKE, LITERAL_ascending, LITERAL_by, LITERAL_descending, LT, MAX, MEMBER, METHOD_CALL, MIN, MINUS, MOD, NE, NEW, NOT, NOT_BETWEEN, NOT_IN, NOT_LIKE, NULL, NULL_TREE_LOOKAHEAD, NULLS, NUM_BIG_DECIMAL, NUM_BIG_INTEGER, NUM_DOUBLE, NUM_FLOAT, NUM_INT, NUM_LONG, OBJECT, OF, ON, OPEN, OPEN_BRACKET, OR, ORDER, ORDER_ELEMENT, OUTER, PARAM, PLUS, PROPERTIES, QUERY, QUOTED_STRING, RANGE, RIGHT, ROW_STAR, SELECT, SELECT_FROM, SET, SOME, SQL_NE, STAR, SUM, THEN, TRAILING, TRUE, UNARY_MINUS, UNARY_PLUS, UPDATE, VALUE, VECTOR_EXPR, VERSIONED, WEIRD_IDENT, WHEN, WHERE, WITH, WS

Method Summary

Modifier and Type	Method and Description
void	expectNamedParameterName() Called after we have recognized ':'.
void	firstPathTokenWeakKeywords()
static HqlParser	getInstance(String hql) Get a HqlParser instance for the given HQL string.
ParseErrorHandler	getParseErrorHandler()
Map<String,Set<String>>	getTreatMap()
void	handleDotIdent() This method looks ahead and converts .
antlr.collections.AST	handleIdentifierError(antlr.Token token, antlr.RecognitionException ex) Overrides the base behavior to retry keywords as identifiers.
void	handlePrimaryExpressionDotIdent()
void	matchOptionalFrom() Manages the case of an optional FROM allowing the path to start with the "from" keyword
antlr.collections.AST	negateNode(antlr.collections.AST x) Returns an equivalent tree for (NOT (a relop b) ), for example:
static void	panic()
antlr.collections.AST	processEqualityExpression(antlr.collections.AST x) Post process equality expressions, clean up the subtree.
void	processMemberOf(antlr.Token n, antlr.collections.AST p, antlr.ASTPair currentAST)
protected void	registerTreat(antlr.collections.AST pathToTreat, antlr.collections.AST treatAs)
void	reportError(antlr.RecognitionException e)
void	reportError(String s)
void	reportWarning(String s)
void	showAst(antlr.collections.AST ast, PrintStream out)
void	traceIn(String ruleName)
void	traceOut(String ruleName)
void	weakKeywords()

Methods inherited from class org.hibernate.hql.internal.antlr.HqlBaseParser

additiveExpression, aggregate, alias, aliasedExpression, asAlias, ascendingOrDescending, assignment, atom, betweenList, buildTokenTypeASTClassMap, caseExpression, castedIdentPrimaryBase, castedJoinPath, castFunction, castTargetType, collectionExpr, compoundExpr, concatenation, constant, deleteStatement, elseClause, equalityExpression, expression, expressionOrVector, exprList, fromClassOrOuterQueryPath, fromClause, fromJoin, fromRange, groupByClause, havingClause, identifier, identPrimary, identPrimaryBase, inClassDeclaration, inCollectionDeclaration, inCollectionElementsDeclaration, inList, insertablePropertySpec, insertStatement, intoClause, isFilter, joinPath, jpaFunctionSyntax, likeEscape, logicalAndExpression, logicalExpression, logicalOrExpression, memberOfPath, multiplyExpression, negatedExpression, newExpression, newValue, nullOrdering, nullPrecedence, optionalFromTokenFromClause, optionalVersioned, orderByClause, orderElement, parameter, path, primaryExpression, propertyFetch, quantifiedExpression, queryRule, relationalExpression, retrieveLookAheadText, searchedCaseStatement, searchedCaseWhenClause, selectClause, selectedPropertiesList, selectFrom, selectObject, selectStatement, setClause, setFilter, simpleCaseStatement, simpleCaseWhenClause, stateField, statement, subQuery, unaryExpression, unquote, updateStatement, validateLookAheadText, validateSoftKeyword, vectorExpr, whereClause, withClause

Methods inherited from class antlr.LLkParser

consume, LA, LT

Methods inherited from class antlr.Parser

addMessageListener, addParserListener, addParserMatchListener, addParserTokenListener, addSemanticPredicateListener, addSyntacticPredicateListener, addTraceListener, consumeUntil, consumeUntil, defaultDebuggingSetup, getAST, getASTFactory, getFilename, getInputState, getTokenName, getTokenNames, getTokenTypeToASTClassMap, isDebugMode, mark, match, match, matchNot, recover, removeMessageListener, removeParserListener, removeParserMatchListener, removeParserTokenListener, removeSemanticPredicateListener, removeSyntacticPredicateListener, removeTraceListener, rewind, setASTFactory, setASTNodeClass, setASTNodeType, setDebugMode, setFilename, setIgnoreInvalidDebugCalls, setInputState, setTokenBuffer, traceIndent

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static HqlParser getInstance(String hql)

Get a HqlParser instance for the given HQL string.

Parameters:

hql - The HQL query string

Returns:

The parser.

traceIn

public void traceIn(String ruleName)

Overrides:

traceIn in class antlr.LLkParser

traceOut

public void traceOut(String ruleName)

Overrides:

traceOut in class antlr.LLkParser

reportError

public void reportError(antlr.RecognitionException e)

Overrides:

reportError in class antlr.Parser

reportError

public void reportError(String s)

Overrides:

reportError in class antlr.Parser

reportWarning

public void reportWarning(String s)

Overrides:

reportWarning in class antlr.Parser

getParseErrorHandler

public ParseErrorHandler getParseErrorHandler()

handleIdentifierError

public antlr.collections.AST handleIdentifierError(antlr.Token token,
                                                   antlr.RecognitionException ex)
                                            throws antlr.RecognitionException,
                                                   antlr.TokenStreamException

Overrides the base behavior to retry keywords as identifiers.

Overrides:

handleIdentifierError in class HqlBaseParser

Parameters:

token - The token.

ex - The recognition exception.

Returns:

AST - The new AST.

Throws:

antlr.RecognitionException - if the substitution was not possible.

antlr.TokenStreamException - if the substitution was not possible.

negateNode

public antlr.collections.AST negateNode(antlr.collections.AST x)

Returns an equivalent tree for (NOT (a relop b) ), for example:

 (NOT (GT a b) ) => (LE a b)
 

Overrides:

negateNode in class HqlBaseParser

Parameters:

x - The sub tree to transform, the parent is assumed to be NOT.

Returns:

AST - The equivalent sub-tree.

processEqualityExpression

public antlr.collections.AST processEqualityExpression(antlr.collections.AST x)

Post process equality expressions, clean up the subtree.

Overrides:

processEqualityExpression in class HqlBaseParser

Parameters:

x - The equality expression.

Returns:

AST - The clean sub-tree.

showAst

public void showAst(antlr.collections.AST ast,
                    PrintStream out)

matchOptionalFrom

public void matchOptionalFrom()
                       throws antlr.RecognitionException,
                              antlr.TokenStreamException

Description copied from class: HqlBaseParser

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

Overrides:

matchOptionalFrom in class HqlBaseParser

Throws:

antlr.RecognitionException

antlr.TokenStreamException

firstPathTokenWeakKeywords

public void firstPathTokenWeakKeywords()
                                throws antlr.TokenStreamException

Overrides:

firstPathTokenWeakKeywords in class HqlBaseParser

Throws:

antlr.TokenStreamException

handlePrimaryExpressionDotIdent

public void handlePrimaryExpressionDotIdent()
                                     throws antlr.TokenStreamException

Overrides:

handlePrimaryExpressionDotIdent in class HqlBaseParser

Throws:

antlr.TokenStreamException

weakKeywords

public void weakKeywords()
                  throws antlr.TokenStreamException

Overrides:

weakKeywords in class HqlBaseParser

Throws:

antlr.TokenStreamException

expectNamedParameterName

public void expectNamedParameterName()
                              throws antlr.TokenStreamException

Description copied from class: HqlBaseParser

Called after we have recognized ':'. The expectation is to handle converting any non-IDENT token where possibleID == true into an IDENT

Overrides:

expectNamedParameterName in class HqlBaseParser

Throws:

antlr.TokenStreamException

handleDotIdent

public void handleDotIdent()
                    throws antlr.TokenStreamException

Description copied from class: HqlBaseParser

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

Overrides:

handleDotIdent in class HqlBaseParser

Throws:

antlr.TokenStreamException

processMemberOf

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

Overrides:

processMemberOf in class HqlBaseParser

registerTreat

protected void registerTreat(antlr.collections.AST pathToTreat,
                             antlr.collections.AST treatAs)

Overrides:

registerTreat in class HqlBaseParser

getTreatMap

public Map<String,Set<String>> getTreatMap()

panic

public static void panic()