org.hibernate.criterion

Class Property

java.lang.Object

org.hibernate.criterion.SimpleProjection

org.hibernate.criterion.PropertyProjection

org.hibernate.criterion.Property

All Implemented Interfaces:

java.io.Serializable, EnhancedProjection, Projection

public class Property
extends PropertyProjection

A factory for property-specific criterion and projection instances

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Property(java.lang.String propertyName) Constructs a Property.

Method Summary

Modifier and Type	Method and Description
Order	asc() Creates an ascending ordering for this property
AggregateProjection	avg() Creates a property avg projection
Criterion	between(java.lang.Object min, java.lang.Object max) Creates a BETWEEN restriction for this property between the given min and max
CountProjection	count() Creates a property count projection
Order	desc() Creates a descending ordering for this property
Criterion	eq(DetachedCriteria subselect) Creates a sub-query equality expression for this property
SimpleExpression	eq(java.lang.Object value) Creates an equality restriction.
Criterion	eqAll(DetachedCriteria subselect) Creates a equals-all sub-query expression for this property.
Criterion	eqOrIsNull(java.lang.Object value) Creates an equality restriction capable of also rendering as IS NULL if the given value is null
PropertyExpression	eqProperty(Property other) Creates an equality restriction between 2 properties
PropertyExpression	eqProperty(java.lang.String other) Creates an equality restriction between 2 properties
static Property	forName(java.lang.String propertyName) Factory for Property instances.
Criterion	ge(DetachedCriteria subselect) Creates a sub-query greater-than-or-equal-to expression for this property
SimpleExpression	ge(java.lang.Object value) Create a greater-than-or-equal-to restriction based on this property
Criterion	geAll(DetachedCriteria subselect) Creates a greater-than-or-equal-to-all sub-query expression for this property.
PropertyExpression	geProperty(Property other) Creates an greater-than-or-equal-to restriction between 2 properties
PropertyExpression	geProperty(java.lang.String other) Creates an greater-than-or-equal-to restriction between 2 properties
Criterion	geSome(DetachedCriteria subselect) Creates a greater-than-or-equal-to-some sub-query expression for this property.
Property	getProperty(java.lang.String propertyName) Get a component attribute of this property.
PropertyProjection	group() Creates a projection for this property as a group expression
Criterion	gt(DetachedCriteria subselect) Creates a sub-query greater-than expression for this property
SimpleExpression	gt(java.lang.Object value) Create a greater-than restriction based on this property
Criterion	gtAll(DetachedCriteria subselect) Creates a greater-than-all sub-query expression for this property.
PropertyExpression	gtProperty(Property other) Creates an greater-than restriction between 2 properties
PropertyExpression	gtProperty(java.lang.String other) Creates an greater-than restriction between 2 properties
Criterion	gtSome(DetachedCriteria subselect) Creates a greater-than-some sub-query expression for this property.
Criterion	in(java.util.Collection values) Creates an IN restriction for this property based on the given list of literals
Criterion	in(DetachedCriteria subselect) Creates a sub-query IN expression for this property.
Criterion	in(java.lang.Object... values) Creates an IN restriction for this property based on the given list of literals
Criterion	isEmpty() Creates a restriction to check that a collection is empty
Criterion	isNotEmpty() Creates a restriction to check that a collection is not empty
Criterion	isNotNull() Creates a NOT NULL restriction
Criterion	isNull() Creates a NULL restriction
Criterion	le(DetachedCriteria subselect) Creates a sub-query less-than-or-equal-to expression for this property
SimpleExpression	le(java.lang.Object value) Create a less-than-or-equal-to restriction based on this property
Criterion	leAll(DetachedCriteria subselect) Creates a less-than-or-equal-to-all sub-query expression for this property.
PropertyExpression	leProperty(Property other) Creates an less-than-or-equal-to restriction between 2 properties
PropertyExpression	leProperty(java.lang.String other) Creates an less-than-or-equal-to restriction between 2 properties
Criterion	leSome(DetachedCriteria subselect) Creates a less-than-or-equal-to-some sub-query expression for this property.
SimpleExpression	like(java.lang.Object value) Creates a LIKE restriction for this property
SimpleExpression	like(java.lang.String value, MatchMode matchMode) Creates a LIKE restriction for this property
Criterion	lt(DetachedCriteria subselect) Creates a sub-query less-than expression for this property
SimpleExpression	lt(java.lang.Object value) Create a less-than restriction based on this property
Criterion	ltAll(DetachedCriteria subselect) Creates a less-than-all sub-query expression for this property.
PropertyExpression	ltProperty(Property other) Creates an less-than restriction between 2 properties
PropertyExpression	ltProperty(java.lang.String other) Creates an less-than restriction between 2 properties
Criterion	ltSome(DetachedCriteria subselect) Creates a less-than-some sub-query expression for this property.
AggregateProjection	max() Creates a property max projection
AggregateProjection	min() Creates a property min projection
Criterion	ne(DetachedCriteria subselect) Creates a sub-query non-equality expression for this property
SimpleExpression	ne(java.lang.Object value) Creates an non-equality restriction.
Criterion	neOrIsNotNull(java.lang.Object value) Creates an non-equality restriction capable of also rendering as IS NOT NULL if the given value is null
PropertyExpression	neProperty(Property other) Creates an non-equality restriction between 2 properties
PropertyExpression	neProperty(java.lang.String other) Creates an non-equality restriction between 2 properties
Criterion	notIn(DetachedCriteria subselect) Creates a sub-query NOT IN expression for this property.

Methods inherited from class org.hibernate.criterion.PropertyProjection

getPropertyName, getTypes, isGrouped, toGroupSqlString, toSqlString, toString

Methods inherited from class org.hibernate.criterion.SimpleProjection

as, getAliases, getColumnAliases, getColumnAliases, getColumnAliases, getColumnAliases, getColumnCount, getTypes

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

protected Property(java.lang.String propertyName)

Constructs a Property. non-private to allow subclassing.

Parameters:

propertyName - The property name.

Method Detail

forName

public static Property forName(java.lang.String propertyName)

Factory for Property instances.

Parameters:

propertyName - The name of the property.

Returns:

The Property instance

between

public Criterion between(java.lang.Object min,
                         java.lang.Object max)

Creates a BETWEEN restriction for this property between the given min and max

Parameters:

min - The minimum

max - The maximum

Returns:

The BETWEEN restriction

See Also:

Restrictions.between(String, Object, Object)

in

public Criterion in(java.util.Collection values)

Creates an IN restriction for this property based on the given list of literals

Parameters:

values - The literal values

Returns:

The IN restriction

See Also:

Restrictions.in(String, Collection)

in

public Criterion in(java.lang.Object... values)

Creates an IN restriction for this property based on the given list of literals

Parameters:

values - The literal values

Returns:

The IN restriction

See Also:

Restrictions.in(String, Object[])

like

public SimpleExpression like(java.lang.Object value)

Creates a LIKE restriction for this property

Parameters:

value - The value to like compare with

Returns:

The LIKE restriction

See Also:

Restrictions.like(String, Object)

like

public SimpleExpression like(java.lang.String value,
                             MatchMode matchMode)

Creates a LIKE restriction for this property

Parameters:

value - The value to like compare with

matchMode - The match mode to apply to the LIKE

Returns:

The LIKE restriction

See Also:

Restrictions.like(String, String, MatchMode)

eq

public SimpleExpression eq(java.lang.Object value)

Creates an equality restriction.

Parameters:

value - The value to check against

Returns:

The equality restriction.

See Also:

Restrictions.eq(String, Object)

eqOrIsNull

public Criterion eqOrIsNull(java.lang.Object value)

Creates an equality restriction capable of also rendering as IS NULL if the given value is null

Parameters:

value - The value to check against

Returns:

The equality restriction.

See Also:

Restrictions.eqOrIsNull(String, Object), eq(java.lang.Object), isNull()

ne

public SimpleExpression ne(java.lang.Object value)

Creates an non-equality restriction.

Parameters:

value - The value to check against

Returns:

The non-equality restriction.

See Also:

Restrictions.ne(String, Object)

neOrIsNotNull

public Criterion neOrIsNotNull(java.lang.Object value)

Creates an non-equality restriction capable of also rendering as IS NOT NULL if the given value is null

Parameters:

value - The value to check against

Returns:

The non-equality restriction.

See Also:

Restrictions.neOrIsNotNull(String, Object), ne(java.lang.Object), isNotNull()

gt

public SimpleExpression gt(java.lang.Object value)

Create a greater-than restriction based on this property

Parameters:

value - The value to check against

Returns:

The greater-than restriction

See Also:

Restrictions.gt(String, Object)

lt

public SimpleExpression lt(java.lang.Object value)

Create a less-than restriction based on this property

Parameters:

value - The value to check against

Returns:

The less-than restriction

See Also:

Restrictions.lt(String, Object)

le

public SimpleExpression le(java.lang.Object value)

Create a less-than-or-equal-to restriction based on this property

Parameters:

value - The value to check against

Returns:

The less-than-or-equal-to restriction

See Also:

Restrictions.le(String, Object)

ge

public SimpleExpression ge(java.lang.Object value)

Create a greater-than-or-equal-to restriction based on this property

Parameters:

value - The value to check against

Returns:

The greater-than-or-equal-to restriction

See Also:

Restrictions.ge(String, Object)

eqProperty

public PropertyExpression eqProperty(Property other)

Creates an equality restriction between 2 properties

Parameters:

other - The other property to compare against

Returns:

The restriction

See Also:

Restrictions.eqProperty(String, String)

eqProperty

public PropertyExpression eqProperty(java.lang.String other)

Creates an equality restriction between 2 properties

Parameters:

other - The other property to compare against

Returns:

The restriction

See Also:

Restrictions.eqProperty(String, String)

neProperty

public PropertyExpression neProperty(Property other)

Creates an non-equality restriction between 2 properties

Parameters:

other - The other property to compare against

Returns:

The restriction

See Also:

Restrictions.neProperty(String, String)

neProperty

public PropertyExpression neProperty(java.lang.String other)

Creates an non-equality restriction between 2 properties

Parameters:

other - The other property to compare against

Returns:

The restriction

See Also:

Restrictions.neProperty(String, String)

leProperty

public PropertyExpression leProperty(Property other)

Creates an less-than-or-equal-to restriction between 2 properties

Parameters:

other - The other property to compare against

Returns:

The restriction

See Also:

Restrictions.leProperty(String, String)

leProperty

public PropertyExpression leProperty(java.lang.String other)

Creates an less-than-or-equal-to restriction between 2 properties

Parameters:

other - The other property to compare against

Returns:

The restriction

See Also:

Restrictions.leProperty(String, String)

geProperty

public PropertyExpression geProperty(Property other)

Creates an greater-than-or-equal-to restriction between 2 properties

Parameters:

other - The other property to compare against

Returns:

The restriction

See Also:

Restrictions.geProperty(String, String)

geProperty

public PropertyExpression geProperty(java.lang.String other)

Creates an greater-than-or-equal-to restriction between 2 properties

Parameters:

other - The other property to compare against

Returns:

The restriction

See Also:

Restrictions.geProperty(String, String)

ltProperty

public PropertyExpression ltProperty(Property other)

Creates an less-than restriction between 2 properties

Parameters:

other - The other property to compare against

Returns:

The restriction

See Also:

Restrictions.ltProperty(String, String)

ltProperty

public PropertyExpression ltProperty(java.lang.String other)

Creates an less-than restriction between 2 properties

Parameters:

other - The other property to compare against

Returns:

The restriction

See Also:

Restrictions.ltProperty(String, String)

gtProperty

public PropertyExpression gtProperty(Property other)

Creates an greater-than restriction between 2 properties

Parameters:

other - The other property to compare against

Returns:

The restriction

See Also:

Restrictions.geProperty(String, String)

gtProperty

public PropertyExpression gtProperty(java.lang.String other)

Creates an greater-than restriction between 2 properties

Parameters:

other - The other property to compare against

Returns:

The restriction

See Also:

Restrictions.geProperty(String, String)

isNull

public Criterion isNull()

Creates a NULL restriction

Returns:

The restriction

See Also:

Restrictions.isNull(String)

isNotNull

public Criterion isNotNull()

Creates a NOT NULL restriction

Returns:

The restriction

See Also:

Restrictions.isNotNull(String)

isEmpty

public Criterion isEmpty()

Creates a restriction to check that a collection is empty

Returns:

The restriction

See Also:

Restrictions.isEmpty(String)

isNotEmpty

public Criterion isNotEmpty()

Creates a restriction to check that a collection is not empty

Returns:

The restriction

See Also:

Restrictions.isNotEmpty(String)

count

public CountProjection count()

Creates a property count projection

Returns:

The projection

See Also:

Projections.count(java.lang.String)

max

public AggregateProjection max()

Creates a property max projection

Returns:

The projection

See Also:

Projections.max(java.lang.String)

min

public AggregateProjection min()

Creates a property min projection

Returns:

The projection

See Also:

Projections.min(java.lang.String)

avg

public AggregateProjection avg()

Creates a property avg projection

Returns:

The projection

See Also:

Projections.avg(java.lang.String)

group

public PropertyProjection group()

Creates a projection for this property as a group expression

Returns:

The group projection

See Also:

Projections.groupProperty(java.lang.String)

asc

public Order asc()

Creates an ascending ordering for this property

Returns:

The order

desc

public Order desc()

Creates a descending ordering for this property

Returns:

The order

getProperty

public Property getProperty(java.lang.String propertyName)

Get a component attribute of this property.

Parameters:

propertyName - The sub property name

Returns:

The property

eq

public Criterion eq(DetachedCriteria subselect)

Creates a sub-query equality expression for this property

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyEq(String, DetachedCriteria)

ne

public Criterion ne(DetachedCriteria subselect)

Creates a sub-query non-equality expression for this property

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyNe(String, DetachedCriteria)

lt

public Criterion lt(DetachedCriteria subselect)

Creates a sub-query less-than expression for this property

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyLt(String, DetachedCriteria)

le

public Criterion le(DetachedCriteria subselect)

Creates a sub-query less-than-or-equal-to expression for this property

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyLe(String, DetachedCriteria)

gt

public Criterion gt(DetachedCriteria subselect)

Creates a sub-query greater-than expression for this property

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyGt(String, DetachedCriteria)

ge

public Criterion ge(DetachedCriteria subselect)

Creates a sub-query greater-than-or-equal-to expression for this property

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyGe(String, DetachedCriteria)

notIn

public Criterion notIn(DetachedCriteria subselect)

Creates a sub-query NOT IN expression for this property. I.e., [prop] NOT IN [subquery]

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyNotIn(String, DetachedCriteria)

in

public Criterion in(DetachedCriteria subselect)

Creates a sub-query IN expression for this property. I.e., [prop] IN [subquery]

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyIn(String, DetachedCriteria)

eqAll

public Criterion eqAll(DetachedCriteria subselect)

Creates a equals-all sub-query expression for this property. I.e., [prop] = ALL [subquery]

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyEqAll(String, DetachedCriteria)

gtAll

public Criterion gtAll(DetachedCriteria subselect)

Creates a greater-than-all sub-query expression for this property. I.e., [prop] > ALL [subquery]

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyGtAll(String, DetachedCriteria)

ltAll

public Criterion ltAll(DetachedCriteria subselect)

Creates a less-than-all sub-query expression for this property. I.e., [prop] < ALL [subquery]

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyLtAll(String, DetachedCriteria)

leAll

public Criterion leAll(DetachedCriteria subselect)

Creates a less-than-or-equal-to-all sub-query expression for this property. I.e., [prop] <= ALL [subquery]

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyLeAll(String, DetachedCriteria)

geAll

public Criterion geAll(DetachedCriteria subselect)

Creates a greater-than-or-equal-to-all sub-query expression for this property. I.e., [prop] >= ALL [subquery]

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyGeAll(String, DetachedCriteria)

gtSome

public Criterion gtSome(DetachedCriteria subselect)

Creates a greater-than-some sub-query expression for this property. I.e., [prop] > SOME [subquery]

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyGtSome(String, DetachedCriteria)

ltSome

public Criterion ltSome(DetachedCriteria subselect)

Creates a less-than-some sub-query expression for this property. I.e., [prop] < SOME [subquery]

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyLtSome(String, DetachedCriteria)

leSome

public Criterion leSome(DetachedCriteria subselect)

Creates a less-than-or-equal-to-some sub-query expression for this property. I.e., [prop] <= SOME [subquery]

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyLeSome(String, DetachedCriteria)

geSome

public Criterion geSome(DetachedCriteria subselect)

Creates a greater-than-or-equal-to-some sub-query expression for this property. I.e., [prop] >= SOME [subquery]

Parameters:

subselect - The sub-query

Returns:

The expression

See Also:

Subqueries.propertyGeSome(String, DetachedCriteria)