程序包 org.hibernate.hql.internal.ast

类 HqlSqlWalker

java.lang.Object

antlr.TreeParser

org.hibernate.hql.internal.antlr.HqlSqlBaseWalker

org.hibernate.hql.internal.ast.HqlSqlWalker

所有已实现的接口:

ParameterBinder.NamedParameterSource, HqlSqlTokenTypes, ErrorReporter

public class HqlSqlWalker
extends HqlSqlBaseWalker
implements ErrorReporter, ParameterBinder.NamedParameterSource

Implements methods used by the HQL->SQL tree transform grammar (a.k.a. the second phase).

• Isolates the Hibernate API-specific code from the ANTLR generated code.
• Handles the SQL fragments generated by the persisters in order to create the SELECT and FROM clauses, taking into account the joins and projections that are implied by the mappings (persister/queryable).
• Uses SqlASTFactory to create customized AST nodes.

另请参阅:

SqlASTFactory

字段概要

从类继承的字段 org.hibernate.hql.internal.antlr.HqlSqlBaseWalker

_tokenNames, _tokenSet_0, _tokenSet_1

从类继承的字段 antlr.TreeParser

_retTree, astFactory, ASTNULL, inputState, returnAST, tokenNames

从接口继承的字段 org.hibernate.hql.internal.antlr.HqlSqlTokenTypes

AGGREGATE, ALIAS, ALIAS_REF, ALL, AND, ANY, AS, ASCENDING, AVG, BETWEEN, BOGUS, BOTH, CASE, CASE2, CAST, CLASS, CLOSE, CLOSE_BRACKET, COLON, COMMA, CONCAT, CONSTANT, CONSTRUCTOR, COUNT, DELETE, DESCENDING, DISTINCT, DIV, DOT, ELEMENTS, ELSE, EMPTY, END, ENTITY_JOIN, ENTRY, EOF, EQ, ESCAPE, ESCqs, EXISTS, EXPONENT, EXPR_LIST, FALSE, FETCH, FILTER_ENTITY, FILTERS, FIRST, FLOAT_SUFFIX, FROM, FROM_FRAGMENT, FULL, GE, GROUP, GT, HAVING, HEX_DIGIT, ID_LETTER, ID_START_LETTER, IDENT, IMPLIED_FROM, IN, IN_LIST, INDEX_OP, INDICES, INNER, INSERT, INTO, IS, IS_NOT_NULL, IS_NULL, JAVA_CONSTANT, JOIN, JOIN_FRAGMENT, KEY, LAST, LE, LEADING, LEFT, LEFT_OUTER, LIKE, LITERAL_ascending, LITERAL_by, LITERAL_descending, LT, MAX, MEMBER, METHOD_CALL, METHOD_NAME, MIN, MINUS, MOD, NAMED_PARAM, 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, PROPERTY_REF, QUERY, QUOTED_STRING, RANGE, RESULT_VARIABLE_REF, RIGHT, RIGHT_OUTER, ROW_STAR, SELECT, SELECT_CLAUSE, SELECT_COLUMNS, SELECT_EXPR, SELECT_FROM, SET, SOME, SQL_NE, SQL_TOKEN, STAR, SUM, THEN, THETA_JOINS, TRAILING, TRUE, UNARY_MINUS, UNARY_PLUS, UPDATE, VALUE, VECTOR_EXPR, VERSIONED, WEIRD_IDENT, WHEN, WHERE, WITH, WS

构造器概要

构造器

构造器	说明
HqlSqlWalker(QueryTranslatorImpl qti, SessionFactoryImplementor sfi, HqlParser parser, Map tokenReplacements, String collectionRole)	Create a new tree transformer.

方法概要

修饰符和类型	方法	说明
void	addQuerySpaces(Serializable[] spaces)
protected void	beforeSelectClause()
protected antlr.collections.AST	createFromElement(String path, antlr.collections.AST alias, antlr.collections.AST propertyFetch)
protected antlr.collections.AST	createFromFilterElement(antlr.collections.AST filterEntity, antlr.collections.AST alias)
protected void	createFromJoinElement(antlr.collections.AST path, antlr.collections.AST alias, int joinType, antlr.collections.AST fetchNode, antlr.collections.AST propertyFetch, antlr.collections.AST with)
protected antlr.collections.AST	createIntoClause(String path, antlr.collections.AST propertySpec)
protected void	evaluateAssignment(antlr.collections.AST eq)
protected void	finishFromClause(antlr.collections.AST fromClause)
protected antlr.collections.AST	generateNamedParameter(antlr.collections.AST delimiterNode, antlr.collections.AST nameNode)
protected antlr.collections.AST	generatePositionalParameter(antlr.collections.AST delimiterNode, antlr.collections.AST numberNode)
AliasGenerator	getAliasGenerator()
ArrayList	getAssignmentSpecifications()
ASTPrinter	getASTPrinter()
String	getCollectionFilterRole()
FromClause	getCurrentFromClause()
Dialect	getDialect()
Map	getEnabledFilters()
FromClause	getFinalFromClause()
JoinType	getImpliedJoinType()
LiteralProcessor	getLiteralProcessor()
int[]	getNamedParameterLocations(String name)	Returns the locations of all occurrences of the named parameter.
int	getNumberOfParametersInSetClause()
ArrayList<ParameterSpecification>	getParameterSpecs()
ParseErrorHandler	getParseErrorHandler()
Set<Serializable>	getQuerySpaces()	Returns the set of unique query spaces (a.k.a.
String[]	getReturnAliases()
Type[]	getReturnTypes()
SelectClause	getSelectClause()
SessionFactoryHelper	getSessionFactoryHelper()
Map	getTokenReplacements()
Set<String>	getTreatAsDeclarationsByPath(String path)
protected void	handleResultVariableRef(antlr.collections.AST resultVariableRef)
boolean	isFilter()
protected boolean	isGroupExpressionResultVariableRef(antlr.collections.AST groupExpressionNode)
boolean	isInEntityGraph()
protected boolean	isNonQualifiedPropertyRef(antlr.collections.AST ident)
protected boolean	isOrderExpressionResultVariableRef(antlr.collections.AST orderExpressionNode)
boolean	isShallowQuery()
protected void	lookupAlias(antlr.collections.AST aliasRef)
protected antlr.collections.AST	lookupNonQualifiedProperty(antlr.collections.AST property)
protected antlr.collections.AST	lookupProperty(antlr.collections.AST dot, boolean root, boolean inSelect)
static void	panic()
protected void	postProcessDelete(antlr.collections.AST delete)
protected void	postProcessDML(RestrictableStatement statement)
protected void	postProcessInsert(antlr.collections.AST insert)
protected void	postProcessUpdate(antlr.collections.AST update)
protected void	prepareArithmeticOperator(antlr.collections.AST operator)
protected void	prepareFromClauseInputTree(antlr.collections.AST fromClauseInput)	Pre-process the from clause input tree.
protected void	prepareLogicOperator(antlr.collections.AST operator)
protected void	prepareVersioned(antlr.collections.AST updateNode, antlr.collections.AST versioned)
protected void	processAggregation(antlr.collections.AST node, boolean inSelect)
protected void	processBoolean(antlr.collections.AST constant)
protected void	processCastFunction(antlr.collections.AST castFunctionCall, boolean inSelect)
protected void	processConstant(antlr.collections.AST constant)
protected void	processConstructor(antlr.collections.AST constructor)
protected void	processFunction(antlr.collections.AST functionCall, boolean inSelect)
protected void	processIndex(antlr.collections.AST indexOp)
protected void	processNumericLiteral(antlr.collections.AST literal)
protected void	processQuery(antlr.collections.AST select, antlr.collections.AST query)
protected void	pushFromClause(antlr.collections.AST fromNode, antlr.collections.AST inputFromNode)	Sets the current 'FROM' context.
void	reportError(antlr.RecognitionException e)
void	reportError(String s)
void	reportWarning(String s)
protected void	resolve(antlr.collections.AST node)
protected void	resolve(antlr.collections.AST node, antlr.collections.AST predicateNode)
protected void	resolveSelectExpression(antlr.collections.AST node)
protected void	setAlias(antlr.collections.AST selectExpr, antlr.collections.AST ident)
protected void	setImpliedJoinType(int joinType)
void	traceIn(String ruleName, antlr.collections.AST tree)
void	traceOut(String ruleName, antlr.collections.AST tree)
protected void	validateMapPropertyExpression(antlr.collections.AST node)

从类继承的方法 org.hibernate.hql.internal.antlr.HqlSqlBaseWalker

addrExpr, addrExprLhs, aggregateExpr, aliasedSelectExpr, aliasRef, arithmeticExpr, assignment, caseExpr, collectionFunction, collectionFunctionOrSubselect, comparisonExpr, constant, constructor, count, deleteStatement, elseClause, expr, expressionOrSubQuery, exprOrSubquery, fromClause, fromElement, fromElementList, functionCall, getCurrentClauseType, getCurrentStatementType, getCurrentTopLevelClauseType, getStatementType, groupClause, identifier, inRhs, insertablePropertySpec, insertStatement, intoClause, isComparativeExpressionClause, isInCase, isInCount, isInCountDistinct, isInFrom, isInFunctionCall, isInSelect, isSelectStatement, isSubQuery, joinElement, joinType, literal, logicalExpr, mapComponentReference, mapPropertyExpression, newValue, nullOrdering, nullPrecedence, numericInteger, orderClause, orderExpr, orderExprs, parameter, path, pathAsIdent, processMapComponentReference, propertyName, propertyRef, propertyRefLhs, query, resultVariableRef, searchedCaseExpression, searchedCaseWhenClause, selectClause, selectExpr, selectExprList, selectStatement, setClause, simpleCaseExpression, simpleCaseWhenClause, statement, updateStatement, whereClause, withClause

从类继承的方法 antlr.TreeParser

getAST, getASTFactory, getTokenName, getTokenNames, match, match, matchNot, setASTFactory, setASTNodeClass, setASTNodeType, traceIndent

从类继承的方法 java.lang.Object

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

构造器详细资料

HqlSqlWalker

public HqlSqlWalker(QueryTranslatorImpl qti,
                    SessionFactoryImplementor sfi,
                    HqlParser parser,
                    Map tokenReplacements,
                    String collectionRole)

Create a new tree transformer.

参数:

qti - Back pointer to the query translator implementation that is using this tree transform.

sfi - The session factory implementor where the Hibernate mappings can be found.

parser - A reference to the phase-1 parser

tokenReplacements - Registers the token replacement map with the walker. This map will be used to substitute function names and constants.

collectionRole - The collection role name of the collection used as the basis for the filter, NULL if this is not a collection filter compilation.

方法详细资料

traceIn

public void traceIn(String ruleName,
                    antlr.collections.AST tree)

覆盖:

traceIn 在类中 antlr.TreeParser

traceOut

public void traceOut(String ruleName,
                     antlr.collections.AST tree)

覆盖:

traceOut 在类中 antlr.TreeParser

prepareFromClauseInputTree

protected void prepareFromClauseInputTree(antlr.collections.AST fromClauseInput)

从类复制的说明: HqlSqlBaseWalker

Pre-process the from clause input tree.

覆盖:

prepareFromClauseInputTree 在类中 HqlSqlBaseWalker

isFilter

public boolean isFilter()

getCollectionFilterRole

public String getCollectionFilterRole()

isInEntityGraph

public boolean isInEntityGraph()

getSessionFactoryHelper

public SessionFactoryHelper getSessionFactoryHelper()

getTokenReplacements

public Map getTokenReplacements()

getAliasGenerator

public AliasGenerator getAliasGenerator()

getCurrentFromClause

public FromClause getCurrentFromClause()

getParseErrorHandler

public ParseErrorHandler getParseErrorHandler()

reportError

public void reportError(antlr.RecognitionException e)

指定者:

reportError 在接口中 ErrorReporter

覆盖:

reportError 在类中 antlr.TreeParser

reportError

public void reportError(String s)

指定者:

reportError 在接口中 ErrorReporter

覆盖:

reportError 在类中 antlr.TreeParser

reportWarning

public void reportWarning(String s)

指定者:

reportWarning 在接口中 ErrorReporter

覆盖:

reportWarning 在类中 antlr.TreeParser

getQuerySpaces

public Set<Serializable> getQuerySpaces()

Returns the set of unique query spaces (a.k.a. table names) that occurred in the query.

返回:

A set of table names (Strings).

createFromElement

protected antlr.collections.AST createFromElement(String path,
                                                  antlr.collections.AST alias,
                                                  antlr.collections.AST propertyFetch)
                                           throws antlr.SemanticException

覆盖:

createFromElement 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

createFromFilterElement

protected antlr.collections.AST createFromFilterElement(antlr.collections.AST filterEntity,
                                                        antlr.collections.AST alias)
                                                 throws antlr.SemanticException

覆盖:

createFromFilterElement 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

createFromJoinElement

protected void createFromJoinElement(antlr.collections.AST path,
                                     antlr.collections.AST alias,
                                     int joinType,
                                     antlr.collections.AST fetchNode,
                                     antlr.collections.AST propertyFetch,
                                     antlr.collections.AST with)
                              throws antlr.SemanticException

覆盖:

createFromJoinElement 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

finishFromClause

protected void finishFromClause(antlr.collections.AST fromClause)
                         throws antlr.SemanticException

覆盖:

finishFromClause 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

pushFromClause

protected void pushFromClause(antlr.collections.AST fromNode,
                              antlr.collections.AST inputFromNode)

Sets the current 'FROM' context.

覆盖:

pushFromClause 在类中 HqlSqlBaseWalker

参数:

fromNode - The new 'FROM' context.

inputFromNode - The from node from the input AST.

lookupAlias

protected void lookupAlias(antlr.collections.AST aliasRef)
                    throws antlr.SemanticException

覆盖:

lookupAlias 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

setImpliedJoinType

protected void setImpliedJoinType(int joinType)

覆盖:

setImpliedJoinType 在类中 HqlSqlBaseWalker

getImpliedJoinType

public JoinType getImpliedJoinType()

lookupProperty

protected antlr.collections.AST lookupProperty(antlr.collections.AST dot,
                                               boolean root,
                                               boolean inSelect)
                                        throws antlr.SemanticException

覆盖:

lookupProperty 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

isNonQualifiedPropertyRef

protected boolean isNonQualifiedPropertyRef(antlr.collections.AST ident)

覆盖:

isNonQualifiedPropertyRef 在类中 HqlSqlBaseWalker

lookupNonQualifiedProperty

protected antlr.collections.AST lookupNonQualifiedProperty(antlr.collections.AST property)
                                                    throws antlr.SemanticException

覆盖:

lookupNonQualifiedProperty 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

processQuery

protected void processQuery(antlr.collections.AST select,
                            antlr.collections.AST query)
                     throws antlr.SemanticException

覆盖:

processQuery 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

postProcessDML

protected void postProcessDML(RestrictableStatement statement)
                       throws antlr.SemanticException

抛出:

antlr.SemanticException

postProcessUpdate

protected void postProcessUpdate(antlr.collections.AST update)
                          throws antlr.SemanticException

覆盖:

postProcessUpdate 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

postProcessDelete

protected void postProcessDelete(antlr.collections.AST delete)
                          throws antlr.SemanticException

覆盖:

postProcessDelete 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

postProcessInsert

protected void postProcessInsert(antlr.collections.AST insert)
                          throws antlr.SemanticException,
                                 QueryException

覆盖:

postProcessInsert 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

QueryException

resolve

protected void resolve(antlr.collections.AST node)
                throws antlr.SemanticException

覆盖:

resolve 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

resolve

protected void resolve(antlr.collections.AST node,
                       antlr.collections.AST predicateNode)
                throws antlr.SemanticException

覆盖:

resolve 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

resolveSelectExpression

protected void resolveSelectExpression(antlr.collections.AST node)
                                throws antlr.SemanticException

覆盖:

resolveSelectExpression 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

beforeSelectClause

protected void beforeSelectClause()
                           throws antlr.SemanticException

覆盖:

beforeSelectClause 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

generatePositionalParameter

protected antlr.collections.AST generatePositionalParameter(antlr.collections.AST delimiterNode,
                                                            antlr.collections.AST numberNode)
                                                     throws antlr.SemanticException

覆盖:

generatePositionalParameter 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

generateNamedParameter

protected antlr.collections.AST generateNamedParameter(antlr.collections.AST delimiterNode,
                                                       antlr.collections.AST nameNode)
                                                throws antlr.SemanticException

覆盖:

generateNamedParameter 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

processConstant

protected void processConstant(antlr.collections.AST constant)
                        throws antlr.SemanticException

覆盖:

processConstant 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

processBoolean

protected void processBoolean(antlr.collections.AST constant)
                       throws antlr.SemanticException

覆盖:

processBoolean 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

processNumericLiteral

protected void processNumericLiteral(antlr.collections.AST literal)

覆盖:

processNumericLiteral 在类中 HqlSqlBaseWalker

processIndex

protected void processIndex(antlr.collections.AST indexOp)
                     throws antlr.SemanticException

覆盖:

processIndex 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

processFunction

protected void processFunction(antlr.collections.AST functionCall,
                               boolean inSelect)
                        throws antlr.SemanticException

覆盖:

processFunction 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

processCastFunction

protected void processCastFunction(antlr.collections.AST castFunctionCall,
                                   boolean inSelect)
                            throws antlr.SemanticException

覆盖:

processCastFunction 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

processAggregation

protected void processAggregation(antlr.collections.AST node,
                                  boolean inSelect)
                           throws antlr.SemanticException

覆盖:

processAggregation 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

processConstructor

protected void processConstructor(antlr.collections.AST constructor)
                           throws antlr.SemanticException

覆盖:

processConstructor 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

setAlias

protected void setAlias(antlr.collections.AST selectExpr,
                        antlr.collections.AST ident)

覆盖:

setAlias 在类中 HqlSqlBaseWalker

isOrderExpressionResultVariableRef

protected boolean isOrderExpressionResultVariableRef(antlr.collections.AST orderExpressionNode)
                                              throws antlr.SemanticException

覆盖:

isOrderExpressionResultVariableRef 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

isGroupExpressionResultVariableRef

protected boolean isGroupExpressionResultVariableRef(antlr.collections.AST groupExpressionNode)
                                              throws antlr.SemanticException

覆盖:

isGroupExpressionResultVariableRef 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

handleResultVariableRef

protected void handleResultVariableRef(antlr.collections.AST resultVariableRef)
                                throws antlr.SemanticException

覆盖:

handleResultVariableRef 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

getNamedParameterLocations

public int[] getNamedParameterLocations(String name)
                                 throws QueryException

Returns the locations of all occurrences of the named parameter.

指定者:

getNamedParameterLocations 在接口中 ParameterBinder.NamedParameterSource

参数:

name - The parameter name

返回:

The locations

抛出:

QueryException

addQuerySpaces

public void addQuerySpaces(Serializable[] spaces)

getReturnTypes

public Type[] getReturnTypes()

getReturnAliases

public String[] getReturnAliases()

getSelectClause

public SelectClause getSelectClause()

getFinalFromClause

public FromClause getFinalFromClause()

isShallowQuery

public boolean isShallowQuery()

getEnabledFilters

public Map getEnabledFilters()

getLiteralProcessor

public LiteralProcessor getLiteralProcessor()

getASTPrinter

public ASTPrinter getASTPrinter()

getParameterSpecs

public ArrayList<ParameterSpecification> getParameterSpecs()

getNumberOfParametersInSetClause

public int getNumberOfParametersInSetClause()

evaluateAssignment

protected void evaluateAssignment(antlr.collections.AST eq)
                           throws antlr.SemanticException

覆盖:

evaluateAssignment 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

getAssignmentSpecifications

public ArrayList getAssignmentSpecifications()

createIntoClause

protected antlr.collections.AST createIntoClause(String path,
                                                 antlr.collections.AST propertySpec)
                                          throws antlr.SemanticException

覆盖:

createIntoClause 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

prepareVersioned

protected void prepareVersioned(antlr.collections.AST updateNode,
                                antlr.collections.AST versioned)
                         throws antlr.SemanticException

覆盖:

prepareVersioned 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

prepareLogicOperator

protected void prepareLogicOperator(antlr.collections.AST operator)
                             throws antlr.SemanticException

覆盖:

prepareLogicOperator 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

prepareArithmeticOperator

protected void prepareArithmeticOperator(antlr.collections.AST operator)
                                  throws antlr.SemanticException

覆盖:

prepareArithmeticOperator 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

validateMapPropertyExpression

protected void validateMapPropertyExpression(antlr.collections.AST node)
                                      throws antlr.SemanticException

覆盖:

validateMapPropertyExpression 在类中 HqlSqlBaseWalker

抛出:

antlr.SemanticException

getTreatAsDeclarationsByPath

public Set<String> getTreatAsDeclarationsByPath(String path)

getDialect

public Dialect getDialect()

panic

public static void panic()