org.hibernate.criterion

Class NaturalIdentifier

java.lang.Object

org.hibernate.criterion.NaturalIdentifier

All Implemented Interfaces:

Serializable, Criterion

public class NaturalIdentifier
extends Object
implements Criterion

An expression pertaining to an entity's defined natural identifier

Author:

Gavin King

See Also:

Session.byNaturalId(Class), Session.byNaturalId(String), Session.bySimpleNaturalId(Class), Session.bySimpleNaturalId(String), Serialized Form

Constructor Summary

Constructors

Constructor and Description
NaturalIdentifier()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getNaturalIdValues() Get a map of set of the natural identifier values set on this criterion (for composite natural identifiers this need not be the full set of properties).
TypedValue[]	getTypedValues(Criteria criteria, CriteriaQuery criteriaQuery) Return typed values for all parameters in the rendered SQL fragment
NaturalIdentifier	set(String property, Object value) Set a natural identifier value for this expression
String	toSqlString(Criteria criteria, CriteriaQuery criteriaQuery) Render the SQL fragment

Methods inherited from class java.lang.Object

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

Constructor Detail

NaturalIdentifier

public NaturalIdentifier()

Method Detail

getTypedValues

public TypedValue[] getTypedValues(Criteria criteria,
                                   CriteriaQuery criteriaQuery)
                            throws HibernateException

Description copied from interface: Criterion

Return typed values for all parameters in the rendered SQL fragment

Specified by:

getTypedValues in interface Criterion

Parameters:

criteria - The local criteria

criteriaQuery - The overal criteria query

Returns:

The types values (for binding)

Throws:

HibernateException - Problem determining types.

toSqlString

public String toSqlString(Criteria criteria,
                          CriteriaQuery criteriaQuery)
                   throws HibernateException

Description copied from interface: Criterion

Render the SQL fragment

Specified by:

toSqlString in interface Criterion

Parameters:

criteria - The local criteria

criteriaQuery - The overal criteria query

Returns:

The generated SQL fragment

Throws:

HibernateException - Problem during rendering.

getNaturalIdValues

public Map<String,Object> getNaturalIdValues()

Get a map of set of the natural identifier values set on this criterion (for composite natural identifiers this need not be the full set of properties).

Returns:

The value map.

set

public NaturalIdentifier set(String property,
                             Object value)

Set a natural identifier value for this expression

Parameters:

property - The specific property name

value - The value to use

Returns:

this, for method chaining