Hibernate ORM - hibernate-core 5.6.15.Final · org.hibernate.engine.spi.QueryParameters

Modifier and Type	Field and Description
private boolean	autodiscovertypes
private boolean	cacheable
private String	cacheRegion
private boolean	callable
private Serializable[]	collectionKeys
private String	comment
private boolean	isNaturalKeyLookup
private boolean	isReadOnlyInitialized
private LockOptions	lockOptions
private static final Logger	LOG
private Map<String, TypedValue>	namedParameters
private String	optionalEntityName
private Serializable	optionalId
private Object	optionalObject
private boolean	passDistinctThrough
private Type[]	positionalParameterTypes
private Object[]	positionalParameterValues
private Type[]	processedPositionalParameterTypes
private Object[]	processedPositionalParameterValues
private String	processedSQL
private List<String>	queryHints
private HQLQueryPlan	queryPlan
private boolean	readOnly
private final ResultTransformer	resultTransformer
private RowSelection	rowSelection
private ScrollMode	scrollMode
private static final String	SYMBOLS Symbols used to split SQL string into tokens in `processFilters(String, Map, SessionFactoryImplementor)`.

Constructor Summary

Access	Constructor and Description
public	QueryParameters()
public	QueryParameters(Type type, Object value)
public	QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final Object optionalObject, final String optionalEntityName, final Serializable optionalObjectId)
public	QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues)
public	QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final Serializable[] collectionKeys)
public	QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final Map<String, TypedValue> namedParameters, final Serializable[] collectionKeys)
public	QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final LockOptions lockOptions, final RowSelection rowSelection, final boolean isReadOnlyInitialized, final boolean readOnly, final boolean cacheable, final String cacheRegion, final String comment, final List<String> queryHints, final boolean isLookupByNaturalKey, final ResultTransformer transformer)
public	QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final Map<String, TypedValue> namedParameters, final LockOptions lockOptions, final RowSelection rowSelection, final boolean isReadOnlyInitialized, final boolean readOnly, final boolean cacheable, final String cacheRegion, final String comment, final List<String> queryHints, final Serializable[] collectionKeys, ResultTransformer transformer)
public	QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final Map<String, TypedValue> namedParameters, final LockOptions lockOptions, final RowSelection rowSelection, final boolean isReadOnlyInitialized, final boolean readOnly, final boolean cacheable, final String cacheRegion, final String comment, final List<String> queryHints, final Serializable[] collectionKeys, final Object optionalObject, final String optionalEntityName, final Serializable optionalId, final ResultTransformer transformer)
public	QueryParameters(QueryParameterBindings queryParameterBindings, LockOptions lockOptions, RowSelection selection, final boolean isReadOnlyInitialized, boolean readOnly, boolean cacheable, String cacheRegion, String comment, List<String> dbHints, final Serializable[] collectionKeys, final Object optionalObject, final String optionalEntityName, final Serializable optionalId, ResultTransformer resultTransformer)

Method Summary

Modifier and Type	Method and Description
public void	bindDynamicParameter(Type paramType, Object paramValue)
public QueryParameters	createCopyUsing(RowSelection selection)
public String	getCacheRegion()
public Serializable[]	getCollectionKeys()
public String	getComment()
public Type[]	getFilteredPositionalParameterTypes()
public Object[]	getFilteredPositionalParameterValues()
public String	getFilteredSQL()
public LockOptions	getLockOptions()
public Map<String, TypedValue>	getNamedParameters()
private int	getNumberOfParametersCoveredBy(Type[] subtypes)
public String	getOptionalEntityName()
public Serializable	getOptionalId()
public Object	getOptionalObject()
public Type[]	getPositionalParameterTypes()
public Object[]	getPositionalParameterValues()
public List<String>	getQueryHints()
public HQLQueryPlan	getQueryPlan()
public ResultTransformer	getResultTransformer()
public RowSelection	getRowSelection()
public ScrollMode	getScrollMode()
public boolean	hasAutoDiscoverScalarTypes()
public boolean	hasRowSelection()
public boolean	isCacheable()
public boolean	isCallable()
public boolean	isNaturalKeyLookup()
public boolean	Returns: the query passes `distinct` to the database isPassDistinctThrough() Check if this query should pass the `distinct` to the database.
public boolean	Returns: true, entities and proxies loaded by the Query will be put in read-only mode false, entities and proxies loaded by the Query will be put in modifiable mode isReadOnly() Should entities and proxies loaded by the Query be put in read-only mode?
public boolean	Returns: `true` indicates that entities and proxies loaded by the query will be put in read-only mode; `false` indicates that entities and proxies loaded by the query will be put in modifiable mode isReadOnly(SharedSessionContractImplementor The originating session session) Should entities and proxies loaded by the Query be put in read-only mode?
public boolean	Returns: true, the read-only/modifiable mode was explicitly set false, the read-only/modifiable mode was not explicitly set isReadOnlyInitialized() Has the read-only/modifiable mode been explicitly set?
public void	processFilters(String sql, SharedSessionContractImplementor session)
public void	processFilters(String sql, Map<K, V> filters, SessionFactoryImplementor factory) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated.
public void	setAutoDiscoverScalarTypes(boolean autodiscovertypes)
public void	setCacheable(boolean b)
public void	setCacheRegion(String cacheRegion)
public void	setCallable(boolean callable)
public void	setCollectionKeys(Serializable[] collectionKeys)
public void	setComment(String comment)
public void	setLockOptions(LockOptions lockOptions)
public void	setNamedParameters(Map<String, TypedValue> map)
public void	setNaturalKeyLookup(boolean isNaturalKeyLookup)
public void	setOptionalEntityName(String optionalEntityName)
public void	setOptionalId(Serializable optionalId)
public void	setOptionalObject(Object optionalObject)
public void	setPassDistinctThrough(boolean the query passes `distinct` to the database passDistinctThrough) Set if this query should pass the `distinct` to the database.
public void	setPositionalParameterTypes(Type[] types)
public void	setPositionalParameterValues(Object[] objects)
public void	setQueryHints(List<String> queryHints)
public void	setQueryPlan(HQLQueryPlan queryPlan)
public void	setReadOnly(boolean if `true`, entities and proxies loaded by the query will be put in read-only mode; if `false`, entities and proxies loaded by the query will be put in modifiable mode readOnly) Set the read-only/modifiable mode for entities and proxies loaded by the query.
public void	setRowSelection(RowSelection selection)
public void	setScrollMode(ScrollMode scrollMode)
public void	traceParameters(SessionFactoryImplementor factory) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated.
public void	validateParameters()

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

Field Detail

autodiscovertypes	back to summary
private boolean autodiscovertypes

cacheable	back to summary
private boolean cacheable

cacheRegion	back to summary
private String cacheRegion

callable	back to summary
private boolean callable

collectionKeys	back to summary
private Serializable[] collectionKeys

comment	back to summary
private String comment

isNaturalKeyLookup	back to summary
private boolean isNaturalKeyLookup

isReadOnlyInitialized	back to summary
private boolean isReadOnlyInitialized

lockOptions	back to summary
private LockOptions lockOptions

LOG	back to summary
private static final Logger LOG

namedParameters	back to summary
private Map<String, TypedValue> namedParameters

optionalEntityName	back to summary
private String optionalEntityName

optionalId	back to summary
private Serializable optionalId

optionalObject	back to summary
private Object optionalObject

passDistinctThrough	back to summary
private boolean passDistinctThrough

positionalParameterTypes	back to summary
private Type[] positionalParameterTypes

positionalParameterValues	back to summary
private Object[] positionalParameterValues

processedPositionalParameterTypes	back to summary
private Type[] processedPositionalParameterTypes

processedPositionalParameterValues	back to summary
private Object[] processedPositionalParameterValues

processedSQL	back to summary
private String processedSQL

queryHints	back to summary
private List<String> queryHints

queryPlan	back to summary
private HQLQueryPlan queryPlan

readOnly	back to summary
private boolean readOnly

resultTransformer	back to summary
private final ResultTransformer resultTransformer

rowSelection	back to summary
private RowSelection rowSelection

scrollMode	back to summary
private ScrollMode scrollMode

SYMBOLS	back to summary
private static final String SYMBOLS Symbols used to split SQL string into tokens in `processFilters(String, Map, SessionFactoryImplementor)`.

Constructor Detail

QueryParameters	back to summary
public QueryParameters()

QueryParameters	back to summary
public QueryParameters(Type type, Object value)

QueryParameters	back to summary
public QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final Object optionalObject, final String optionalEntityName, final Serializable optionalObjectId)

QueryParameters	back to summary
public QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues)

QueryParameters	back to summary
public QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final Serializable[] collectionKeys)

QueryParameters	back to summary
public QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final Map<String, TypedValue> namedParameters, final Serializable[] collectionKeys)

QueryParameters	back to summary
public QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final LockOptions lockOptions, final RowSelection rowSelection, final boolean isReadOnlyInitialized, final boolean readOnly, final boolean cacheable, final String cacheRegion, final String comment, final List<String> queryHints, final boolean isLookupByNaturalKey, final ResultTransformer transformer)

QueryParameters

back to summary

public QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final LockOptions lockOptions, final RowSelection rowSelection, final boolean isReadOnlyInitialized, final boolean readOnly, final boolean cacheable, final String cacheRegion, final String comment, final List<String> queryHints, final boolean isLookupByNaturalKey, final ResultTransformer transformer)

QueryParameters	back to summary
public QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final Map<String, TypedValue> namedParameters, final LockOptions lockOptions, final RowSelection rowSelection, final boolean isReadOnlyInitialized, final boolean readOnly, final boolean cacheable, final String cacheRegion, final String comment, final List<String> queryHints, final Serializable[] collectionKeys, ResultTransformer transformer)

QueryParameters

back to summary

public QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final Map<String, TypedValue> namedParameters, final LockOptions lockOptions, final RowSelection rowSelection, final boolean isReadOnlyInitialized, final boolean readOnly, final boolean cacheable, final String cacheRegion, final String comment, final List<String> queryHints, final Serializable[] collectionKeys, ResultTransformer transformer)

QueryParameters	back to summary
public QueryParameters(final Type[] positionalParameterTypes, final Object[] positionalParameterValues, final Map<String, TypedValue> namedParameters, final LockOptions lockOptions, final RowSelection rowSelection, final boolean isReadOnlyInitialized, final boolean readOnly, final boolean cacheable, final String cacheRegion, final String comment, final List<String> queryHints, final Serializable[] collectionKeys, final Object optionalObject, final String optionalEntityName, final Serializable optionalId, final ResultTransformer transformer)

QueryParameters

back to summary

QueryParameters	back to summary
public QueryParameters(QueryParameterBindings queryParameterBindings, LockOptions lockOptions, RowSelection selection, final boolean isReadOnlyInitialized, boolean readOnly, boolean cacheable, String cacheRegion, String comment, List<String> dbHints, final Serializable[] collectionKeys, final Object optionalObject, final String optionalEntityName, final Serializable optionalId, ResultTransformer resultTransformer)

QueryParameters

back to summary

public QueryParameters(QueryParameterBindings queryParameterBindings, LockOptions lockOptions, RowSelection selection, final boolean isReadOnlyInitialized, boolean readOnly, boolean cacheable, String cacheRegion, String comment, List<String> dbHints, final Serializable[] collectionKeys, final Object optionalObject, final String optionalEntityName, final Serializable optionalId, ResultTransformer resultTransformer)

Method Detail

bindDynamicParameter	back to summary
public void bindDynamicParameter(Type paramType, Object paramValue)

createCopyUsing	back to summary
public QueryParameters createCopyUsing(RowSelection selection)

getCacheRegion	back to summary
public String getCacheRegion()

getCollectionKeys	back to summary
public Serializable[] getCollectionKeys()

getComment	back to summary
public String getComment()

getFilteredPositionalParameterTypes	back to summary
public Type[] getFilteredPositionalParameterTypes()

getFilteredPositionalParameterValues	back to summary
public Object[] getFilteredPositionalParameterValues()

getFilteredSQL	back to summary
public String getFilteredSQL()

getLockOptions	back to summary
public LockOptions getLockOptions()

getNamedParameters	back to summary
public Map<String, TypedValue> getNamedParameters()

getNumberOfParametersCoveredBy	back to summary
private int getNumberOfParametersCoveredBy(Type[] subtypes)

getOptionalEntityName	back to summary
public String getOptionalEntityName()

getOptionalId	back to summary
public Serializable getOptionalId()

getOptionalObject	back to summary
public Object getOptionalObject()

getPositionalParameterTypes	back to summary
public Type[] getPositionalParameterTypes()

getPositionalParameterValues	back to summary
public Object[] getPositionalParameterValues()

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

getQueryPlan	back to summary
public HQLQueryPlan getQueryPlan()

getResultTransformer	back to summary
public ResultTransformer getResultTransformer()

getRowSelection	back to summary
public RowSelection getRowSelection()

getScrollMode	back to summary
public ScrollMode getScrollMode()

hasAutoDiscoverScalarTypes	back to summary
public boolean hasAutoDiscoverScalarTypes()

hasRowSelection	back to summary
public boolean hasRowSelection() Annotations @SuppressWarnings:UnusedDeclaration

isCacheable	back to summary
public boolean isCacheable()

isCallable	back to summary
public boolean isCallable()

isNaturalKeyLookup	back to summary
public boolean isNaturalKeyLookup()

isPassDistinctThrough back to summary

public boolean isPassDistinctThrough()

Check if this query should pass the distinct to the database.

Returns:boolean: the query passes distinct to the database

isReadOnly back to summary

public boolean isReadOnly()

Should entities and proxies loaded by the Query be put in read-only mode? The read-only/modifiable setting must be initialized via QueryParameters#setReadOnly(boolean) before calling this method.

Returns:boolean

true, entities and proxies loaded by the Query will be put in read-only mode false, entities and proxies loaded by the Query will be put in modifiable mode

Exceptions

IllegalStateException:: if the read-only/modifiable setting has not been initialized (i.e., isReadOnlyInitialized() == false).

The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session before the query was executed.

isReadOnly back to summary

public boolean isReadOnly(SharedSessionContractImplementor session)

Should entities and proxies loaded by the Query be put in read-only mode? If the read-only/modifiable setting was not initialized (i.e., QueryParameters#isReadOnlyInitialized() == false), then the default read-only/modifiable setting for the persistence context is returned instead.

The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session before the query was executed.

Parameters

session:SharedSessionContractImplementor: The originating session

Returns:boolean

true indicates that entities and proxies loaded by the query will be put in read-only mode; false indicates that entities and proxies loaded by the query will be put in modifiable mode

The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session before the query was executed.

isReadOnlyInitialized back to summary

public boolean isReadOnlyInitialized()

Has the read-only/modifiable mode been explicitly set?

Returns:boolean: true, the read-only/modifiable mode was explicitly set false, the read-only/modifiable mode was not explicitly set
See Also: QueryParameters#setReadOnly(boolean), QueryParameters#isReadOnly(SharedSessionContractImplementor)

processFilters	back to summary
public void processFilters(String sql, SharedSessionContractImplementor session)

processFilters	back to summary
public void processFilters(String sql, Map<K, V> filters, SessionFactoryImplementor factory) Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. See corresponding docs for further information. Annotations @SuppressWarnings:unchecked

setAutoDiscoverScalarTypes	back to summary
public void setAutoDiscoverScalarTypes(boolean autodiscovertypes)

setCacheable	back to summary
public void setCacheable(boolean b)

setCacheRegion	back to summary
public void setCacheRegion(String cacheRegion)

setCallable	back to summary
public void setCallable(boolean callable)

setCollectionKeys	back to summary
public void setCollectionKeys(Serializable[] collectionKeys) Annotations @SuppressWarnings:UnusedDeclaration

setComment	back to summary
public void setComment(String comment)

setLockOptions	back to summary
public void setLockOptions(LockOptions lockOptions)

setNamedParameters	back to summary
public void setNamedParameters(Map<String, TypedValue> map) Annotations @SuppressWarnings:UnusedDeclaration

setNaturalKeyLookup	back to summary
public void setNaturalKeyLookup(boolean isNaturalKeyLookup) Annotations @SuppressWarnings:UnusedDeclaration

setOptionalEntityName	back to summary
public void setOptionalEntityName(String optionalEntityName)

setOptionalId	back to summary
public void setOptionalId(Serializable optionalId)

setOptionalObject	back to summary
public void setOptionalObject(Object optionalObject)

setPassDistinctThrough back to summary

public void setPassDistinctThrough(boolean passDistinctThrough)

Set if this query should pass the distinct to the database.

Parameters

passDistinctThrough:boolean: the query passes distinct to the database

setPositionalParameterTypes	back to summary
public void setPositionalParameterTypes(Type[] types)

setPositionalParameterValues	back to summary
public void setPositionalParameterValues(Object[] objects)

setQueryHints	back to summary
public void setQueryHints(List<String> queryHints)

setQueryPlan	back to summary
public void setQueryPlan(HQLQueryPlan queryPlan)

setReadOnly back to summary

public void setReadOnly(boolean readOnly)

Set the read-only/modifiable mode for entities and proxies loaded by the query.

The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session before the query was executed.

Parameters

readOnly:boolean: if true, entities and proxies loaded by the query will be put in read-only mode; if false, entities and proxies loaded by the query will be put in modifiable mode

setRowSelection	back to summary
public void setRowSelection(RowSelection selection) Annotations @SuppressWarnings:UnusedDeclaration

setScrollMode	back to summary
public void setScrollMode(ScrollMode scrollMode)

traceParameters	back to summary
public void traceParameters(SessionFactoryImplementor factory) throws HibernateException Deprecated as a consequence of `SessionFactoryImplementor` being deprecated. See corresponding docs for further information.

validateParameters	back to summary
public void validateParameters() throws QueryException

public final Class QueryParameters

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail