org.hibernate.criterion

Class DetachedCriteria

java.lang.Object

org.hibernate.criterion.DetachedCriteria

All Implemented Interfaces:

Serializable, CriteriaSpecification

public class DetachedCriteria
extends Object
implements CriteriaSpecification, Serializable

Models a detached form of a Criteria (not associated with a Session). Some applications need to create criteria queries in "detached mode", where the Hibernate Session is not available. Applications would create a DetachableCriteria to describe the query, and then later associated it with a Session to obtain the "executable" Criteria: DetachedCriteria detached = new DetachedCriteria(); ... Criteria criteria = detached.getExecutableCriteria( session ); ... criteria.list(); All methods have the same semantics and behavior as the corresponding methods of the Criteria interface.

Author:

Gavin King

See Also:

Criteria, Serialized Form

Field Summary

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DetachedCriteria(CriteriaImpl impl, Criteria criteria)
protected	DetachedCriteria(String entityName)
protected	DetachedCriteria(String entityName, String alias)

Method Summary

Modifier and Type	Method and Description
DetachedCriteria	add(Criterion criterion) Add a restriction
DetachedCriteria	addOrder(Order order) Adds an ordering
DetachedCriteria	createAlias(String associationPath, String alias) Creates an association path alias within this DetachedCriteria.
DetachedCriteria	createAlias(String associationPath, String alias, int joinType) Deprecated. use createAlias(String, String, JoinType)
DetachedCriteria	createAlias(String associationPath, String alias, int joinType, Criterion withClause) Deprecated. use createAlias(String, String, JoinType, Criterion)
DetachedCriteria	createAlias(String associationPath, String alias, JoinType joinType) Creates an association path alias within this DetachedCriteria specifying the type of join.
DetachedCriteria	createAlias(String associationPath, String alias, JoinType joinType, Criterion withClause) Creates an association path alias within this DetachedCriteria specifying the type of join.
DetachedCriteria	createCriteria(String associationPath) Creates a nested DetachedCriteria representing the association path.
DetachedCriteria	createCriteria(String associationPath, int joinType) Deprecated. use createCriteria(String, JoinType)
DetachedCriteria	createCriteria(String associationPath, JoinType joinType) Creates a nested DetachedCriteria representing the association path, specifying the type of join to use.
DetachedCriteria	createCriteria(String associationPath, String alias) Creates a nested DetachedCriteria representing the association path.
DetachedCriteria	createCriteria(String associationPath, String alias, int joinType) Deprecated. use createCriteria(String, String, JoinType)
DetachedCriteria	createCriteria(String associationPath, String alias, int joinType, Criterion withClause) Deprecated. use createCriteria(String, String, JoinType, Criterion)
DetachedCriteria	createCriteria(String associationPath, String alias, JoinType joinType) Creates a nested DetachedCriteria representing the association path, specifying the type of join to use.
DetachedCriteria	createCriteria(String associationPath, String alias, JoinType joinType, Criterion withClause) Creates a nested DetachedCriteria representing the association path, specifying the type of join to use and an additional join restriction.
static DetachedCriteria	forClass(Class clazz) Static builder to create a DetachedCriteria for the given entity, by its Class.
static DetachedCriteria	forClass(Class clazz, String alias) Static builder to create a DetachedCriteria for the given entity, by its Class.
static DetachedCriteria	forEntityName(String entityName) Static builder to create a DetachedCriteria for the given entity.
static DetachedCriteria	forEntityName(String entityName, String alias) Static builder to create a DetachedCriteria for the given entity.
String	getAlias() Obtain the alias associated with this DetachedCriteria
Criteria	getExecutableCriteria(Session session) Get an executable instance of Criteria to actually run the query.
DetachedCriteria	setComment(String comment) Set the SQL comment to use.
DetachedCriteria	setFetchMode(String associationPath, FetchMode mode) Set the fetch mode for a given association
DetachedCriteria	setLockMode(LockMode lockMode) Set the lock mode to use.
DetachedCriteria	setLockMode(String alias, LockMode lockMode) Set an alias-specific lock mode.
DetachedCriteria	setProjection(Projection projection) Set the projection to use.
DetachedCriteria	setResultTransformer(ResultTransformer resultTransformer) Set the result transformer to use.
DetachedCriteria	setTimeout(int timeout) Set a timeout for the underlying JDBC query.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DetachedCriteria

protected DetachedCriteria(String entityName)

DetachedCriteria

protected DetachedCriteria(String entityName,
                           String alias)

DetachedCriteria

protected DetachedCriteria(CriteriaImpl impl,
                           Criteria criteria)

Method Detail

getExecutableCriteria

public Criteria getExecutableCriteria(Session session)

Get an executable instance of Criteria to actually run the query.

Parameters:

session - The session to associate the built Criteria with

Returns:

The "executable" Criteria

getAlias

public String getAlias()

Obtain the alias associated with this DetachedCriteria

Returns:

The alias

forEntityName

public static DetachedCriteria forEntityName(String entityName)

Static builder to create a DetachedCriteria for the given entity.

Parameters:

entityName - The name of the entity to create a DetachedCriteria for

Returns:

The DetachedCriteria

forEntityName

public static DetachedCriteria forEntityName(String entityName,
                                             String alias)

Static builder to create a DetachedCriteria for the given entity.

Parameters:

entityName - The name of the entity to create a DetachedCriteria for

alias - The alias to apply to the entity

Returns:

The DetachedCriteria

forClass

public static DetachedCriteria forClass(Class clazz)

Static builder to create a DetachedCriteria for the given entity, by its Class.

Parameters:

clazz - The entity class

Returns:

The DetachedCriteria

forClass

public static DetachedCriteria forClass(Class clazz,
                                        String alias)

Static builder to create a DetachedCriteria for the given entity, by its Class.

Parameters:

clazz - The entity class

alias - The alias to apply to the entity

Returns:

The DetachedCriteria

add

public DetachedCriteria add(Criterion criterion)

Add a restriction

Parameters:

criterion - The restriction

Returns:

this, for method chaining

addOrder

public DetachedCriteria addOrder(Order order)

Adds an ordering

Parameters:

order - The ordering

Returns:

this, for method chaining

setFetchMode

public DetachedCriteria setFetchMode(String associationPath,
                                     FetchMode mode)

Set the fetch mode for a given association

Parameters:

associationPath - The association path

mode - The fetch mode to apply

Returns:

this, for method chaining

setProjection

public DetachedCriteria setProjection(Projection projection)

Set the projection to use.

Parameters:

projection - The projection to use

Returns:

this, for method chaining

setResultTransformer

public DetachedCriteria setResultTransformer(ResultTransformer resultTransformer)

Set the result transformer to use.

Parameters:

resultTransformer - The result transformer to use

Returns:

this, for method chaining

createAlias

public DetachedCriteria createAlias(String associationPath,
                                    String alias)

Creates an association path alias within this DetachedCriteria. The alias can then be used in further alias creations or restrictions, etc.

Parameters:

associationPath - The association path

alias - The alias to apply to that association path

Returns:

this, for method chaining

createAlias

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

Creates an association path alias within this DetachedCriteria specifying the type of join. The alias can then be used in further alias creations or restrictions, etc.

Parameters:

associationPath - The association path

alias - The alias to apply to that association path

joinType - The type of join to use

Returns:

this, for method chaining

createAlias

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

Creates an association path alias within this DetachedCriteria specifying the type of join. The alias can then be used in further alias creations or restrictions, etc.

Parameters:

associationPath - The association path

alias - The alias to apply to that association path

joinType - The type of join to use

withClause - An additional restriction on the join

Returns:

this, for method chaining

createAlias

@Deprecated
public DetachedCriteria createAlias(String associationPath,
                                                String alias,
                                                int joinType)

Deprecated. use createAlias(String, String, JoinType)

Deprecated!

Parameters:

associationPath - The association path

alias - The alias to apply to that association path

joinType - The type of join to use

Returns:

this, for method chaining

createAlias

@Deprecated
public DetachedCriteria createAlias(String associationPath,
                                                String alias,
                                                int joinType,
                                                Criterion withClause)

Deprecated. use createAlias(String, String, JoinType, Criterion)

Deprecated!

Parameters:

associationPath - The association path

alias - The alias to apply to that association path

joinType - The type of join to use

withClause - An additional restriction on the join

Returns:

this, for method chaining

createCriteria

public DetachedCriteria createCriteria(String associationPath,
                                       String alias)

Creates a nested DetachedCriteria representing the association path.

Parameters:

associationPath - The association path

alias - The alias to apply to that association path

Returns:

the newly created, nested DetachedCriteria

createCriteria

public DetachedCriteria createCriteria(String associationPath)

Creates a nested DetachedCriteria representing the association path.

Parameters:

associationPath - The association path

Returns:

the newly created, nested DetachedCriteria

createCriteria

public DetachedCriteria createCriteria(String associationPath,
                                       JoinType joinType)

Creates a nested DetachedCriteria representing the association path, specifying the type of join to use.

Parameters:

associationPath - The association path

joinType - The type of join to use

Returns:

the newly created, nested DetachedCriteria

createCriteria

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

Creates a nested DetachedCriteria representing the association path, specifying the type of join to use.

Parameters:

associationPath - The association path

alias - The alias to associate with this "join".

joinType - The type of join to use

Returns:

the newly created, nested DetachedCriteria

createCriteria

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

Creates a nested DetachedCriteria representing the association path, specifying the type of join to use and an additional join restriction.

Parameters:

associationPath - The association path

alias - The alias to associate with this "join".

joinType - The type of join to use

withClause - The additional join restriction

Returns:

the newly created, nested DetachedCriteria

createCriteria

@Deprecated
public DetachedCriteria createCriteria(String associationPath,
                                                   int joinType)

Deprecated. use createCriteria(String, JoinType)

Deprecated!

Parameters:

associationPath - The association path

joinType - The type of join to use

Returns:

the newly created, nested DetachedCriteria

createCriteria

@Deprecated
public DetachedCriteria createCriteria(String associationPath,
                                                   String alias,
                                                   int joinType)

Deprecated. use createCriteria(String, String, JoinType)

Deprecated!

Parameters:

associationPath - The association path

alias - The alias

joinType - The type of join to use

Returns:

the newly created, nested DetachedCriteria

createCriteria

@Deprecated
public DetachedCriteria createCriteria(String associationPath,
                                                   String alias,
                                                   int joinType,
                                                   Criterion withClause)

Deprecated. use createCriteria(String, String, JoinType, Criterion)

Deprecated!

Parameters:

associationPath - The association path

alias - The alias to associate with this "join".

joinType - The type of join to use

withClause - The additional join restriction

Returns:

the newly created, nested DetachedCriteria

setComment

public DetachedCriteria setComment(String comment)

Set the SQL comment to use.

Parameters:

comment - The SQL comment to use

Returns:

this, for method chaining

setLockMode

public DetachedCriteria setLockMode(LockMode lockMode)

Set the lock mode to use.

Parameters:

lockMode - The lock mode to use

Returns:

this, for method chaining

setLockMode

public DetachedCriteria setLockMode(String alias,
                                    LockMode lockMode)

Set an alias-specific lock mode. The specified lock mode applies only to that alias.

Parameters:

alias - The alias to apply the lock to

lockMode - The lock mode to use.

Returns:

this, for method chaining

setTimeout

public DetachedCriteria setTimeout(int timeout)

Set a timeout for the underlying JDBC query.

Parameters:

timeout - The timeout value to apply.

Returns:

this (for method chaining)

See Also:

Statement.setQueryTimeout(int)

toString

public String toString()

Overrides:

toString in class Object