Hibernate Core 3.6.10.Final · org.hibernate.hql.ast.QueryTranslatorImpl

Modifier and Type	Class and Description
public static class	QueryTranslatorImpl.JavaConstantConverter

Modifier and Type	Field and Description
private static final Logger	AST_LOG
private List<E>	collectedParameterSpecifications
private boolean	compiled
private Map<K, V>	enabledFilters
private SessionFactoryImplementor	factory
private String	hql
private static final Logger	log
private ParameterTranslations	paramTranslations
private final String	queryIdentifier
private QueryLoader	queryLoader
private boolean	shallowQuery
private String	sql
private Statement	sqlAst
private StatementExecutor	statementExecutor
private Map<K, V>	tokenReplacements

Access	Constructor and Description
public	QueryTranslatorImpl(String The query-identifier (used in stats collection) queryIdentifier, String The hql query to translate query, Map<K, V> Currently enabled filters enabledFilters, SessionFactoryImplementor The session factory constructing this translator instance. factory) Creates a new AST-based query translator.

Method Summary

Modifier and Type	Method and Description
private HqlSqlWalker	analyze(HqlParser parser, String collectionRole)
private StatementExecutor	buildAppropriateStatementExecutor(HqlSqlWalker walker)
public List<E>	collectSqlStrings() Implements org.hibernate.hql.QueryTranslator.collectSqlStrings.
public void	compile(Map<K, V> Defined query substitutions. replacements, boolean Does this represent a shallow (scalar or entity-id) select? shallow) Implements org.hibernate.hql.QueryTranslator.compile. Compile a "normal" query.
public void	compile(String the role name of the collection used as the basis for the filter. collectionRole, Map<K, V> Defined query substitutions. replacements, boolean Does this represent a shallow (scalar or entity-id) select? shallow) Implements org.hibernate.hql.FilterTranslator.compile. Compile a filter.
public boolean	containsCollectionFetches() Implements org.hibernate.hql.QueryTranslator.containsCollectionFetches. Does the translated query contain collection fetches?
private synchronized void	doCompile(Map<K, V> Defined query substitutions. replacements, boolean Does this represent a shallow (scalar or entity-id) select? shallow, String the role name of the collection used as the basis for the filter, NULL if this is not a filter. collectionRole) Performs both filter and non-filter compiling.
private void	errorIfDML()
private void	errorIfSelect()
public int	executeUpdate(QueryParameters The query bind parameters. queryParameters, SessionImplementor The session owning this query. session) Implements org.hibernate.hql.QueryTranslator.executeUpdate. Perform a bulk update/delete operation given the underlying query definition.
private void	generate(AST sqlAst)
public List<E>	getCollectedParameterSpecifications()
public String[][]	getColumnNames() Implements org.hibernate.hql.QueryTranslator.getColumnNames. Returns the column names in the generated SQL.
public Class<T>	getDynamicInstantiationResultType() Implements org.hibernate.hql.QueryTranslator.getDynamicInstantiationResultType.
public Map<K, V>	getEnabledFilters() Implements org.hibernate.hql.QueryTranslator.getEnabledFilters. Returns the filters enabled for this query translator.
public int[]	getNamedParameterLocs(String name)
public ParameterTranslations	getParameterTranslations() Implements org.hibernate.hql.QueryTranslator.getParameterTranslations. Return information about any parameters encountered during translation.
public String	getQueryIdentifier() Implements org.hibernate.hql.QueryTranslator.getQueryIdentifier. Retrieve the query identifier for this translator.
public Set<E>	getQuerySpaces() Implements org.hibernate.hql.QueryTranslator.getQuerySpaces. Returns the set of query spaces (table names) that the query refers to.
public String	getQueryString() Implements org.hibernate.hql.QueryTranslator.getQueryString. Returns the HQL string processed by the translator.
public String[]	getReturnAliases() Implements org.hibernate.hql.QueryTranslator.getReturnAliases. Returns an array of HQL aliases
public Type[]	Returns: an array of `Type`s. getReturnTypes() Implements org.hibernate.hql.QueryTranslator.getReturnTypes. Types of the return values of an `iterate()` style query.
public Statement	getSqlAST()
public String	getSQLString() Implements org.hibernate.hql.QueryTranslator.getSQLString. The SQL query string to be called; implemented by all subclasses
private HqlSqlWalker	getWalker()
public boolean	isManipulationStatement() Implements org.hibernate.hql.QueryTranslator.isManipulationStatement.
public boolean	isShallowQuery()
public Iterator<E>	iterate(QueryParameters The query bind parameters. queryParameters, EventSource The session owning this query. session) Implements org.hibernate.hql.QueryTranslator.iterate. Return the query results as an iterator
public List<E>	list(SessionImplementor The session owning this query. session, QueryParameters The query bind parameters. queryParameters) Implements org.hibernate.hql.QueryTranslator.list. Perform a list operation given the underlying query definition.
private HqlParser	parse(boolean filter)
public ScrollableResults	scroll(QueryParameters The query bind parameters. queryParameters, SessionImplementor The session owning this query. session) Implements org.hibernate.hql.QueryTranslator.scroll. Return the query results, as an instance of `ScrollableResults`
pack-priv void	showHqlAst(AST hqlAst)
public void	validateScrollability() Implements org.hibernate.hql.QueryTranslator.validateScrollability. Validate the scrollability of the translated query.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

AST_LOG	back to summary
private static final Logger AST_LOG

collectedParameterSpecifications	back to summary
private List<E> collectedParameterSpecifications

compiled	back to summary
private boolean compiled

enabledFilters	back to summary
private Map<K, V> enabledFilters

factory	back to summary
private SessionFactoryImplementor factory

hql	back to summary
private String hql

log	back to summary
private static final Logger log

paramTranslations	back to summary
private ParameterTranslations paramTranslations

queryIdentifier	back to summary
private final String queryIdentifier

queryLoader	back to summary
private QueryLoader queryLoader

shallowQuery	back to summary
private boolean shallowQuery

sql	back to summary
private String sql

sqlAst	back to summary
private Statement sqlAst

statementExecutor	back to summary
private StatementExecutor statementExecutor

tokenReplacements	back to summary
private Map<K, V> tokenReplacements

QueryTranslatorImpl	back to summary
public QueryTranslatorImpl(String queryIdentifier, String query, Map<K, V> enabledFilters, SessionFactoryImplementor factory) Creates a new AST-based query translator. Parameters queryIdentifier:String The query-identifier (used in stats collection) query:String The hql query to translate enabledFilters:Map<K, V> Currently enabled filters factory:SessionFactoryImplementor The session factory constructing this translator instance.

Method Detail

analyze	back to summary
private HqlSqlWalker analyze(HqlParser parser, String collectionRole) throws QueryException, RecognitionException

buildAppropriateStatementExecutor	back to summary
private StatementExecutor buildAppropriateStatementExecutor(HqlSqlWalker walker)

collectSqlStrings	back to summary
public List<E> collectSqlStrings() Implements org.hibernate.hql.QueryTranslator.collectSqlStrings.

compile	back to summary
public void compile(Map<K, V> replacements, boolean shallow) throws QueryException, MappingException Implements org.hibernate.hql.QueryTranslator.compile. Compile a "normal" query. This method may be called multiple times. Subsequent invocations are no-ops. Parameters replacements:Map<K, V> Defined query substitutions. shallow:boolean Does this represent a shallow (scalar or entity-id) select? Exceptions QueryException: There was a problem parsing the query string. MappingException: There was a problem querying defined mappings.

compile

back to summary

public void compile(Map<K, V> replacements, boolean shallow) throws QueryException, MappingException

Implements org.hibernate.hql.QueryTranslator.compile.

Compile a "normal" query. This method may be called multiple times. Subsequent invocations are no-ops.

Parameters

replacements:Map<K, V>: Defined query substitutions.
shallow:boolean: Does this represent a shallow (scalar or entity-id) select?

Exceptions

QueryException:: There was a problem parsing the query string.
MappingException:: There was a problem querying defined mappings.

compile	back to summary
public void compile(String collectionRole, Map<K, V> replacements, boolean shallow) throws QueryException, MappingException Implements org.hibernate.hql.FilterTranslator.compile. Compile a filter. This method may be called multiple times. Subsequent invocations are no-ops. Parameters collectionRole:String the role name of the collection used as the basis for the filter. replacements:Map<K, V> Defined query substitutions. shallow:boolean Does this represent a shallow (scalar or entity-id) select? Exceptions QueryException: There was a problem parsing the query string. MappingException: There was a problem querying defined mappings.

compile

back to summary

public void compile(String collectionRole, Map<K, V> replacements, boolean shallow) throws QueryException, MappingException

Implements org.hibernate.hql.FilterTranslator.compile.

Compile a filter. This method may be called multiple times. Subsequent invocations are no-ops.

Parameters

collectionRole:String: the role name of the collection used as the basis for the filter.
replacements:Map<K, V>: Defined query substitutions.
shallow:boolean: Does this represent a shallow (scalar or entity-id) select?

Exceptions

QueryException:: There was a problem parsing the query string.
MappingException:: There was a problem querying defined mappings.

containsCollectionFetches	back to summary
public boolean containsCollectionFetches() Implements org.hibernate.hql.QueryTranslator.containsCollectionFetches. Doc from org.hibernate.hql.QueryTranslator.containsCollectionFetches. Does the translated query contain collection fetches? Returns:boolean true if the query does contain collection fetched; false otherwise.

containsCollectionFetches

back to summary

public boolean containsCollectionFetches()

Implements org.hibernate.hql.QueryTranslator.containsCollectionFetches.

Doc from org.hibernate.hql.QueryTranslator.containsCollectionFetches.

Does the translated query contain collection fetches?

Returns:boolean: true if the query does contain collection fetched; false otherwise.

doCompile	back to summary
private synchronized void doCompile(Map<K, V> replacements, boolean shallow, String collectionRole) Performs both filter and non-filter compiling. Parameters replacements:Map<K, V> Defined query substitutions. shallow:boolean Does this represent a shallow (scalar or entity-id) select? collectionRole:String the role name of the collection used as the basis for the filter, NULL if this is not a filter.

doCompile

back to summary

private synchronized void doCompile(Map<K, V> replacements, boolean shallow, String collectionRole)

Performs both filter and non-filter compiling.

Parameters

replacements:Map<K, V>: Defined query substitutions.
shallow:boolean: Does this represent a shallow (scalar or entity-id) select?
collectionRole:String: the role name of the collection used as the basis for the filter, NULL if this is not a filter.

errorIfDML	back to summary
private void errorIfDML() throws HibernateException

errorIfSelect	back to summary
private void errorIfSelect() throws HibernateException

executeUpdate	back to summary
public int executeUpdate(QueryParameters queryParameters, SessionImplementor session) throws HibernateException Implements org.hibernate.hql.QueryTranslator.executeUpdate. Doc from org.hibernate.hql.QueryTranslator.executeUpdate. Perform a bulk update/delete operation given the underlying query definition. Parameters queryParameters:QueryParameters The query bind parameters. session:SessionImplementor The session owning this query. Returns:int The number of entities updated or deleted.

executeUpdate

back to summary

public int executeUpdate(QueryParameters queryParameters, SessionImplementor session) throws HibernateException

Implements org.hibernate.hql.QueryTranslator.executeUpdate.

Doc from org.hibernate.hql.QueryTranslator.executeUpdate.

Perform a bulk update/delete operation given the underlying query definition.

Parameters

queryParameters:QueryParameters: The query bind parameters.
session:SessionImplementor: The session owning this query.

Returns:int

The number of entities updated or deleted.

generate	back to summary
private void generate(AST sqlAst) throws QueryException, RecognitionException

getCollectedParameterSpecifications	back to summary
public List<E> getCollectedParameterSpecifications()

getColumnNames	back to summary
public String[][] getColumnNames() Implements org.hibernate.hql.QueryTranslator.getColumnNames. Doc from org.hibernate.hql.QueryTranslator.getColumnNames. Returns the column names in the generated SQL. Returns:String[][] the column names in the generated SQL.

getColumnNames

back to summary

public String[][] getColumnNames()

Implements org.hibernate.hql.QueryTranslator.getColumnNames.

Doc from org.hibernate.hql.QueryTranslator.getColumnNames.

Returns the column names in the generated SQL.

Returns:String[][]: the column names in the generated SQL.

getDynamicInstantiationResultType	back to summary
public Class<T> getDynamicInstantiationResultType() Implements org.hibernate.hql.QueryTranslator.getDynamicInstantiationResultType.

getEnabledFilters	back to summary
public Map<K, V> getEnabledFilters() Implements org.hibernate.hql.QueryTranslator.getEnabledFilters. Doc from org.hibernate.hql.QueryTranslator.getEnabledFilters. Returns the filters enabled for this query translator. Returns:Map<K, V> Filters enabled for this query execution.

getEnabledFilters

back to summary

public Map<K, V> getEnabledFilters()

Implements org.hibernate.hql.QueryTranslator.getEnabledFilters.

Doc from org.hibernate.hql.QueryTranslator.getEnabledFilters.

Returns the filters enabled for this query translator.

Returns:Map<K, V>: Filters enabled for this query execution.

getNamedParameterLocs	back to summary
public int[] getNamedParameterLocs(String name)

getParameterTranslations	back to summary
public ParameterTranslations getParameterTranslations() Implements org.hibernate.hql.QueryTranslator.getParameterTranslations. Doc from org.hibernate.hql.QueryTranslator.getParameterTranslations. Return information about any parameters encountered during translation. Returns:ParameterTranslations The parameter information.

getParameterTranslations

back to summary

public ParameterTranslations getParameterTranslations()

Implements org.hibernate.hql.QueryTranslator.getParameterTranslations.

Doc from org.hibernate.hql.QueryTranslator.getParameterTranslations.

Return information about any parameters encountered during translation.

Returns:ParameterTranslations: The parameter information.

getQueryIdentifier	back to summary
public String getQueryIdentifier() Implements org.hibernate.hql.QueryTranslator.getQueryIdentifier. Doc from org.hibernate.hql.QueryTranslator.getQueryIdentifier. Retrieve the query identifier for this translator. The query identifier is used in states collection. Returns:String the identifier

getQueryIdentifier

back to summary

public String getQueryIdentifier()

Implements org.hibernate.hql.QueryTranslator.getQueryIdentifier.

Doc from org.hibernate.hql.QueryTranslator.getQueryIdentifier.

Retrieve the query identifier for this translator. The query identifier is used in states collection.

Returns:String: the identifier

getQuerySpaces	back to summary
public Set<E> getQuerySpaces() Implements org.hibernate.hql.QueryTranslator.getQuerySpaces. Doc from org.hibernate.hql.QueryTranslator.getQuerySpaces. Returns the set of query spaces (table names) that the query refers to. Returns:Set<E> A set of query spaces (table names).

getQuerySpaces

back to summary

public Set<E> getQuerySpaces()

Implements org.hibernate.hql.QueryTranslator.getQuerySpaces.

Doc from org.hibernate.hql.QueryTranslator.getQuerySpaces.

Returns the set of query spaces (table names) that the query refers to.

Returns:Set<E>: A set of query spaces (table names).

getQueryString	back to summary
public String getQueryString() Implements org.hibernate.hql.QueryTranslator.getQueryString. Doc from org.hibernate.hql.QueryTranslator.getQueryString. Returns the HQL string processed by the translator. Returns:String the HQL string processed by the translator.

getQueryString

back to summary

public String getQueryString()

Implements org.hibernate.hql.QueryTranslator.getQueryString.

Doc from org.hibernate.hql.QueryTranslator.getQueryString.

Returns the HQL string processed by the translator.

Returns:String: the HQL string processed by the translator.

getReturnAliases	back to summary
public String[] getReturnAliases() Implements org.hibernate.hql.QueryTranslator.getReturnAliases. Doc from org.hibernate.hql.QueryTranslator.getReturnAliases. Returns an array of HQL aliases

getReturnAliases

back to summary

public String[] getReturnAliases()

Implements org.hibernate.hql.QueryTranslator.getReturnAliases.

Doc from org.hibernate.hql.QueryTranslator.getReturnAliases.

Returns an array of HQL aliases

getReturnTypes back to summary

getReturnTypes	back to summary
public Type[] getReturnTypes() Implements org.hibernate.hql.QueryTranslator.getReturnTypes. Types of the return values of an `iterate()` style query. Returns:Type[] an array of `Type`s.

public Type[] getReturnTypes()

Implements org.hibernate.hql.QueryTranslator.getReturnTypes.

Types of the return values of an iterate() style query.

Returns:Type[]: an array of Types.

getSqlAST	back to summary
public Statement getSqlAST()

getSQLString	back to summary
public String getSQLString() Implements org.hibernate.hql.QueryTranslator.getSQLString. The SQL query string to be called; implemented by all subclasses Returns:String Doc from org.hibernate.hql.QueryTranslator.getSQLString. the SQL string generated by the translator.

getSQLString

back to summary

public String getSQLString()

Implements org.hibernate.hql.QueryTranslator.getSQLString.

The SQL query string to be called; implemented by all subclasses

Returns:String

Doc from org.hibernate.hql.QueryTranslator.getSQLString.

the SQL string generated by the translator.

getWalker	back to summary
private HqlSqlWalker getWalker()

isManipulationStatement	back to summary
public boolean isManipulationStatement() Implements org.hibernate.hql.QueryTranslator.isManipulationStatement.

isShallowQuery	back to summary
public boolean isShallowQuery()

iterate	back to summary
public Iterator<E> iterate(QueryParameters queryParameters, EventSource session) throws HibernateException Implements org.hibernate.hql.QueryTranslator.iterate. Return the query results as an iterator Parameters queryParameters:QueryParameters Doc from org.hibernate.hql.QueryTranslator.iterate. The query bind parameters. session:EventSource Doc from org.hibernate.hql.QueryTranslator.iterate. The session owning this query. Returns:Iterator<E> Doc from org.hibernate.hql.QueryTranslator.iterate. An iterator over the query results.

iterate

back to summary

public Iterator<E> iterate(QueryParameters queryParameters, EventSource session) throws HibernateException

Implements org.hibernate.hql.QueryTranslator.iterate.

Return the query results as an iterator

Parameters

queryParameters:QueryParameters

Doc from org.hibernate.hql.QueryTranslator.iterate.

The query bind parameters.

session:EventSource

Doc from org.hibernate.hql.QueryTranslator.iterate.

The session owning this query.

Returns:Iterator<E>

Doc from org.hibernate.hql.QueryTranslator.iterate.

An iterator over the query results.

list	back to summary
public List<E> list(SessionImplementor session, QueryParameters queryParameters) throws HibernateException Implements org.hibernate.hql.QueryTranslator.list. Doc from org.hibernate.hql.QueryTranslator.list. Perform a list operation given the underlying query definition. Parameters session:SessionImplementor The session owning this query. queryParameters:QueryParameters The query bind parameters. Returns:List<E> The query list results.

list

back to summary

public List<E> list(SessionImplementor session, QueryParameters queryParameters) throws HibernateException

Implements org.hibernate.hql.QueryTranslator.list.

Doc from org.hibernate.hql.QueryTranslator.list.

Perform a list operation given the underlying query definition.

Parameters

session:SessionImplementor: The session owning this query.
queryParameters:QueryParameters: The query bind parameters.

Returns:List<E>

The query list results.

parse	back to summary
private HqlParser parse(boolean filter) throws TokenStreamException, RecognitionException

scroll back to summary

public ScrollableResults scroll(QueryParameters queryParameters, SessionImplementor session) throws HibernateException

Implements org.hibernate.hql.QueryTranslator.scroll.

Return the query results, as an instance of ScrollableResults

Parameters

queryParameters:QueryParameters

Doc from org.hibernate.hql.QueryTranslator.scroll.

The query bind parameters.

session:SessionImplementor

Doc from org.hibernate.hql.QueryTranslator.scroll.

The session owning this query.

Returns:ScrollableResults

Doc from org.hibernate.hql.QueryTranslator.scroll.

The ScrollableResults wrapper around the query results.

showHqlAst	back to summary
pack-priv void showHqlAst(AST hqlAst)

validateScrollability

back to summary

public void validateScrollability() throws HibernateException

Implements org.hibernate.hql.QueryTranslator.validateScrollability.

Doc from org.hibernate.hql.QueryTranslator.validateScrollability.

Validate the scrollability of the translated query.

public Class QueryTranslatorImpl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class QueryTranslatorImpl.JavaConstantConverter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Method and Description
private void	handleDotStructure(AST dotStructureRoot)
public void	visit(AST node) Implements org.hibernate.hql.ast.util.NodeTraverser.VisitationStrategy.visit.