Top Description Inners Fields Constructors Methods
org.hibernate.hql.ast

public Class HqlSqlWalker

extends HqlSqlBaseWalker
implements ErrorReporter, NamedParameterSource
Class Inheritance
All Implemented Interfaces
org.hibernate.engine.ParameterBinder.NamedParameterSource, org.hibernate.hql.ast.ErrorReporter
Imports
java.io.Serializable, java.util.ArrayList, .Calendar, .Date, .HashMap, .HashSet, .Iterator, .List, .Map, .Set, .Arrays, org.slf4j.Logger, .LoggerFactory, org.hibernate.QueryException, .HibernateException, org.hibernate.engine.JoinSequence, .ParameterBinder, .SessionFactoryImplementor, org.hibernate.hql.QueryTranslator, org.hibernate.hql.antlr.HqlSqlBaseWalker, .HqlSqlTokenTypes, .HqlTokenTypes, .SqlTokenTypes, org.hibernate.hql.ast.tree.AggregateNode, .AssignmentSpecification, .CollectionFunction, .ConstructorNode, .DeleteStatement, .DotNode, .FromClause, .FromElement, .FromReferenceNode, .IdentNode, .IndexNode, .InsertStatement, .IntoClause, .MethodNode, .ParameterNode, .QueryNode, .ResolvableNode, .RestrictableStatement, .ResultVariableRefNode, .SelectClause, .SelectExpression, .UpdateStatement, .OperatorNode, .ParameterContainer, .FromElementFactory, org.hibernate.hql.ast.util.ASTPrinter, .ASTUtil, .AliasGenerator, .JoinProcessor, .LiteralProcessor, .SessionFactoryHelper, .SyntheticAndFactory, .NodeTraverser, org.hibernate.id.IdentifierGenerator, .PostInsertIdentifierGenerator, .SequenceGenerator, org.hibernate.param.NamedParameterSpecification, .ParameterSpecification, .PositionalParameterSpecification, .VersionTypeSeedParameterSpecification, .CollectionFilterKeyParameterSpecification, org.hibernate.persister.collection.QueryableCollection, org.hibernate.persister.entity.Queryable, org.hibernate.sql.JoinFragment, org.hibernate.type.AssociationType, .Type, .VersionType, .DbTimestampType, .ComponentType, org.hibernate.usertype.UserVersionType, org.hibernate.util.ArrayHelper, .StringHelper, antlr.ASTFactory, .RecognitionException, .SemanticException, antlr.collections.AST
Implements methods used by the HQL->SQL tree transform grammar (a.k.a. the second phase).
See Also
SqlASTFactory

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
HqlSqlWalker.WithClauseVisitor

Field Summary

Modifier and TypeField and Description
private final AliasGenerator
aliasGenerator

private ArrayList<E>
assignmentSpecifications

private final String
collectionFilterRole

private FromClause
currentFromClause

private final HqlParser
hqlParser

private int
impliedJoinType

private final LiteralProcessor
literalProcessor

private static final Logger
log

Hides org.hibernate.hql.antlr.HqlSqlBaseWalker.log.

private Map<K, V>
namedParameters

private int
numberOfParametersInSetClause

private int
parameterCount

private ArrayList<E>
parameters

private final ParseErrorHandler
parseErrorHandler

private int
positionalParameterCount

private final ASTPrinter
printer

private Set<E>
querySpaces

private final QueryTranslatorImpl
queryTranslatorImpl

private SelectClause
selectClause

private Map<String, SelectExpression>
selectExpressionsByResultVariable

Maps each top-level result variable to its SelectExpression; (excludes result variables defined in subqueries)

private final SessionFactoryHelper
sessionFactoryHelper

private final Map<K, V>
tokenReplacements

private final boolean
trace

private int
traceDepth

Hides antlr.TreeParser.traceDepth.

Inherited from org.hibernate.hql.antlr.HqlSqlBaseWalker:
_tokenNames_tokenSet_0_tokenSet_1

Constructor Summary

AccessConstructor and Description
public
HqlSqlWalker(QueryTranslatorImpl
Back pointer to the query translator implementation that is using this tree transform.
qti, SessionFactoryImplementor
The session factory implementor where the Hibernate mappings can be found.
sfi, HqlParser
A reference to the phase-1 parser
parser, Map<K, V>
Registers the token replacement map with the walker. This map will be used to substitute function names and constants.
tokenReplacements, String
The collection role name of the collection used as the basis for the filter, NULL if this is not a collection filter compilation.
collectionRole)

Create a new tree transformer.

Method Summary

Modifier and TypeMethod and Description
public void
addQuerySpaces(Serializable[] spaces)

protected void
beforeSelectClause()

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.beforeSelectClause.

private String
buildTraceNodeName(AST tree)

protected AST
createFromElement(String path, AST alias, AST propertyFetch)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.createFromElement.

protected AST
createFromFilterElement(AST filterEntity, AST alias)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.createFromFilterElement.

protected void
createFromJoinElement(AST path, AST alias, int joinType, AST fetchNode, AST propertyFetch, AST with)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.createFromJoinElement.

protected AST
createIntoClause(String path, AST propertySpec)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.createIntoClause.

private void
createSelectClauseFromFromClause(QueryNode qn)

protected void
evaluateAssignment(AST eq)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.evaluateAssignment.

private void
evaluateAssignment(AST eq, Queryable persister, int targetIndex)

protected AST
generateNamedParameter(AST delimiterNode, AST nameNode)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.generateNamedParameter.

protected AST
generatePositionalParameter(AST inputNode)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.generatePositionalParameter.

private AST
generateSyntheticDotNodeForNonQualifiedPropertyRef(AST property, FromElement fromElement)

Deprecated as a consequence of FromElement being deprecated.
private AST
generateVersionPropertyNode(Queryable persister)

public AliasGenerator
getAliasGenerator()

public ArrayList<E>
getAssignmentSpecifications()

public ASTPrinter
getASTPrinter()

public String
getCollectionFilterRole()

public FromClause
getCurrentFromClause()

public Map<K, V>
getEnabledFilters()

public FromClause
getFinalFromClause()

public int
getImpliedJoinType()

public LiteralProcessor
getLiteralProcessor()

public int[]
getNamedParameterLocations(String name)

Implements org.hibernate.engine.ParameterBinder.NamedParameterSource.getNamedParameterLocations.

Returns the locations of all occurrences of the named parameter.
public int
getNumberOfParametersInSetClause()

public ArrayList<E>
getParameters()

public ParseErrorHandler
getParseErrorHandler()

public Set<E>

Returns:

A set of table names (Strings).
getQuerySpaces()

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

public String[]
getReturnAliases()

public Type[]
getReturnTypes()

public SelectClause
getSelectClause()

public SessionFactoryHelper
getSessionFactoryHelper()

public Map<K, V>
getTokenReplacements()

protected void
handleResultVariableRef(AST resultVariableRef)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.handleResultVariableRef.

private void
handleWithFragment(FromElement fromElement, AST hqlWithNode)

Deprecated as a consequence of FromElement being deprecated.
private boolean
isDatabaseGeneratedTimestamp(Type type)

public boolean
isFilter()

private boolean
isIntegral(Type type)

protected boolean
isNonQualifiedPropertyRef(AST ident)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.isNonQualifiedPropertyRef.

protected boolean
isOrderExpressionResultVariableRef(AST orderExpressionNode)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.isOrderExpressionResultVariableRef.

public boolean
isShallowQuery()

private boolean
isTimestampBasedVersion(VersionType<T> versionType)

protected void
lookupAlias(AST aliasRef)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.lookupAlias.

protected AST
lookupNonQualifiedProperty(AST property)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.lookupNonQualifiedProperty.

protected AST
lookupProperty(AST dot, boolean root, boolean inSelect)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.lookupProperty.

public static void
panic()

Hides antlr.TreeParser.panic.

private void
popFromClause()

Returns to the previous 'FROM' context.

protected void
postProcessDelete(AST delete)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.postProcessDelete.

protected void
postProcessDML(RestrictableStatement statement)

protected void
postProcessInsert(AST insert)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.postProcessInsert.

protected void
postProcessUpdate(AST update)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.postProcessUpdate.

protected void
prepareArithmeticOperator(AST operator)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.prepareArithmeticOperator.

protected void
prepareFromClauseInputTree(AST fromClauseInput)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.prepareFromClauseInputTree.

Pre-process the from clause input tree.
protected void
prepareLogicOperator(AST operator)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.prepareLogicOperator.

protected void
prepareVersioned(AST updateNode, AST versioned)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.prepareVersioned.

protected void
processAggregation(AST node, boolean inSelect)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.processAggregation.

protected void
processBoolean(AST constant)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.processBoolean.

protected void
processConstant(AST constant)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.processConstant.

protected void
processConstructor(AST constructor)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.processConstructor.

protected void
processFunction(AST functionCall, boolean inSelect)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.processFunction.

protected void
processIndex(AST indexOp)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.processIndex.

protected void
processNumericLiteral(AST literal)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.processNumericLiteral.

protected void
processQuery(AST select, AST query)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.processQuery.

protected void
pushFromClause(AST
The new 'FROM' context.
fromNode, AST
The from node from the input AST.
inputFromNode)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.pushFromClause.

Sets the current 'FROM' context.
public void
reportError(RecognitionException e)

Overrides antlr.TreeParser.reportError.

Implements org.hibernate.hql.ast.ErrorReporter.reportError.

Parser error-reporting function can be overridden in subclass
public void
reportError(String s)

Overrides antlr.TreeParser.reportError.

Implements org.hibernate.hql.ast.ErrorReporter.reportError.

Parser error-reporting function can be overridden in subclass
public void
reportWarning(String s)

Overrides antlr.TreeParser.reportWarning.

Implements org.hibernate.hql.ast.ErrorReporter.reportWarning.

Parser warning-reporting function can be overridden in subclass
protected void
resolve(AST node)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.resolve.

protected void
resolveSelectExpression(AST node)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.resolveSelectExpression.

protected void
setAlias(AST selectExpr, AST ident)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.setAlias.

protected void
setImpliedJoinType(int joinType)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.setImpliedJoinType.

public static boolean
supportsIdGenWithBulkInsertion(IdentifierGenerator generator)

public void
traceIn(String ruleName, AST tree)

Overrides antlr.TreeParser.traceIn.

public void
traceOut(String ruleName, AST tree)

Overrides antlr.TreeParser.traceOut.

private void
trackNamedParameterPositions(String name)

private void
useSelectClause(AST select)

protected void
validateMapPropertyExpression(AST node)

Overrides org.hibernate.hql.antlr.HqlSqlBaseWalker.validateMapPropertyExpression.

Inherited from org.hibernate.hql.antlr.HqlSqlBaseWalker:
addrExpraddrExprLhsaggregateExpraliasedSelectExpraliasRefarithmeticExprassignmentcaseExprcollectionFunctioncollectionFunctionOrSubselectcomparisonExprconstantconstructorcountdeleteStatementexprexprOrSubqueryfromClausefromElementfromElementListfunctionCallgetCurrentClauseTypegetCurrentStatementTypegetCurrentTopLevelClauseTypegetStatementTypegroupClauseidentifierinRhsinsertablePropertySpecinsertStatementintoClauseisComparativeExpressionClauseisInCaseisInFromisInFunctionCallisInSelectisSelectStatementisSubQueryjoinElementjoinTypeliterallogicalExprmapComponentReferencemapPropertyExpressionnewValuenumericIntegerorderClauseorderExprorderExprsparameterpathpathAsIdentprocessMapComponentReferencepropertyNamepropertyRefpropertyRefLhsqueryresultVariableRefselectClauseselectExprselectExprListselectStatementsetClausestatementupdateStatementwhereClausewithClause