org.hibernate.internal

Class AbstractBasicQueryContractImpl

java.lang.Object

org.hibernate.internal.AbstractBasicQueryContractImpl

All Implemented Interfaces:

BasicQueryContract

Direct Known Subclasses:

ProcedureCallImpl

public abstract class AbstractBasicQueryContractImpl
extends Object
implements BasicQueryContract

Author:

Steve Ebersole

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBasicQueryContractImpl(SessionImplementor session)

Method Summary

Modifier and Type	Method and Description
QueryParameters	buildQueryParametersObject()
CacheMode	getCacheMode() Obtain the CacheMode in effect for this query.
String	getCacheRegion() Obtain the name of the second level query cache region in which query results will be stored (if they are cached, see the discussion on BasicQueryContract.isCacheable() for more information).
Integer	getFetchSize() Obtain the JDBC fetch size hint in effect for this query.
FlushMode	getFlushMode() Obtain the FlushMode in effect for this query.
Integer	getTimeout() Obtain the query timeout in seconds.
boolean	isCacheable() Are the results of this query eligible for second level query caching? This is different that second level caching of any returned entities and collections.
boolean	isReadOnly() Should entities and proxies loaded by this Query be put in read-only mode? If the read-only/modifiable setting was not initialized, then the default read-only/modifiable setting for the persistence context is returned instead.
protected SessionImplementor	session()
BasicQueryContract	setCacheable(boolean cacheable) Enable/disable second level query (result) caching for this query.
BasicQueryContract	setCacheMode(CacheMode cacheMode) (Re)set the current CacheMode in effect for this query.
BasicQueryContract	setCacheRegion(String cacheRegion) Set the name of the cache region where query results should be cached (if cached at all).
BasicQueryContract	setFetchSize(int fetchSize) Sets a JDBC fetch size hint for the query.
BasicQueryContract	setFlushMode(FlushMode flushMode) (Re)set the current FlushMode in effect for this query.
BasicQueryContract	setReadOnly(boolean readOnly) Set the read-only/modifiable mode for entities and proxies loaded by this Query.
BasicQueryContract	setTimeout(int timeout) Set the query timeout in seconds.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.BasicQueryContract

getReturnTypes

Constructor Detail

AbstractBasicQueryContractImpl

protected AbstractBasicQueryContractImpl(SessionImplementor session)

Method Detail

session

protected SessionImplementor session()

getFlushMode

public FlushMode getFlushMode()

Description copied from interface: BasicQueryContract

Obtain the FlushMode in effect for this query. By default, the query inherits the FlushMode of the Session from which is originates.

Specified by:

getFlushMode in interface BasicQueryContract

Returns:

The query FlushMode.

See Also:

Session.getFlushMode(), FlushMode

setFlushMode

public BasicQueryContract setFlushMode(FlushMode flushMode)

Description copied from interface: BasicQueryContract

(Re)set the current FlushMode in effect for this query.

Specified by:

setFlushMode in interface BasicQueryContract

Parameters:

flushMode - The new FlushMode to use.

Returns:

this, for method chaining

See Also:

BasicQueryContract.getFlushMode()

getCacheMode

public CacheMode getCacheMode()

Description copied from interface: BasicQueryContract

Obtain the CacheMode in effect for this query. By default, the query inherits the CacheMode of the Session from which is originates. NOTE: The CacheMode here only effects reading/writing of the query cache, not the entity/collection caches.

Specified by:

getCacheMode in interface BasicQueryContract

Returns:

The query CacheMode.

See Also:

Session.getCacheMode(), CacheMode

setCacheMode

public BasicQueryContract setCacheMode(CacheMode cacheMode)

Description copied from interface: BasicQueryContract

(Re)set the current CacheMode in effect for this query.

Specified by:

setCacheMode in interface BasicQueryContract

Parameters:

cacheMode - The new CacheMode to use.

Returns:

this, for method chaining

See Also:

BasicQueryContract.getCacheMode()

isCacheable

public boolean isCacheable()

Description copied from interface: BasicQueryContract

Are the results of this query eligible for second level query caching? This is different that second level caching of any returned entities and collections. NOTE: the query being "eligible" for caching does not necessarily mean its results will be cached. Second level query caching still has to be enabled on the SessionFactory for this to happen. Usually that is controlled by the hibernate.cache.use_query_cache configuration setting.

Specified by:

isCacheable in interface BasicQueryContract

Returns:

true if the query results are eligible for caching, false otherwise.

See Also:

AvailableSettings.USE_QUERY_CACHE

setCacheable

public BasicQueryContract setCacheable(boolean cacheable)

Description copied from interface: BasicQueryContract

Enable/disable second level query (result) caching for this query.

Specified by:

setCacheable in interface BasicQueryContract

Parameters:

cacheable - Should the query results be cacheable?

Returns:

this, for method chaining

See Also:

BasicQueryContract.isCacheable()

getCacheRegion

public String getCacheRegion()

Description copied from interface: BasicQueryContract

Obtain the name of the second level query cache region in which query results will be stored (if they are cached, see the discussion on BasicQueryContract.isCacheable() for more information). null indicates that the default region should be used.

Specified by:

getCacheRegion in interface BasicQueryContract

Returns:

The specified cache region name into which query results should be placed; null indicates the default region.

setCacheRegion

public BasicQueryContract setCacheRegion(String cacheRegion)

Description copied from interface: BasicQueryContract

Set the name of the cache region where query results should be cached (if cached at all).

Specified by:

setCacheRegion in interface BasicQueryContract

Parameters:

cacheRegion - the name of a query cache region, or null to indicate that the default region should be used.

Returns:

this, for method chaining

See Also:

BasicQueryContract.getCacheRegion()

isReadOnly

public boolean isReadOnly()

Description copied from interface: BasicQueryContract

Should entities and proxies loaded by this Query be put in read-only mode? If the read-only/modifiable setting was not initialized, then the default read-only/modifiable setting for the persistence context is returned instead.

Specified by:

isReadOnly in interface BasicQueryContract

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

See Also:

Query.setReadOnly(boolean), 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.

setReadOnly

public BasicQueryContract setReadOnly(boolean readOnly)

Description copied from interface: BasicQueryContract

Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context.

Specified by:

setReadOnly in interface BasicQueryContract

Parameters:

readOnly - 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

Returns:

this, for method chaining

See Also:

To set the default read-only/modifiable setting used for entities and proxies that are loaded into the session:, PersistenceContext.setDefaultReadOnly(boolean), Read-only entities are not dirty-checked and snapshots of persistent state are not maintained. Read-only entities can be modified, but changes are not persisted. When a proxy is initialized, the loaded entity will have the same read-only/modifiable setting as the uninitialized proxy has, regardless of the session's current setting. 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.

getTimeout

public Integer getTimeout()

Description copied from interface: BasicQueryContract

Obtain the query timeout in seconds. This value is eventually passed along to the JDBC query via Statement.setQueryTimeout(int). Zero indicates no timeout.

Specified by:

getTimeout in interface BasicQueryContract

Returns:

The timeout in seconds

See Also:

Statement.getQueryTimeout(), Statement.setQueryTimeout(int)

setTimeout

public BasicQueryContract setTimeout(int timeout)

Description copied from interface: BasicQueryContract

Set the query timeout in seconds. NOTE it is important to understand that any value set here is eventually passed directly through to the JDBC Statement which expressly disallows negative values. So negative values should be avoided as a general rule.

Specified by:

setTimeout in interface BasicQueryContract

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

BasicQueryContract.getTimeout()

getFetchSize

public Integer getFetchSize()

Description copied from interface: BasicQueryContract

Obtain the JDBC fetch size hint in effect for this query. This value is eventually passed along to the JDBC query via Statement.setFetchSize(int). As defined b y JDBC, this value is a hint to the driver to indicate how many rows to fetch from the database when more rows are needed. NOTE : JDBC expressly defines this value as a hint. It may or may not have any effect on the actual query execution and ResultSet processing depending on the driver.

Specified by:

getFetchSize in interface BasicQueryContract

Returns:

The timeout in seconds

See Also:

Statement.getFetchSize(), Statement.setFetchSize(int)

setFetchSize

public BasicQueryContract setFetchSize(int fetchSize)

Description copied from interface: BasicQueryContract

Sets a JDBC fetch size hint for the query.

Specified by:

setFetchSize in interface BasicQueryContract

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

BasicQueryContract.getFetchSize()

buildQueryParametersObject

public QueryParameters buildQueryParametersObject()