程序包 org.hibernate.internal

类 CriteriaImpl

java.lang.Object

org.hibernate.internal.CriteriaImpl

所有已实现的接口:

Serializable, Criteria, CriteriaSpecification

public class CriteriaImpl
extends Object
implements Criteria, Serializable

Implementation of the Criteria interface

作者:

Gavin King

另请参阅:

序列化表格

嵌套类概要

嵌套类

修饰符和类型	类	说明
static class	CriteriaImpl.CriterionEntry
static class	CriteriaImpl.OrderEntry
class	CriteriaImpl.Subcriteria

字段概要

从接口继承的字段 org.hibernate.criterion.CriteriaSpecification

ALIAS_TO_ENTITY_MAP, DISTINCT_ROOT_ENTITY, FULL_JOIN, INNER_JOIN, LEFT_JOIN, PROJECTION, ROOT_ALIAS, ROOT_ENTITY

构造器概要

构造器

构造器	说明
CriteriaImpl(String entityOrClassName, String alias, SharedSessionContractImplementor session)
CriteriaImpl(String entityOrClassName, SharedSessionContractImplementor session)

方法概要

修饰符和类型	方法	说明
Criteria	add(Criteria criteriaInst, Criterion expression)
Criteria	add(Criterion expression)	Add a restriction to constrain the results to be retrieved.
Criteria	addOrder(Order ordering)	Add an ordering to the result set.
Criteria	addQueryHint(String queryHint)	Add a DB query hint to the SQL.
protected void	after()
protected void	before()
Criteria	createAlias(String associationPath, String alias)	Join an association, assigning an alias to the joined association.
Criteria	createAlias(String associationPath, String alias, int joinType)	Join an association using the specified join-type, assigning an alias to the joined association.
Criteria	createAlias(String associationPath, String alias, int joinType, Criterion withClause)	Join an association using the specified join-type, assigning an alias to the joined association.
Criteria	createAlias(String associationPath, String alias, JoinType joinType)	Join an association using the specified join-type, assigning an alias to the joined association.
Criteria	createAlias(String associationPath, String alias, JoinType joinType, Criterion withClause)	Join an association using the specified join-type, assigning an alias to the joined association.
Criteria	createCriteria(String associationPath)	Create a new Criteria, "rooted" at the associated entity.
Criteria	createCriteria(String associationPath, int joinType)	Create a new Criteria, "rooted" at the associated entity, using the specified join type.
Criteria	createCriteria(String associationPath, String alias)	Create a new Criteria, "rooted" at the associated entity, assigning the given alias.
Criteria	createCriteria(String associationPath, String alias, int joinType)	Create a new Criteria, "rooted" at the associated entity, assigning the given alias and using the specified join type.
Criteria	createCriteria(String associationPath, String alias, int joinType, Criterion withClause)	Create a new Criteria, "rooted" at the associated entity, assigning the given alias and using the specified join type.
Criteria	createCriteria(String associationPath, String alias, JoinType joinType)	Create a new Criteria, "rooted" at the associated entity, assigning the given alias and using the specified join type.
Criteria	createCriteria(String associationPath, String alias, JoinType joinType, Criterion withClause)	Create a new Criteria, "rooted" at the associated entity, assigning the given alias and using the specified join type.
Criteria	createCriteria(String associationPath, JoinType joinType)	Create a new Criteria, "rooted" at the associated entity, using the specified join type.
String	getAlias()	Get the alias of the entity encapsulated by this criteria instance.
boolean	getCacheable()
String	getCacheRegion()
String	getComment()
String	getEntityOrClassName()
FetchMode	getFetchMode(String path)
Integer	getFetchSize()
Integer	getFirstResult()
Map<String,LockMode>	getLockModes()
Integer	getMaxResults()
Projection	getProjection()
Criteria	getProjectionCriteria()
List<String>	getQueryHints()
ResultTransformer	getResultTransformer()
SharedSessionContractImplementor	getSession()
Integer	getTimeout()
boolean	isLookupByNaturalKey()
boolean	isReadOnly()	Should entities and proxies loaded by this Criteria be put in read-only mode?
boolean	isReadOnlyInitialized()	Was the read-only/modifiable mode explicitly initialized?
Iterator<CriteriaImpl.CriterionEntry>	iterateExpressionEntries()
Iterator<CriteriaImpl.OrderEntry>	iterateOrderings()
Iterator<CriteriaImpl.Subcriteria>	iterateSubcriteria()
List	list()	Get the results.
ScrollableResults	scroll()	Get the results as an instance of ScrollableResults.
ScrollableResults	scroll(ScrollMode scrollMode)	Get the results as an instance of ScrollableResults based on the given scroll mode.
Criteria	setCacheable(boolean cacheable)	Enable caching of this query result, provided query caching is enabled for the underlying session factory.
Criteria	setCacheMode(CacheMode cacheMode)	Override the cache mode for this particular query.
Criteria	setCacheRegion(String cacheRegion)	Set the name of the cache region to use for query result caching.
Criteria	setComment(String comment)	Add a comment to the generated SQL.
Criteria	setFetchMode(String associationPath, FetchMode mode)	Specify an association fetching strategy for an association or a collection of values.
Criteria	setFetchSize(int fetchSize)	Set a fetch size for the underlying JDBC query.
Criteria	setFirstResult(int firstResult)	Set the first result to be retrieved.
Criteria	setFlushMode(FlushMode flushMode)	Override the flush mode for this particular query.
Criteria	setLockMode(String alias, LockMode lockMode)	Set the lock mode of the aliased entity.
Criteria	setLockMode(LockMode lockMode)	Set the lock mode of the current entity.
Criteria	setMaxResults(int maxResults)	Set a limit upon the number of objects to be retrieved.
Criteria	setProjection(Projection projection)	Used to specify that the query results will be a projection (scalar in nature).
Criteria	setReadOnly(boolean readOnly)	Set the read-only/modifiable mode for entities and proxies loaded by this Criteria.
Criteria	setResultTransformer(ResultTransformer tupleMapper)	Set a strategy for handling the query results.
void	setSession(SharedSessionContractImplementor session)
Criteria	setTimeout(int timeout)	Set a timeout for the underlying JDBC query.
String	toString()
Object	uniqueResult()	Convenience method to return a single instance that matches the query, or null if the query returns no results.

从类继承的方法 java.lang.Object

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

构造器详细资料

CriteriaImpl

public CriteriaImpl(String entityOrClassName,
                    SharedSessionContractImplementor session)

CriteriaImpl

public CriteriaImpl(String entityOrClassName,
                    String alias,
                    SharedSessionContractImplementor session)

方法详细资料

toString

public String toString()

覆盖:

toString 在类中 Object

getSession

public SharedSessionContractImplementor getSession()

setSession

public void setSession(SharedSessionContractImplementor session)

getEntityOrClassName

public String getEntityOrClassName()

getLockModes

public Map<String,LockMode> getLockModes()

getProjectionCriteria

public Criteria getProjectionCriteria()

iterateSubcriteria

public Iterator<CriteriaImpl.Subcriteria> iterateSubcriteria()

iterateExpressionEntries

public Iterator<CriteriaImpl.CriterionEntry> iterateExpressionEntries()

iterateOrderings

public Iterator<CriteriaImpl.OrderEntry> iterateOrderings()

add

public Criteria add(Criteria criteriaInst,
                    Criterion expression)

getAlias

public String getAlias()

从接口复制的说明: Criteria

Get the alias of the entity encapsulated by this criteria instance.

指定者:

getAlias 在接口中 Criteria

返回:

The alias for the encapsulated entity.

getProjection

public Projection getProjection()

setProjection

public Criteria setProjection(Projection projection)

从接口复制的说明: Criteria

Used to specify that the query results will be a projection (scalar in nature). Implicitly specifies the CriteriaSpecification.PROJECTION result transformer.

The individual components contained within the given projection determines the overall "shape" of the query result.

指定者:

setProjection 在接口中 Criteria

参数:

projection - The projection representing the overall "shape" of the query results.

返回:

this (for method chaining)

add

public Criteria add(Criterion expression)

从接口复制的说明: Criteria

Add a restriction to constrain the results to be retrieved.

指定者:

add 在接口中 Criteria

参数:

expression - The criterion object representing the restriction to be applied.

返回:

this (for method chaining)

addOrder

public Criteria addOrder(Order ordering)

从接口复制的说明: Criteria

Add an ordering to the result set.

指定者:

addOrder 在接口中 Criteria

参数:

ordering - The order object representing an ordering to be applied to the results.

返回:

this (for method chaining)

getFetchMode

public FetchMode getFetchMode(String path)

setFetchMode

public Criteria setFetchMode(String associationPath,
                             FetchMode mode)

从接口复制的说明: Criteria

Specify an association fetching strategy for an association or a collection of values.

指定者:

setFetchMode 在接口中 Criteria

参数:

associationPath - a dot separated property path

mode - The fetch mode for the referenced association

返回:

this (for method chaining)

setLockMode

public Criteria setLockMode(LockMode lockMode)

从接口复制的说明: Criteria

Set the lock mode of the current entity.

指定者:

setLockMode 在接口中 Criteria

参数:

lockMode - The lock mode to be applied

返回:

this (for method chaining)

setLockMode

public Criteria setLockMode(String alias,
                            LockMode lockMode)

从接口复制的说明: Criteria

Set the lock mode of the aliased entity.

指定者:

setLockMode 在接口中 Criteria

参数:

alias - The previously assigned alias representing the entity to which the given lock mode should apply.

lockMode - The lock mode to be applied

返回:

this (for method chaining)

createAlias

public Criteria createAlias(String associationPath,
                            String alias)

从接口复制的说明: Criteria

Join an association, assigning an alias to the joined association.

Functionally equivalent to Criteria.createAlias(String, String, JoinType ) using JoinType.INNER_JOIN for the joinType.

指定者:

createAlias 在接口中 Criteria

参数:

associationPath - A dot-separated property path

alias - The alias to assign to the joined association (for later reference).

返回:

this (for method chaining)

createAlias

public Criteria createAlias(String associationPath,
                            String alias,
                            JoinType joinType)

从接口复制的说明: Criteria

Join an association using the specified join-type, assigning an alias to the joined association.

The joinType is expected to be one of JoinType.INNER_JOIN (the default), JoinType.FULL_JOIN, or JoinType.LEFT_OUTER_JOIN.

指定者:

createAlias 在接口中 Criteria

参数:

associationPath - A dot-separated property path

alias - The alias to assign to the joined association (for later reference).

joinType - The type of join to use.

返回:

this (for method chaining)

createAlias

public Criteria createAlias(String associationPath,
                            String alias,
                            int joinType)
                     throws HibernateException

从接口复制的说明: Criteria

Join an association using the specified join-type, assigning an alias to the joined association.

The joinType is expected to be one of CriteriaSpecification.INNER_JOIN (the default), CriteriaSpecification.FULL_JOIN, or CriteriaSpecification.LEFT_JOIN.

指定者:

createAlias 在接口中 Criteria

参数:

associationPath - A dot-separated property path

alias - The alias to assign to the joined association (for later reference).

joinType - The type of join to use.

返回:

this (for method chaining)

抛出:

HibernateException - Indicates a problem creating the sub criteria

createAlias

public Criteria createAlias(String associationPath,
                            String alias,
                            JoinType joinType,
                            Criterion withClause)

从接口复制的说明: Criteria

Join an association using the specified join-type, assigning an alias to the joined association.

The joinType is expected to be one of JoinType.INNER_JOIN (the default), JoinType.FULL_JOIN, or JoinType.LEFT_OUTER_JOIN.

指定者:

createAlias 在接口中 Criteria

参数:

associationPath - A dot-separated property path

alias - The alias to assign to the joined association (for later reference).

joinType - The type of join to use.

withClause - The criteria to be added to the join condition (ON clause)

返回:

this (for method chaining)

createAlias

public Criteria createAlias(String associationPath,
                            String alias,
                            int joinType,
                            Criterion withClause)
                     throws HibernateException

从接口复制的说明: Criteria

Join an association using the specified join-type, assigning an alias to the joined association.

The joinType is expected to be one of CriteriaSpecification.INNER_JOIN (the default), CriteriaSpecification.FULL_JOIN, or CriteriaSpecification.LEFT_JOIN.

指定者:

createAlias 在接口中 Criteria

参数:

associationPath - A dot-separated property path

alias - The alias to assign to the joined association (for later reference).

joinType - The type of join to use.

withClause - The criteria to be added to the join condition (ON clause)

返回:

this (for method chaining)

抛出:

HibernateException - Indicates a problem creating the sub criteria

createCriteria

public Criteria createCriteria(String associationPath)

从接口复制的说明: Criteria

Create a new Criteria, "rooted" at the associated entity.

Functionally equivalent to Criteria.createCriteria(String, org.hibernate.sql.JoinType) using JoinType.INNER_JOIN for the joinType.

指定者:

createCriteria 在接口中 Criteria

参数:

associationPath - A dot-separated property path

返回:

the created "sub criteria"

createCriteria

public Criteria createCriteria(String associationPath,
                               JoinType joinType)

从接口复制的说明: Criteria

Create a new Criteria, "rooted" at the associated entity, using the specified join type.

指定者:

createCriteria 在接口中 Criteria

参数:

associationPath - A dot-separated property path

joinType - The type of join to use.

返回:

the created "sub criteria"

createCriteria

public Criteria createCriteria(String associationPath,
                               int joinType)
                        throws HibernateException

从接口复制的说明: Criteria

Create a new Criteria, "rooted" at the associated entity, using the specified join type.

指定者:

createCriteria 在接口中 Criteria

参数:

associationPath - A dot-separated property path

joinType - The type of join to use.

返回:

the created "sub criteria"

抛出:

HibernateException - Indicates a problem creating the sub criteria

createCriteria

public Criteria createCriteria(String associationPath,
                               String alias)

从接口复制的说明: Criteria

Create a new Criteria, "rooted" at the associated entity, assigning the given alias.

Functionally equivalent to Criteria.createCriteria(String, String, org.hibernate.sql.JoinType) using JoinType.INNER_JOIN for the joinType.

指定者:

createCriteria 在接口中 Criteria

参数:

associationPath - A dot-separated property path

alias - The alias to assign to the joined association (for later reference).

返回:

the created "sub criteria"

createCriteria

public Criteria createCriteria(String associationPath,
                               String alias,
                               JoinType joinType)

从接口复制的说明: Criteria

Create a new Criteria, "rooted" at the associated entity, assigning the given alias and using the specified join type.

指定者:

createCriteria 在接口中 Criteria

参数:

associationPath - A dot-separated property path

alias - The alias to assign to the joined association (for later reference).

joinType - The type of join to use.

返回:

the created "sub criteria"

createCriteria

public Criteria createCriteria(String associationPath,
                               String alias,
                               int joinType)
                        throws HibernateException

从接口复制的说明: Criteria

Create a new Criteria, "rooted" at the associated entity, assigning the given alias and using the specified join type.

指定者:

createCriteria 在接口中 Criteria

参数:

associationPath - A dot-separated property path

alias - The alias to assign to the joined association (for later reference).

joinType - The type of join to use.

返回:

the created "sub criteria"

抛出:

HibernateException - Indicates a problem creating the sub criteria

createCriteria

public Criteria createCriteria(String associationPath,
                               String alias,
                               JoinType joinType,
                               Criterion withClause)

从接口复制的说明: Criteria

Create a new Criteria, "rooted" at the associated entity, assigning the given alias and using the specified join type.

指定者:

createCriteria 在接口中 Criteria

参数:

associationPath - A dot-separated property path

alias - The alias to assign to the joined association (for later reference).

joinType - The type of join to use.

withClause - The criteria to be added to the join condition (ON clause)

返回:

the created "sub criteria"

createCriteria

public Criteria createCriteria(String associationPath,
                               String alias,
                               int joinType,
                               Criterion withClause)
                        throws HibernateException

从接口复制的说明: Criteria

Create a new Criteria, "rooted" at the associated entity, assigning the given alias and using the specified join type.

指定者:

createCriteria 在接口中 Criteria

参数:

associationPath - A dot-separated property path

alias - The alias to assign to the joined association (for later reference).

joinType - The type of join to use.

withClause - The criteria to be added to the join condition (ON clause)

返回:

the created "sub criteria"

抛出:

HibernateException - Indicates a problem creating the sub criteria

getResultTransformer

public ResultTransformer getResultTransformer()

setResultTransformer

public Criteria setResultTransformer(ResultTransformer tupleMapper)

从接口复制的说明: Criteria

Set a strategy for handling the query results. This determines the "shape" of the query result.

指定者:

setResultTransformer 在接口中 Criteria

参数:

tupleMapper - The transformer to apply

返回:

this (for method chaining)

另请参阅:

CriteriaSpecification.ROOT_ENTITY, CriteriaSpecification.DISTINCT_ROOT_ENTITY, CriteriaSpecification.ALIAS_TO_ENTITY_MAP, CriteriaSpecification.PROJECTION

getMaxResults

public Integer getMaxResults()

setMaxResults

public Criteria setMaxResults(int maxResults)

从接口复制的说明: Criteria

Set a limit upon the number of objects to be retrieved.

指定者:

setMaxResults 在接口中 Criteria

参数:

maxResults - the maximum number of results

返回:

this (for method chaining)

getFirstResult

public Integer getFirstResult()

setFirstResult

public Criteria setFirstResult(int firstResult)

从接口复制的说明: Criteria

Set the first result to be retrieved.

指定者:

setFirstResult 在接口中 Criteria

参数:

firstResult - the first result to retrieve, numbered from 0

返回:

this (for method chaining)

getFetchSize

public Integer getFetchSize()

setFetchSize

public Criteria setFetchSize(int fetchSize)

从接口复制的说明: Criteria

Set a fetch size for the underlying JDBC query.

指定者:

setFetchSize 在接口中 Criteria

参数:

fetchSize - the fetch size

返回:

this (for method chaining)

另请参阅:

Statement.setFetchSize(int)

getTimeout

public Integer getTimeout()

setTimeout

public Criteria setTimeout(int timeout)

从接口复制的说明: Criteria

Set a timeout for the underlying JDBC query.

指定者:

setTimeout 在接口中 Criteria

参数:

timeout - The timeout value to apply.

返回:

this (for method chaining)

另请参阅:

Statement.setQueryTimeout(int)

isReadOnlyInitialized

public boolean isReadOnlyInitialized()

从接口复制的说明: Criteria

Was the read-only/modifiable mode explicitly initialized?

指定者:

isReadOnlyInitialized 在接口中 Criteria

返回:

true, the read-only/modifiable mode was explicitly initialized; false, otherwise.

另请参阅:

Criteria.setReadOnly(boolean)

isReadOnly

public boolean isReadOnly()

从接口复制的说明: Criteria

Should entities and proxies loaded by this Criteria 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.

指定者:

isReadOnly 在接口中 Criteria

返回:

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

另请参阅:

Criteria.setReadOnly(boolean), The read-only/modifiable setting has no impact on entities/proxies returned by the Criteria that existed in the session before the Criteria was executed., Criteria.isReadOnlyInitialized()

setReadOnly

public Criteria setReadOnly(boolean readOnly)

从接口复制的说明: Criteria

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

指定者:

setReadOnly 在接口中 Criteria

参数:

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

返回:

this, for method chaining

另请参阅:

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 criteria that existed in the session before the criteria was executed.

getCacheable

public boolean getCacheable()

setCacheable

public Criteria setCacheable(boolean cacheable)

从接口复制的说明: Criteria

Enable caching of this query result, provided query caching is enabled for the underlying session factory.

指定者:

setCacheable 在接口中 Criteria

参数:

cacheable - Should the result be considered cacheable; default is to not cache (false).

返回:

this (for method chaining)

getCacheRegion

public String getCacheRegion()

setCacheRegion

public Criteria setCacheRegion(String cacheRegion)

从接口复制的说明: Criteria

Set the name of the cache region to use for query result caching.

指定者:

setCacheRegion 在接口中 Criteria

参数:

cacheRegion - the name of a query cache region, or null for the default query cache

返回:

this (for method chaining)

另请参阅:

Criteria.setCacheable(boolean)

getComment

public String getComment()

setComment

public Criteria setComment(String comment)

从接口复制的说明: Criteria

Add a comment to the generated SQL.

指定者:

setComment 在接口中 Criteria

参数:

comment - a human-readable string

返回:

this (for method chaining)

getQueryHints

public List<String> getQueryHints()

addQueryHint

public Criteria addQueryHint(String queryHint)

从接口复制的说明: Criteria

Add a DB query hint to the SQL. These differ from JPA's QueryHint, which is specific to the JPA implementation and ignores DB vendor-specific hints. Instead, these are intended solely for the vendor-specific hints, such as Oracle's optimizers. Multiple query hints are supported; the Dialect will determine concatenation and placement.

指定者:

addQueryHint 在接口中 Criteria

参数:

queryHint - The database specific query hint to add.

返回:

this (for method chaining)

setFlushMode

public Criteria setFlushMode(FlushMode flushMode)

从接口复制的说明: Criteria

Override the flush mode for this particular query.

指定者:

setFlushMode 在接口中 Criteria

参数:

flushMode - The flush mode to use.

返回:

this (for method chaining)

setCacheMode

public Criteria setCacheMode(CacheMode cacheMode)

从接口复制的说明: Criteria

Override the cache mode for this particular query.

指定者:

setCacheMode 在接口中 Criteria

参数:

cacheMode - The cache mode to use.

返回:

this (for method chaining)

list

public List list()
          throws HibernateException

从接口复制的说明: Criteria

Get the results.

指定者:

list 在接口中 Criteria

返回:

The list of matched query results.

抛出:

HibernateException - Indicates a problem either translating the criteria to SQL, exeucting the SQL or processing the SQL results.

scroll

public ScrollableResults scroll()

从接口复制的说明: Criteria

Get the results as an instance of ScrollableResults.

指定者:

scroll 在接口中 Criteria

返回:

The ScrollableResults representing the matched query results.

scroll

public ScrollableResults scroll(ScrollMode scrollMode)

从接口复制的说明: Criteria

Get the results as an instance of ScrollableResults based on the given scroll mode.

指定者:

scroll 在接口中 Criteria

参数:

scrollMode - Indicates the type of underlying database cursor to request.

返回:

The ScrollableResults representing the matched query results.

uniqueResult

public Object uniqueResult()
                    throws HibernateException

从接口复制的说明: Criteria

Convenience method to return a single instance that matches the query, or null if the query returns no results.

指定者:

uniqueResult 在接口中 Criteria

返回:

the single result or null

抛出:

HibernateException - if there is more than one matching result

before

protected void before()

after

protected void after()

isLookupByNaturalKey

public boolean isLookupByNaturalKey()