Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.hibernate.envers.query.AuditEntity Maven / Gradle / Ivy
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or .
*/
package org.hibernate.envers.query;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.hibernate.envers.RevisionType;
import org.hibernate.envers.internal.tools.EntityTools;
import org.hibernate.envers.query.criteria.AuditConjunction;
import org.hibernate.envers.query.criteria.AuditCriterion;
import org.hibernate.envers.query.criteria.AuditDisjunction;
import org.hibernate.envers.query.criteria.AuditFunction;
import org.hibernate.envers.query.criteria.AuditId;
import org.hibernate.envers.query.criteria.AuditProperty;
import org.hibernate.envers.query.criteria.AuditRelatedId;
import org.hibernate.envers.query.criteria.internal.EntityTypeAuditExpression;
import org.hibernate.envers.query.criteria.internal.LogicalAuditExpression;
import org.hibernate.envers.query.criteria.internal.NotAuditExpression;
import org.hibernate.envers.query.internal.property.EntityPropertyName;
import org.hibernate.envers.query.internal.property.RevisionNumberPropertyName;
import org.hibernate.envers.query.internal.property.RevisionPropertyPropertyName;
import org.hibernate.envers.query.internal.property.RevisionTypePropertyName;
import org.hibernate.envers.query.projection.AuditProjection;
import org.hibernate.envers.query.projection.internal.EntityAuditProjection;
/**
* @author Adam Warski (adam at warski dot org)
*/
@SuppressWarnings({"JavaDoc"})
public class AuditEntity {
private AuditEntity() {
}
public static AuditId id() {
return id( null );
}
public static AuditId id(String alias) {
return new AuditId( alias );
}
/**
* Create restrictions, projections and specify order for a property of an audited entity.
*
* @param propertyName Name of the property.
*/
public static AuditProperty property(String propertyName) {
return property( null, propertyName );
}
/**
* Create restrictions, projections and specify order for a property of an audited entity.
*
* @param alias the alias of the entity which owns the property.
* @param propertyName Name of the property.
*/
public static AuditProperty property(String alias, String propertyName) {
return new AuditProperty<>( alias, new EntityPropertyName( propertyName ) );
}
/**
* Create restrictions, projections and specify order for the revision number, corresponding to an
* audited entity.
*/
public static AuditProperty revisionNumber() {
return revisionNumber( null );
}
/**
* Create restrictions, projections and specify order for the revision number, corresponding to an
* audited entity.
*
* @param alias the alias of the entity which owns the revision number.
*/
public static AuditProperty revisionNumber(String alias) {
return new AuditProperty<>( alias, new RevisionNumberPropertyName() );
}
/**
* Create restrictions, projections and specify order for a property of the revision entity,
* corresponding to an audited entity.
*
* @param propertyName Name of the property.
*/
public static AuditProperty revisionProperty(String propertyName) {
return revisionProperty( null, propertyName );
}
/**
* Create restrictions, projections and specify order for a property of the revision entity,
* corresponding to an audited entity.
*
* @param alias the alias of the entity which owns the revision property.
* @param propertyName Name of the property.
*/
public static AuditProperty revisionProperty(String alias, String propertyName) {
return new AuditProperty<>( alias, new RevisionPropertyPropertyName( propertyName ) );
}
/**
* Create restrictions, projections and specify order for the revision type, corresponding to an
* audited entity.
*/
public static AuditProperty revisionType() {
return revisionType( null );
}
/**
* Create restrictions, projections and specify order for the revision type, corresponding to an
* audited entity.
*
* @param alias the alias of the entity which owns the revision type.
*/
public static AuditProperty revisionType(String alias) {
return new AuditProperty<>( alias, new RevisionTypePropertyName() );
}
/**
* Create restrictions on an id of a related entity.
*
* @param propertyName Name of the property, which is the relation.
*/
public static AuditRelatedId relatedId(String propertyName) {
return relatedId( null, propertyName );
}
/**
* Create restrictions on an id of a related entity.
*
* @param alias the alias of the entity which owns the relation property.
* @param propertyName Name of the property, which is the relation.
*/
public static AuditRelatedId relatedId(String alias, String propertyName) {
return new AuditRelatedId( alias, new EntityPropertyName( propertyName ) );
}
/**
* Return the conjuction of two criterions.
*/
public static AuditCriterion and(AuditCriterion lhs, AuditCriterion rhs) {
return new LogicalAuditExpression( lhs, rhs, "and" );
}
/**
* Return the disjuction of two criterions.
*/
public static AuditCriterion or(AuditCriterion lhs, AuditCriterion rhs) {
return new LogicalAuditExpression( lhs, rhs, "or" );
}
/**
* Return the negation of a criterion.
*/
public static AuditCriterion not(AuditCriterion expression) {
return new NotAuditExpression( expression );
}
/**
* Group criterions together in a single conjunction (A and B and C...).
*/
public static AuditConjunction conjunction() {
return new AuditConjunction();
}
/**
* Group criterions together in a single disjunction (A or B or C...).
*/
public static AuditDisjunction disjunction() {
return new AuditDisjunction();
}
/**
* Adds a projection to the current entity itself. Useful for
* selecting entities which are reached through associations within the query.
* @param distinct whether to distinct select the entity
*/
public static AuditProjection selectEntity(boolean distinct) {
return new EntityAuditProjection( null, distinct );
}
/**
* 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))
*
*
* @param function the name of the function
* @param arguments the arguments of the function. A function argument can either be
*
* a primitive value like a Number or a String
* an AuditProperty (see {@link #property(String)})
* an other AuditFunction
*
*/
public static AuditFunction function(final String function, final Object... arguments) {
List argumentList = new ArrayList<>();
Collections.addAll( argumentList, arguments );
return new AuditFunction( function, argumentList );
}
/**
* Adds a restriction for the type of the current entity.
*
* @param type the entity type to restrict the current alias to
*/
public static AuditCriterion entityType(final Class type) {
return entityType( null, type );
}
/**
* Adds a restriction for the type of the current entity.
*
* @param entityName the entity name to restrict the current alias to
*/
public static AuditCriterion entityType(final String entityName) {
return entityType( null, entityName );
}
/**
* Adds a restriction for the type of the entity of the specified alias.
*
* @param alias the alias to restrict. If null is specified, the current alias is used
* @param type the entity type to restrict the alias to
*/
public static AuditCriterion entityType(final String alias, final Class type) {
Class unproxiedType = EntityTools.getTargetClassIfProxied( type );
return entityType( alias, unproxiedType.getName() );
}
/**
* Adds a restriction for the type of the entity of the specified alias.
*
* @param alias the alias to restrict. If null is specified, the current alias is used
* @param entityName the entity name to restrict the alias to
* @return
*/
public static AuditCriterion entityType(final String alias, final String entityName) {
return new EntityTypeAuditExpression( alias, entityName );
}
}
