org.hibernate.impl

Class CriteriaImpl.Subcriteria

Enclosing Class:
CriteriaImpl
Implemented Interfaces:
Criteria, CriteriaSpecification, Serializable

public final class CriteriaImpl.Subcriteria
extends java.lang.Object
implements Criteria, Serializable

Fields inherited from interface org.hibernate.criterion.CriteriaSpecification

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

Method Summary

Criteria
add(Criterion expression)
Add a restriction to constrain the results to be retrieved.
Criteria
addOrder(Order order)
Add an ordering to the result set.
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
createCriteria(String associationPath)
Create a new Criteria, "rooted" at the associated entity.
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, int 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.
int
getJoinType()
LockMode
getLockMode()
Criteria
getParent()
String
getPath()
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.
void
setAlias(String alias)
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
setCacheable(boolean cacheable)
Enable caching of this query result, provided query caching is enabled for the underlying session factory.
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
setResultTransformer(ResultTransformer resultProcessor)
Set a strategy for handling the query results.
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.

Method Details

add

public Criteria add(Criterion expression)
Add a restriction to constrain the results to be retrieved.
Specified by:
add in interface Criteria
Parameters:
Returns:
this (for method chaining)

addOrder

public Criteria addOrder(Order order)
Add an ordering to the result set.
Specified by:
addOrder in interface Criteria
Parameters:
order - The order object representing an ordering to be applied to the results.
Returns:
this (for method chaining)

createAlias

public Criteria createAlias(String associationPath,
                            String alias)
Join an association, assigning an alias to the joined association.

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

Specified by:
createAlias in interface Criteria
Parameters:
associationPath - A dot-seperated property path
alias - The alias to assign to the joined association (for later reference).
Returns:
this (for method chaining)

createAlias

public Criteria createAlias(String associationPath,
                            String alias,
                            int joinType)
            throws HibernateException
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.

Specified by:
createAlias in interface Criteria
Parameters:
associationPath - A dot-seperated property path
alias - The alias to assign to the joined association (for later reference).
joinType - The type of join to use.
Returns:
this (for method chaining)

createCriteria

public Criteria createCriteria(String associationPath)
Create a new Criteria, "rooted" at the associated entity.

Functionally equivalent to Criteria.createCriteria(String,int) using CriteriaSpecification.INNER_JOIN for the joinType.

Specified by:
createCriteria in interface Criteria
Parameters:
associationPath - A dot-seperated property path
Returns:
the created "sub criteria"

createCriteria

public Criteria createCriteria(String associationPath,
                               String alias)
Create a new Criteria, "rooted" at the associated entity, assigning the given alias.

Functionally equivalent to Criteria.createCriteria(String,String,int) using CriteriaSpecification.INNER_JOIN for the joinType.

Specified by:
createCriteria in interface Criteria
Parameters:
associationPath - A dot-seperated property path
alias - The alias to assign to the joined association (for later reference).
Returns:
the created "sub criteria"

createCriteria

public Criteria createCriteria(String associationPath,
                               String alias,
                               int joinType)
            throws HibernateException
Create a new Criteria, "rooted" at the associated entity, assigning the given alias and using the specified join type.
Specified by:
createCriteria in interface Criteria
Parameters:
associationPath - A dot-seperated property path
alias - The alias to assign to the joined association (for later reference).
joinType - The type of join to use.
Returns:
the created "sub criteria"

createCriteria

public Criteria createCriteria(String associationPath,
                               int joinType)
            throws HibernateException
Create a new Criteria, "rooted" at the associated entity, using the specified join type.
Specified by:
createCriteria in interface Criteria
Parameters:
associationPath - A dot-seperated property path
joinType - The type of join to use.
Returns:
the created "sub criteria"

getAlias

public String getAlias()
Get the alias of the entity encapsulated by this criteria instance.
Specified by:
getAlias in interface Criteria
Returns:
The alias for the encapsulated entity.

getJoinType

public int getJoinType()

getLockMode

public LockMode getLockMode()

getParent

public Criteria getParent()

getPath

public String getPath()

list

public List list()
            throws HibernateException
Get the results.
Specified by:
list in interface Criteria
Returns:
The list of matched query results.

scroll

public ScrollableResults scroll()
            throws HibernateException
Get the results as an instance of ScrollableResults
Specified by:
scroll in interface Criteria
Returns:
The ScrollableResults representing the matched query results.

scroll

public ScrollableResults scroll(ScrollMode scrollMode)
            throws HibernateException
Get the results as an instance of ScrollableResults based on the given scroll mode.
Specified by:
scroll in interface Criteria
Parameters:
scrollMode - Indicates the type of underlying database cursor to request.
Returns:
The ScrollableResults representing the matched query results.

setAlias

public void setAlias(String alias)

setCacheMode

public Criteria setCacheMode(CacheMode cacheMode)
Override the cache mode for this particular query.
Specified by:
setCacheMode in interface Criteria
Parameters:
cacheMode - The cache mode to use.
Returns:
this (for method chaining)

setCacheRegion

public Criteria setCacheRegion(String cacheRegion)
Set the name of the cache region to use for query result caching.
Specified by:
setCacheRegion in interface Criteria
Parameters:
cacheRegion - the name of a query cache region, or null for the default query cache
Returns:
this (for method chaining)

setCacheable

public Criteria setCacheable(boolean cacheable)
Enable caching of this query result, provided query caching is enabled for the underlying session factory.
Specified by:
setCacheable in interface Criteria
Parameters:
cacheable - Should the result be considered cacheable; default is to not cache (false).
Returns:
this (for method chaining)

setComment

public Criteria setComment(String comment)
Add a comment to the generated SQL.
Specified by:
setComment in interface Criteria
Parameters:
comment - a human-readable string
Returns:
this (for method chaining)

setFetchMode

public Criteria setFetchMode(String associationPath,
                             FetchMode mode)
            throws HibernateException
Specify an association fetching strategy for an association or a collection of values.
Specified by:
setFetchMode in interface Criteria
Parameters:
associationPath - a dot seperated property path
mode - The fetch mode for the referenced association
Returns:
this (for method chaining)

setFetchSize

public Criteria setFetchSize(int fetchSize)
Set a fetch size for the underlying JDBC query.
Specified by:
setFetchSize in interface Criteria
Parameters:
fetchSize - the fetch size
Returns:
this (for method chaining)
See Also:
java.sql.Statement.setFetchSize

setFirstResult

public Criteria setFirstResult(int firstResult)
Set the first result to be retrieved.
Specified by:
setFirstResult in interface Criteria
Parameters:
firstResult - the first result to retrieve, numbered from 0
Returns:
this (for method chaining)

setFlushMode

public Criteria setFlushMode(FlushMode flushMode)
Override the flush mode for this particular query.
Specified by:
setFlushMode in interface Criteria
Parameters:
flushMode - The flush mode to use.
Returns:
this (for method chaining)

setLockMode

public Criteria setLockMode(String alias,
                            LockMode lockMode)
Set the lock mode of the aliased entity
Specified by:
setLockMode in interface Criteria
Parameters:
alias - The previously assigned alias representing the entity to which the given lock mode should apply.
lockMode - The lock mode to be applied
Returns:
this (for method chaining)

setLockMode

public Criteria setLockMode(LockMode lockMode)
Set the lock mode of the current entity
Specified by:
setLockMode in interface Criteria
Parameters:
lockMode - The lock mode to be applied
Returns:
this (for method chaining)

setMaxResults

public Criteria setMaxResults(int maxResults)
Set a limit upon the number of objects to be retrieved.
Specified by:
setMaxResults in interface Criteria
Parameters:
maxResults - the maximum number of results
Returns:
this (for method chaining)

setProjection

public Criteria setProjection(Projection projection)
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.

Specified by:
setProjection in interface Criteria
Parameters:
projection - The projection representing the overall "shape" of the query results.
Returns:
this (for method chaining)

setResultTransformer

public Criteria setResultTransformer(ResultTransformer resultProcessor)
Set a strategy for handling the query results. This determines the "shape" of the query result.
Specified by:
setResultTransformer in interface Criteria
Parameters:
Returns:
this (for method chaining)

setTimeout

public Criteria setTimeout(int timeout)
Set a timeout for the underlying JDBC query.
Specified by:
setTimeout in interface Criteria
Parameters:
timeout - The timeout value to apply.
Returns:
this (for method chaining)
See Also:
java.sql.Statement.setQueryTimeout

toString

public String toString()

uniqueResult

public Object uniqueResult()
            throws HibernateException
Convenience method to return a single instance that matches the query, or null if the query returns no results.
Specified by:
uniqueResult in interface Criteria
Returns:
the single result or null
Throws:
HibernateException - if there is more than one matching result