Hibernate ORM - hibernate-core 5.6.15.Final · org.hibernate.hql.spi.QueryTranslator

Modifier and Type	Field and Description
public static final String	ERROR_CANNOT_DETERMINE_TYPE
public static final String	ERROR_CANNOT_FETCH_WITH_ITERATE
public static final String	ERROR_CANNOT_FORMAT_LITERAL
public static final String	ERROR_LEGACY_ORDINAL_PARAMS_NO_LONGER_SUPPORTED
public static final String	ERROR_NAMED_PARAMETER_DOES_NOT_APPEAR
public static final String	ERROR_ORDINAL_PARAMETER_DOES_NOT_APPEAR

Method Summary

Modifier and Type	Method and Description
public List<String>	collectSqlStrings()
public void	compile(Map<K, V> Defined query substitutions. replacements, boolean Does this represent a shallow (scalar or entity-id) select? shallow) Compile a "normal" query.
public boolean	Returns: true if the query does contain collection fetched; false otherwise. containsCollectionFetches() Does the translated query contain collection fetches?
public int	Returns: The number of entities updated or deleted. executeUpdate(QueryParameters The query bind parameters. queryParameters, SharedSessionContractImplementor The session owning this query. session) Perform a bulk update/delete operation given the underlying query definition.
public String[][]	Returns: the column names in the generated SQL. getColumnNames() Returns the column names in the generated SQL.
public Class<T>	getDynamicInstantiationResultType()
public Map<K, V>	Returns: Filters enabled for this query execution. getEnabledFilters() Returns the filters enabled for this query translator.
public ParameterTranslations	Returns: The parameter information. getParameterTranslations() Return information about any parameters encountered during translation.
public default List<String>	getPrimaryFromClauseTables()
public String	Returns: the identifier getQueryIdentifier() Retrieve the query identifier for this translator.
public Set<Serializable>	Returns: A set of query spaces (table names). getQuerySpaces() Returns the set of query spaces (table names) that the query refers to.
public String	Returns: the HQL string processed by the translator. getQueryString() Returns the HQL string processed by the translator.
public String[]	getReturnAliases() Returns an array of HQL aliases
public Type[]	Returns: Query return types. getReturnTypes() Returns an array of Types represented in the query result.
public String	Returns: the SQL string generated by the translator. getSQLString() Returns the SQL string generated by the translator.
public boolean	isManipulationStatement()
public default boolean	isUpdateStatement()
public Iterator<E>	Returns: An iterator over the query results. iterate(QueryParameters The query bind parameters. queryParameters, EventSource The session owning this query. session) Deprecated as a consequence of `EventSource` being deprecated. Perform an iterate operation given the underlying query definition.
public List<E>	Returns: The query list results. list(SharedSessionContractImplementor The session owning this query. session, QueryParameters The query bind parameters. queryParameters) Perform a list operation given the underlying query definition.
public ScrollableResultsImplementor	Returns: The ScrollableResults wrapper around the query results. scroll(QueryParameters The query bind parameters. queryParameters, SharedSessionContractImplementor The session owning this query. session) Perform a scroll operation given the underlying query definition.
public void	validateScrollability() Validate the scrollability of the translated query.

ERROR_CANNOT_DETERMINE_TYPE	back to summary
public static final String ERROR_CANNOT_DETERMINE_TYPE

ERROR_CANNOT_FETCH_WITH_ITERATE	back to summary
public static final String ERROR_CANNOT_FETCH_WITH_ITERATE

ERROR_CANNOT_FORMAT_LITERAL	back to summary
public static final String ERROR_CANNOT_FORMAT_LITERAL

ERROR_LEGACY_ORDINAL_PARAMS_NO_LONGER_SUPPORTED	back to summary
public static final String ERROR_LEGACY_ORDINAL_PARAMS_NO_LONGER_SUPPORTED

ERROR_NAMED_PARAMETER_DOES_NOT_APPEAR	back to summary
public static final String ERROR_NAMED_PARAMETER_DOES_NOT_APPEAR

ERROR_ORDINAL_PARAMETER_DOES_NOT_APPEAR	back to summary
public static final String ERROR_ORDINAL_PARAMETER_DOES_NOT_APPEAR

Method Detail

collectSqlStrings	back to summary
public List<String> collectSqlStrings()

compile	back to summary
public void compile(Map<K, V> replacements, boolean shallow) throws QueryException, MappingException 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

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.

containsCollectionFetches	back to summary
public boolean 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()

Does the translated query contain collection fetches?

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

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

executeUpdate

back to summary

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

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

Parameters

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

Returns:int

The number of entities updated or deleted.

getColumnNames	back to summary
public String[][] 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()

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()

getEnabledFilters	back to summary
public Map<K, V> 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()

Returns the filters enabled for this query translator.

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

getParameterTranslations	back to summary
public ParameterTranslations getParameterTranslations() Return information about any parameters encountered during translation. Returns:ParameterTranslations The parameter information.

getParameterTranslations

back to summary

public ParameterTranslations getParameterTranslations()

Return information about any parameters encountered during translation.

Returns:ParameterTranslations: The parameter information.

getPrimaryFromClauseTables	back to summary
public default List<String> getPrimaryFromClauseTables()

getQueryIdentifier	back to summary
public String 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()

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<Serializable> getQuerySpaces() Returns the set of query spaces (table names) that the query refers to. Returns:Set<Serializable> A set of query spaces (table names).

getQuerySpaces

back to summary

public Set<Serializable> getQuerySpaces()

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

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

getQueryString	back to summary
public String 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()

Returns the HQL string processed by the translator.

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

getReturnAliases	back to summary
public String[] getReturnAliases() Returns an array of HQL aliases

getReturnTypes	back to summary
public Type[] getReturnTypes() Returns an array of Types represented in the query result. Returns:Type[] Query return types.

getReturnTypes

back to summary

public Type[] getReturnTypes()

Returns an array of Types represented in the query result.

Returns:Type[]: Query return types.

getSQLString	back to summary
public String getSQLString() Returns the SQL string generated by the translator. Returns:String the SQL string generated by the translator.

getSQLString

back to summary

public String getSQLString()

Returns the SQL string generated by the translator.

Returns:String: the SQL string generated by the translator.

isManipulationStatement	back to summary
public boolean isManipulationStatement()

isUpdateStatement	back to summary
public default boolean isUpdateStatement()

iterate back to summary

iterate	back to summary
public Iterator<E> iterate(QueryParameters queryParameters, EventSource session) throws HibernateException Deprecated as a consequence of `EventSource` being deprecated. See corresponding docs for further information. Perform an iterate operation given the underlying query definition. Parameters queryParameters:QueryParameters The query bind parameters. session:EventSource The session owning this query. Returns:Iterator<E> An iterator over the query results.

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

Deprecated

as a consequence of EventSource being deprecated. See corresponding docs for further information.

Perform an iterate operation given the underlying query definition.

Parameters

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

Returns:Iterator<E>

An iterator over the query results.

list	back to summary
public List<E> list(SharedSessionContractImplementor session, QueryParameters queryParameters) throws HibernateException Perform a list operation given the underlying query definition. Parameters session:SharedSessionContractImplementor 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(SharedSessionContractImplementor session, QueryParameters queryParameters) throws HibernateException

Perform a list operation given the underlying query definition.

Parameters

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

Returns:List<E>

The query list results.

scroll	back to summary
public ScrollableResultsImplementor scroll(QueryParameters queryParameters, SharedSessionContractImplementor session) throws HibernateException Perform a scroll operation given the underlying query definition. Parameters queryParameters:QueryParameters The query bind parameters. session:SharedSessionContractImplementor The session owning this query. Returns:ScrollableResultsImplementor The ScrollableResults wrapper around the query results.

scroll

back to summary

public ScrollableResultsImplementor scroll(QueryParameters queryParameters, SharedSessionContractImplementor session) throws HibernateException

Perform a scroll operation given the underlying query definition.

Parameters

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

Returns:ScrollableResultsImplementor

The ScrollableResults wrapper around the query results.

validateScrollability	back to summary
public void validateScrollability() throws HibernateException Validate the scrollability of the translated query.

public Interface QueryTranslator

Field Summary

Method Summary

Field Detail

Method Detail