Package org.hibernate.envers.query
Class AuditEntity
- java.lang.Object
-
- org.hibernate.envers.query.AuditEntity
-
public class AuditEntity extends Object
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static AuditCriterionand(AuditCriterion lhs, AuditCriterion rhs)Return the conjuction of two criterions.static AuditConjunctionconjunction()Group criterions together in a single conjunction (A and B and C...).static AuditDisjunctiondisjunction()Group criterions together in a single disjunction (A or B or C...).static AuditCriterionentityType(Class<?> type)Adds a restriction for the type of the current entity.static AuditCriterionentityType(String entityName)Adds a restriction for the type of the current entity.static AuditCriterionentityType(String alias, Class<?> type)Adds a restriction for the type of the entity of the specified alias.static AuditCriterionentityType(String alias, String entityName)Adds a restriction for the type of the entity of the specified alias.static AuditFunctionfunction(String function, Object... arguments)Create restrictions or projections using a function.static AuditIdid()static AuditIdid(String alias)static AuditCriterionnot(AuditCriterion expression)Return the negation of a criterion.static AuditCriterionor(AuditCriterion lhs, AuditCriterion rhs)Return the disjuction of two criterions.static AuditProperty<Object>property(String propertyName)Create restrictions, projections and specify order for a property of an audited entity.static AuditProperty<Object>property(String alias, String propertyName)Create restrictions, projections and specify order for a property of an audited entity.static AuditRelatedIdrelatedId(String propertyName)Create restrictions on an id of a related entity.static AuditRelatedIdrelatedId(String alias, String propertyName)Create restrictions on an id of a related entity.static AuditProperty<Number>revisionNumber()Create restrictions, projections and specify order for the revision number, corresponding to an audited entity.static AuditProperty<Number>revisionNumber(String alias)Create restrictions, projections and specify order for the revision number, corresponding to an audited entity.static AuditProperty<Object>revisionProperty(String propertyName)Create restrictions, projections and specify order for a property of the revision entity, corresponding to an audited entity.static AuditProperty<Object>revisionProperty(String alias, String propertyName)Create restrictions, projections and specify order for a property of the revision entity, corresponding to an audited entity.static AuditProperty<RevisionType>revisionType()Create restrictions, projections and specify order for the revision type, corresponding to an audited entity.static AuditProperty<RevisionType>revisionType(String alias)Create restrictions, projections and specify order for the revision type, corresponding to an audited entity.static AuditProjectionselectEntity(boolean distinct)Adds a projection to the current entity itself.
-
-
-
Method Detail
-
id
public static AuditId id()
-
property
public static AuditProperty<Object> property(String propertyName)
Create restrictions, projections and specify order for a property of an audited entity.- Parameters:
propertyName- Name of the property.
-
property
public static AuditProperty<Object> property(String alias, String propertyName)
Create restrictions, projections and specify order for a property of an audited entity.- Parameters:
alias- the alias of the entity which owns the property.propertyName- Name of the property.
-
revisionNumber
public static AuditProperty<Number> revisionNumber()
Create restrictions, projections and specify order for the revision number, corresponding to an audited entity.
-
revisionNumber
public static AuditProperty<Number> revisionNumber(String alias)
Create restrictions, projections and specify order for the revision number, corresponding to an audited entity.- Parameters:
alias- the alias of the entity which owns the revision number.
-
revisionProperty
public static AuditProperty<Object> revisionProperty(String propertyName)
Create restrictions, projections and specify order for a property of the revision entity, corresponding to an audited entity.- Parameters:
propertyName- Name of the property.
-
revisionProperty
public static AuditProperty<Object> revisionProperty(String alias, String propertyName)
Create restrictions, projections and specify order for a property of the revision entity, corresponding to an audited entity.- Parameters:
alias- the alias of the entity which owns the revision property.propertyName- Name of the property.
-
revisionType
public static AuditProperty<RevisionType> revisionType()
Create restrictions, projections and specify order for the revision type, corresponding to an audited entity.
-
revisionType
public static AuditProperty<RevisionType> revisionType(String alias)
Create restrictions, projections and specify order for the revision type, corresponding to an audited entity.- Parameters:
alias- the alias of the entity which owns the revision type.
-
relatedId
public static AuditRelatedId relatedId(String propertyName)
Create restrictions on an id of a related entity.- Parameters:
propertyName- Name of the property, which is the relation.
-
relatedId
public static AuditRelatedId relatedId(String alias, String propertyName)
Create restrictions on an id of a related entity.- Parameters:
alias- the alias of the entity which owns the relation property.propertyName- Name of the property, which is the relation.
-
and
public static AuditCriterion and(AuditCriterion lhs, AuditCriterion rhs)
Return the conjuction of two criterions.
-
or
public static AuditCriterion or(AuditCriterion lhs, AuditCriterion rhs)
Return the disjuction of two criterions.
-
not
public static AuditCriterion not(AuditCriterion expression)
Return the negation of a criterion.
-
conjunction
public static AuditConjunction conjunction()
Group criterions together in a single conjunction (A and B and C...).
-
disjunction
public static AuditDisjunction disjunction()
Group criterions together in a single disjunction (A or B or C...).
-
selectEntity
public static AuditProjection selectEntity(boolean distinct)
Adds a projection to the current entity itself. Useful for selecting entities which are reached through associations within the query.- Parameters:
distinct- whether to distinct select the entity
-
function
public static AuditFunction function(String function, Object... arguments)
Create restrictions or projections using a function.Examples:
- AuditEntity.function("upper", AuditEntity.property("prop"))
- AuditEntity.function("substring", AuditEntity.property("prop"), 3, 2)
- AuditEntity.function("concat", AuditEntity.function("upper", AuditEntity.property("prop1")), AuditEntity.function("substring", AuditEntity.property("prop2"), 1, 2))
- Parameters:
function- the name of the functionarguments- the arguments of the function. A function argument can either be- a primitive value like a Number or a String
- an AuditProperty (see
property(String)) - an other AuditFunction
- Returns:
-
entityType
public static AuditCriterion entityType(Class<?> type)
Adds a restriction for the type of the current entity.- Parameters:
type- the entity type to restrict the current alias to
-
entityType
public static AuditCriterion entityType(String entityName)
Adds a restriction for the type of the current entity.- Parameters:
entityName- the entity name to restrict the current alias to
-
entityType
public static AuditCriterion entityType(String alias, Class<?> type)
Adds a restriction for the type of the entity of the specified alias.- Parameters:
alias- the alias to restrict. If null is specified, the current alias is usedtype- the entity type to restrict the alias to
-
entityType
public static AuditCriterion entityType(String alias, String entityName)
Adds a restriction for the type of the entity of the specified alias.- Parameters:
alias- the alias to restrict. If null is specified, the current alias is usedentityName- the entity name to restrict the alias to- Returns:
-
-