Package org.hibernate.envers.query.criteria

Class AuditProperty<T>

java.lang.Object

org.hibernate.envers.query.criteria.AuditProperty<T>

All Implemented Interfaces:

AuditProjection

Direct Known Subclasses:

AuditId

public class AuditProperty<T>
extends Object
implements AuditProjection

Create restrictions, projections and specify order for a property of an audited entity.

Constructor Summary

Constructors

Constructor	Description
AuditProperty(String alias, PropertyNameGetter propertyNameGetter)

Method Summary

Modifier and Type	Method	Description
void	addProjectionToQuery(EnversService enversService, AuditReaderImplementor auditReader, Map<String,String> aliasToEntityNameMap, Map<String,String> aliasToComponentPropertyNameMap, String baseAlias, QueryBuilder queryBuilder)	Adds an audit projection to the specified query.
AuditOrder	asc()	Sort the results by the property in ascending order
AuditCriterion	between(T lo, T hi)	Apply a "between" constraint
Object	convertQueryResult(EnversService enversService, EntityInstantiator entityInstantiator, String entityName, Number revision, Object value)
AuditProjection	count()	Projection counting the values
AuditProjection	countDistinct()	Projection counting distinct values
AuditOrder	desc()	Sort the results by the property in descending order
AuditProjection	distinct()	Projection on distinct values
AuditCriterion	eq(T value)	Apply an "equal" constraint
AuditCriterion	eqFunction(AuditFunction otherFunction)	Apply an "equal" constraint to a function
AuditCriterion	eqProperty(String otherPropertyName)	Apply an "equal" constraint to another property
AuditCriterion	eqProperty(String otherAlias, String otherPropertyName)	Apply an "equal" constraint to another property
AuditProjection	function(String functionName)	Projection using a custom function
AuditCriterion	ge(T value)	Apply a "greater than or equal" constraint
AuditCriterion	geFunction(AuditFunction otherFunction)	Apply a "greater than or equal" constraint to a function
AuditCriterion	geProperty(String otherPropertyName)	Apply a "greater than or equal" constraint to another property
AuditCriterion	geProperty(String otherAlias, String otherPropertyName)	Apply a "greater than or equal" constraint to another property
String	getAlias(String baseAlias)	Get the alias associated with the audit projection.
PropertyNameGetter	getPropertyNameGetter()
AuditCriterion	gt(T value)	Apply a "greater than" constraint
AuditCriterion	gtFunction(AuditFunction otherFunction)	Apply a "greater than" constraint to a function
AuditCriterion	gtProperty(String otherPropertyName)	Apply a "greater than" constraint to another property
AuditCriterion	gtProperty(String otherAlias, String otherPropertyName)	Apply a "greater than" constraint to another property
AuditCriterion	hasChanged()
AuditCriterion	hasNotChanged()
AuditCriterion	ilike(String value, MatchMode matchMode)	Apply on "ilike" constraint
AuditCriterion	ilike(T value)	Apply an "ilike" constraint
AuditCriterion	in(Collection values)	Apply an "in" constraint
AuditCriterion	in(T[] values)	Apply an "in" constraint
AuditCriterion	isNotNull()	Apply an "is not null" constraint to the another property
AuditCriterion	isNull()	Apply an "is null" constraint
AuditCriterion	le(T value)	Apply a "less than or equal" constraint
AuditCriterion	leFunction(AuditFunction otherFunction)	Apply a "less than or equal" constraint to a function
AuditCriterion	leProperty(String otherPropertyName)	Apply a "less than or equal" constraint to another property
AuditCriterion	leProperty(String otherAlias, String otherPropertyName)	Apply a "less than or equal" constraint to another property
AuditCriterion	like(String value, MatchMode matchMode)	Apply a "like" constraint
AuditCriterion	like(T value)	Apply a "like" constraint
AuditCriterion	lt(T value)	Apply a "less than" constraint
AuditCriterion	ltFunction(AuditFunction otherFunction)	Apply a "less than" constraint to a function
AuditCriterion	ltProperty(String otherPropertyName)	Apply a "less than" constraint to another property
AuditCriterion	ltProperty(String otherAlias, String otherPropertyName)	Apply a "less than" constraint to another property
AuditProjection	max()	Projection on the maximum value
AggregatedAuditExpression	maximize()	Apply a "maximalize" constraint, with the ability to specify further constraints on the maximized property
AuditProjection	min()	Projection on the minimum value
AggregatedAuditExpression	minimize()	Apply a "minimize" constraint, with the ability to specify further constraints on the minimized property
AuditCriterion	ne(T value)	Apply a "not equal" constraint
AuditCriterion	neFunction(AuditFunction otherFunction)	Apply a "not equal" constraint to a function
AuditCriterion	neProperty(String otherPropertyName)	Apply a "not equal" constraint to another property
AuditCriterion	neProperty(String otherAlias, String otherPropertyName)	Apply a "not equal" constraint to another property

Methods inherited from class java.lang.Object

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

Constructor Details

AuditProperty

public AuditProperty(String alias,
 PropertyNameGetter propertyNameGetter)

Method Details

getAlias

public String getAlias(String baseAlias)

Description copied from interface: AuditProjection

Get the alias associated with the audit projection.

Specified by:

getAlias in interface AuditProjection

Parameters:

baseAlias - the base alias if one exists; may be null

Returns:

the alias

getPropertyNameGetter

public PropertyNameGetter getPropertyNameGetter()

hasChanged

public AuditCriterion hasChanged()

hasNotChanged

public AuditCriterion hasNotChanged()

eq

public AuditCriterion eq(T value)

Apply an "equal" constraint

ne

public AuditCriterion ne(T value)

Apply a "not equal" constraint

like

public AuditCriterion like(T value)

Apply a "like" constraint

like

public AuditCriterion like(String value,
 MatchMode matchMode)

Apply a "like" constraint

ilike

public AuditCriterion ilike(T value)

Apply an "ilike" constraint

ilike

public AuditCriterion ilike(String value,
 MatchMode matchMode)

Apply on "ilike" constraint

gt

public AuditCriterion gt(T value)

Apply a "greater than" constraint

lt

public AuditCriterion lt(T value)

Apply a "less than" constraint

le

public AuditCriterion le(T value)

Apply a "less than or equal" constraint

ge

public AuditCriterion ge(T value)

Apply a "greater than or equal" constraint

between

public AuditCriterion between(T lo,
 T hi)

Apply a "between" constraint

in

public AuditCriterion in(T[] values)

Apply an "in" constraint

in

public AuditCriterion in(Collection values)

Apply an "in" constraint

isNull

public AuditCriterion isNull()

Apply an "is null" constraint

eqProperty

public AuditCriterion eqProperty(String otherPropertyName)

Apply an "equal" constraint to another property

eqProperty

public AuditCriterion eqProperty(String otherAlias,
 String otherPropertyName)

Apply an "equal" constraint to another property

Parameters:

otherAlias - the alias of the entity which owns the other property.

neProperty

public AuditCriterion neProperty(String otherPropertyName)

Apply a "not equal" constraint to another property

neProperty

public AuditCriterion neProperty(String otherAlias,
 String otherPropertyName)

Apply a "not equal" constraint to another property

Parameters:

otherAlias - the alias of the entity which owns the other property.

ltProperty

public AuditCriterion ltProperty(String otherPropertyName)

Apply a "less than" constraint to another property

ltProperty

public AuditCriterion ltProperty(String otherAlias,
 String otherPropertyName)

Apply a "less than" constraint to another property

Parameters:

otherAlias - the alias of the entity which owns the other property.

leProperty

public AuditCriterion leProperty(String otherPropertyName)

Apply a "less than or equal" constraint to another property

leProperty

public AuditCriterion leProperty(String otherAlias,
 String otherPropertyName)

Apply a "less than or equal" constraint to another property

Parameters:

otherAlias - the alias of the entity which owns the other property.

gtProperty

public AuditCriterion gtProperty(String otherPropertyName)

Apply a "greater than" constraint to another property

gtProperty

public AuditCriterion gtProperty(String otherAlias,
 String otherPropertyName)

Apply a "greater than" constraint to another property

Parameters:

otherAlias - the alias of the entity which owns the other property.

geProperty

public AuditCriterion geProperty(String otherPropertyName)

Apply a "greater than or equal" constraint to another property

geProperty

public AuditCriterion geProperty(String otherAlias,
 String otherPropertyName)

Apply a "greater than or equal" constraint to another property

Parameters:

otherAlias - the alias of the entity which owns the other property.

eqFunction

public AuditCriterion eqFunction(AuditFunction otherFunction)

Apply an "equal" constraint to a function

neFunction

public AuditCriterion neFunction(AuditFunction otherFunction)

Apply a "not equal" constraint to a function

ltFunction

public AuditCriterion ltFunction(AuditFunction otherFunction)

Apply a "less than" constraint to a function

leFunction

public AuditCriterion leFunction(AuditFunction otherFunction)

Apply a "less than or equal" constraint to a function

gtFunction

public AuditCriterion gtFunction(AuditFunction otherFunction)

Apply a "greater than" constraint to a function

geFunction

public AuditCriterion geFunction(AuditFunction otherFunction)

Apply a "greater than or equal" constraint to a function

isNotNull

public AuditCriterion isNotNull()

Apply an "is not null" constraint to the another property

maximize

public AggregatedAuditExpression maximize()

Apply a "maximalize" constraint, with the ability to specify further constraints on the maximized property

minimize

public AggregatedAuditExpression minimize()

Apply a "minimize" constraint, with the ability to specify further constraints on the minimized property

max

public AuditProjection max()

Projection on the maximum value

min

public AuditProjection min()

Projection on the minimum value

count

public AuditProjection count()

Projection counting the values

countDistinct

public AuditProjection countDistinct()

Projection counting distinct values

distinct

public AuditProjection distinct()

Projection on distinct values

function

public AuditProjection function(String functionName)

Projection using a custom function

addProjectionToQuery

public void addProjectionToQuery(EnversService enversService,
 AuditReaderImplementor auditReader,
 Map<String,String> aliasToEntityNameMap,
 Map<String,String> aliasToComponentPropertyNameMap,
 String baseAlias,
 QueryBuilder queryBuilder)

Description copied from interface: AuditProjection

Adds an audit projection to the specified query.

Specified by:

addProjectionToQuery in interface AuditProjection

Parameters:

enversService - the Envers service

auditReader - the audit reader implementor

aliasToEntityNameMap - the entity name alias map

baseAlias - the base alias, if one is specified; may be null

queryBuilder - the query builder

asc

public AuditOrder asc()

Sort the results by the property in ascending order

desc

public AuditOrder desc()

Sort the results by the property in descending order

convertQueryResult

public Object convertQueryResult(EnversService enversService,
 EntityInstantiator entityInstantiator,
 String entityName,
 Number revision,
 Object value)

Specified by:

convertQueryResult in interface AuditProjection

Parameters:

enversService - the Envers service

entityInstantiator - the entity instantiator

entityName - the name of the entity for which the projection has been added

revision - the revision

value - the value to convert

Returns:

the converted value