public class CriteriaImpl extends Object implements Criteria, Serializable
Modifier and Type | Class and Description |
---|---|
static class |
CriteriaImpl.CriterionEntry |
static class |
CriteriaImpl.OrderEntry |
class |
CriteriaImpl.Subcriteria |
ALIAS_TO_ENTITY_MAP, DISTINCT_ROOT_ENTITY, FULL_JOIN, INNER_JOIN, LEFT_JOIN, PROJECTION, ROOT_ALIAS, ROOT_ENTITY
Constructor and Description |
---|
CriteriaImpl(String entityOrClassName,
SessionImplementor session) |
CriteriaImpl(String entityOrClassName,
String alias,
SessionImplementor session) |
Modifier and Type | Method and Description |
---|---|
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,
JoinType 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.
|
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() |
SessionImplementor |
getSession() |
Integer |
getTimeout() |
boolean |
isLookupByNaturalKey() |
boolean |
isReadOnly()
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.
|
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(LockMode lockMode)
Set the lock mode of the current entity.
|
Criteria |
setLockMode(String alias,
LockMode lockMode)
Set the lock mode of the aliased 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(SessionImplementor 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.
|
public CriteriaImpl(String entityOrClassName, SessionImplementor session)
public CriteriaImpl(String entityOrClassName, String alias, SessionImplementor session)
public SessionImplementor getSession()
public void setSession(SessionImplementor session)
public String getEntityOrClassName()
public Criteria getProjectionCriteria()
public Iterator<CriteriaImpl.Subcriteria> iterateSubcriteria()
public Iterator<CriteriaImpl.CriterionEntry> iterateExpressionEntries()
public Iterator<CriteriaImpl.OrderEntry> iterateOrderings()
public String getAlias()
Criteria
public Projection getProjection()
public Criteria setProjection(Projection projection)
Criteria
CriteriaSpecification.PROJECTION
result transformer.
The individual components contained within the given
projection
determines the overall "shape" of the
query result.setProjection
in interface Criteria
projection
- The projection representing the overall "shape" of the
query results.public Criteria add(Criterion expression)
Criteria
restriction
to constrain the results to be
retrieved.public Criteria addOrder(Order ordering)
Criteria
ordering
to the result set.public Criteria setFetchMode(String associationPath, FetchMode mode)
Criteria
setFetchMode
in interface Criteria
associationPath
- a dot seperated property pathmode
- The fetch mode for the referenced associationpublic Criteria setLockMode(LockMode lockMode)
Criteria
setLockMode
in interface Criteria
lockMode
- The lock mode to be appliedpublic Criteria setLockMode(String alias, LockMode lockMode)
Criteria
setLockMode
in interface Criteria
alias
- The previously assigned alias representing the entity to
which the given lock mode should apply.lockMode
- The lock mode to be appliedpublic Criteria createAlias(String associationPath, String alias)
Criteria
Criteria.createAlias(String, String, JoinType )
using
JoinType.INNER_JOIN
for the joinType.createAlias
in interface Criteria
associationPath
- A dot-seperated property pathalias
- The alias to assign to the joined association (for later reference).public Criteria createAlias(String associationPath, String alias, JoinType joinType)
Criteria
JoinType.INNER_JOIN
(the default),
JoinType.FULL_JOIN
, or JoinType.LEFT_OUTER_JOIN
.createAlias
in interface Criteria
associationPath
- A dot-seperated property pathalias
- The alias to assign to the joined association (for later reference).joinType
- The type of join to use.public Criteria createAlias(String associationPath, String alias, int joinType) throws HibernateException
Criteria
CriteriaSpecification.INNER_JOIN
(the default),
CriteriaSpecification.FULL_JOIN
, or CriteriaSpecification.LEFT_JOIN
.createAlias
in interface Criteria
associationPath
- A dot-seperated property pathalias
- The alias to assign to the joined association (for later reference).joinType
- The type of join to use.HibernateException
- Indicates a problem creating the sub criteriapublic Criteria createAlias(String associationPath, String alias, JoinType joinType, Criterion withClause)
Criteria
JoinType.INNER_JOIN
(the default),
JoinType.FULL_JOIN
, or JoinType.LEFT_OUTER_JOIN
.createAlias
in interface Criteria
associationPath
- A dot-seperated property pathalias
- 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)public Criteria createAlias(String associationPath, String alias, int joinType, Criterion withClause) throws HibernateException
Criteria
CriteriaSpecification.INNER_JOIN
(the default),
CriteriaSpecification.FULL_JOIN
, or CriteriaSpecification.LEFT_JOIN
.createAlias
in interface Criteria
associationPath
- A dot-seperated property pathalias
- 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)HibernateException
- Indicates a problem creating the sub criteriapublic Criteria createCriteria(String associationPath)
Criteria
Criteria.createCriteria(String, org.hibernate.sql.JoinType)
using
JoinType.INNER_JOIN
for the joinType.createCriteria
in interface Criteria
associationPath
- A dot-seperated property pathpublic Criteria createCriteria(String associationPath, JoinType joinType)
Criteria
createCriteria
in interface Criteria
associationPath
- A dot-seperated property pathjoinType
- The type of join to use.public Criteria createCriteria(String associationPath, int joinType) throws HibernateException
Criteria
createCriteria
in interface Criteria
associationPath
- A dot-seperated property pathjoinType
- The type of join to use.HibernateException
- Indicates a problem creating the sub criteriapublic Criteria createCriteria(String associationPath, String alias)
Criteria
Criteria.createCriteria(String, String, org.hibernate.sql.JoinType)
using
JoinType.INNER_JOIN
for the joinType.createCriteria
in interface Criteria
associationPath
- A dot-seperated property pathalias
- The alias to assign to the joined association (for later reference).public Criteria createCriteria(String associationPath, String alias, JoinType joinType)
Criteria
createCriteria
in interface Criteria
associationPath
- A dot-seperated property pathalias
- The alias to assign to the joined association (for later reference).joinType
- The type of join to use.public Criteria createCriteria(String associationPath, String alias, int joinType) throws HibernateException
Criteria
createCriteria
in interface Criteria
associationPath
- A dot-seperated property pathalias
- The alias to assign to the joined association (for later reference).joinType
- The type of join to use.HibernateException
- Indicates a problem creating the sub criteriapublic Criteria createCriteria(String associationPath, String alias, JoinType joinType, Criterion withClause)
Criteria
createCriteria
in interface Criteria
associationPath
- A dot-seperated property pathalias
- 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)public Criteria createCriteria(String associationPath, String alias, int joinType, Criterion withClause) throws HibernateException
Criteria
createCriteria
in interface Criteria
associationPath
- A dot-seperated property pathalias
- 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)HibernateException
- Indicates a problem creating the sub criteriapublic ResultTransformer getResultTransformer()
public Criteria setResultTransformer(ResultTransformer tupleMapper)
Criteria
setResultTransformer
in interface Criteria
tupleMapper
- The transformer to applyCriteriaSpecification.ROOT_ENTITY
,
CriteriaSpecification.DISTINCT_ROOT_ENTITY
,
CriteriaSpecification.ALIAS_TO_ENTITY_MAP
,
CriteriaSpecification.PROJECTION
public Integer getMaxResults()
public Criteria setMaxResults(int maxResults)
Criteria
setMaxResults
in interface Criteria
maxResults
- the maximum number of resultspublic Integer getFirstResult()
public Criteria setFirstResult(int firstResult)
Criteria
setFirstResult
in interface Criteria
firstResult
- the first result to retrieve, numbered from 0public Integer getFetchSize()
public Criteria setFetchSize(int fetchSize)
Criteria
setFetchSize
in interface Criteria
fetchSize
- the fetch sizeStatement.setFetchSize(int)
public Integer getTimeout()
public Criteria setTimeout(int timeout)
Criteria
setTimeout
in interface Criteria
timeout
- The timeout value to apply.Statement.setQueryTimeout(int)
public boolean isReadOnlyInitialized()
Criteria
isReadOnlyInitialized
in interface Criteria
Criteria.setReadOnly(boolean)
public boolean isReadOnly()
Criteria
isReadOnly
in interface Criteria
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()
public Criteria setReadOnly(boolean readOnly)
Criteria
setReadOnly
in interface 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 modethis
, for method chainingTo 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.
public boolean getCacheable()
public Criteria setCacheable(boolean cacheable)
Criteria
setCacheable
in interface Criteria
cacheable
- Should the result be considered cacheable; default is
to not cache (false).public String getCacheRegion()
public Criteria setCacheRegion(String cacheRegion)
Criteria
setCacheRegion
in interface Criteria
cacheRegion
- the name of a query cache region, or null
for the default query cacheCriteria.setCacheable(boolean)
public String getComment()
public Criteria setComment(String comment)
Criteria
setComment
in interface Criteria
comment
- a human-readable stringpublic Criteria addQueryHint(String queryHint)
Criteria
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
in interface Criteria
queryHint
- The database specific query hint to add.public Criteria setFlushMode(FlushMode flushMode)
Criteria
setFlushMode
in interface Criteria
flushMode
- The flush mode to use.public Criteria setCacheMode(CacheMode cacheMode)
Criteria
setCacheMode
in interface Criteria
cacheMode
- The cache mode to use.public List list() throws HibernateException
Criteria
list
in interface Criteria
HibernateException
- Indicates a problem either translating the criteria to SQL,
exeucting the SQL or processing the SQL results.public ScrollableResults scroll()
Criteria
ScrollableResults
.scroll
in interface Criteria
ScrollableResults
representing the matched
query results.public ScrollableResults scroll(ScrollMode scrollMode)
Criteria
ScrollableResults
based on the
given scroll mode.scroll
in interface Criteria
scrollMode
- Indicates the type of underlying database cursor to
request.ScrollableResults
representing the matched
query results.public Object uniqueResult() throws HibernateException
Criteria
uniqueResult
in interface Criteria
HibernateException
- if there is more than one matching resultprotected void before()
protected void after()
public boolean isLookupByNaturalKey()
Copyright © 2016 JBoss by Red Hat. All rights reserved.