Package org.hibernate.envers.query.internal.impl

Class AbstractAuditQuery

java.lang.Object

org.hibernate.envers.query.internal.impl.AbstractAuditQuery

All Implemented Interfaces:

AuditQuery

Direct Known Subclasses:

EntitiesAtRevisionQuery, EntitiesModifiedAtRevisionQuery, RevisionsOfEntityQuery

public abstract class AbstractAuditQuery
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	aliasToComponentPropertyNameMap
protected Map<String,String>	aliasToEntityNameMap
protected List<AbstractAuditAssociationQuery<?>>	associationQueries
protected Map<String,AbstractAuditAssociationQuery<org.hibernate.envers.query.internal.impl.AuditQueryImplementor>>	associationQueryMap
protected List<AuditCriterion>	criterions
protected String	entityClassName
protected EntityInstantiator	entityInstantiator
protected String	entityName
protected EnversService	enversService
protected boolean	hasOrder
protected List<Pair<String,AuditProjection>>	projections
protected QueryBuilder	qb
protected String	versionsEntityName
protected AuditReaderImplementor	versionsReader

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAuditQuery(EnversService enversService, AuditReaderImplementor versionsReader, Class<?> cls)
protected	AbstractAuditQuery(EnversService enversService, AuditReaderImplementor versionsReader, Class<?> cls, String entityName)

Method Summary

Modifier and Type	Method	Description
AuditQuery	add(AuditCriterion criterion)
protected void	addAssociationQuery(String associationName, AbstractAuditAssociationQuery<org.hibernate.envers.query.internal.impl.AuditQueryImplementor> query)
AuditQuery	addOrder(AuditOrder order)
AuditQuery	addProjection(AuditProjection projection)
protected List	applyProjections(List queryResult, Number revision)
protected List	buildAndExecuteQuery()
protected Query	buildQuery()
String	getAlias()
protected EntityConfiguration	getEntityConfiguration()
protected String	getEntityName()
List	getResultList()
Object	getSingleResult()
protected boolean	hasProjection()
abstract List	list()
void	registerProjection(String entityName, AuditProjection projection)
AuditQuery	setCacheable(boolean cacheable)
AuditQuery	setCacheMode(CacheMode cacheMode)
AuditQuery	setCacheRegion(String cacheRegion)
AuditQuery	setComment(String comment)
AuditQuery	setFirstResult(int firstResult)
AuditQuery	setFlushMode(FlushMode flushMode)
AuditQuery	setLockMode(LockMode lockMode)	Deprecated. Instead use setLockOptions
AuditQuery	setLockOptions(LockOptions lockOptions)	Set lock options
AuditQuery	setMaxResults(int maxResults)
protected void	setQueryProperties(Query query)
AuditQuery	setTimeout(int timeout)
AuditAssociationQuery<? extends AuditQuery>	traverseRelation(String associationName, jakarta.persistence.criteria.JoinType joinType)
AuditAssociationQuery<? extends AuditQuery>	traverseRelation(String associationName, jakarta.persistence.criteria.JoinType joinType, String alias)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.envers.query.AuditQuery

traverseRelation

Field Detail

entityInstantiator

protected EntityInstantiator entityInstantiator

criterions

protected List<AuditCriterion> criterions

entityName

protected String entityName

entityClassName

protected String entityClassName

versionsEntityName

protected String versionsEntityName

qb

protected QueryBuilder qb

aliasToEntityNameMap

protected final Map<String,String> aliasToEntityNameMap

aliasToComponentPropertyNameMap

protected final Map<String,String> aliasToComponentPropertyNameMap

hasOrder

protected boolean hasOrder

enversService

protected final EnversService enversService

versionsReader

protected final AuditReaderImplementor versionsReader

associationQueries

protected final List<AbstractAuditAssociationQuery<?>> associationQueries

associationQueryMap

protected final Map<String,AbstractAuditAssociationQuery<org.hibernate.envers.query.internal.impl.AuditQueryImplementor>> associationQueryMap

projections

protected final List<Pair<String,AuditProjection>> projections

Constructor Detail

AbstractAuditQuery

protected AbstractAuditQuery(EnversService enversService,
                             AuditReaderImplementor versionsReader,
                             Class<?> cls)

AbstractAuditQuery

protected AbstractAuditQuery(EnversService enversService,
                             AuditReaderImplementor versionsReader,
                             Class<?> cls,
                             String entityName)

Method Detail

getAlias

public String getAlias()

Specified by:

getAlias in interface AuditQuery

buildQuery

protected Query buildQuery()

buildAndExecuteQuery

protected List buildAndExecuteQuery()

list

public abstract List list()
                   throws AuditException

Throws:

AuditException

getResultList

public List getResultList()
                   throws AuditException

Specified by:

getResultList in interface AuditQuery

Throws:

AuditException

getSingleResult

public Object getSingleResult()
                       throws AuditException,
                              jakarta.persistence.NonUniqueResultException,
                              jakarta.persistence.NoResultException

Specified by:

getSingleResult in interface AuditQuery

Throws:

AuditException

jakarta.persistence.NonUniqueResultException

jakarta.persistence.NoResultException

add

public AuditQuery add(AuditCriterion criterion)

Specified by:

add in interface AuditQuery

addProjection

public AuditQuery addProjection(AuditProjection projection)

Specified by:

addProjection in interface AuditQuery

registerProjection

public void registerProjection(String entityName,
                               AuditProjection projection)

hasProjection

protected boolean hasProjection()

addOrder

public AuditQuery addOrder(AuditOrder order)

Specified by:

addOrder in interface AuditQuery

traverseRelation

public AuditAssociationQuery<? extends AuditQuery> traverseRelation(String associationName,
                                                                    jakarta.persistence.criteria.JoinType joinType)

Specified by:

traverseRelation in interface AuditQuery

traverseRelation

public AuditAssociationQuery<? extends AuditQuery> traverseRelation(String associationName,
                                                                    jakarta.persistence.criteria.JoinType joinType,
                                                                    String alias)

Specified by:

traverseRelation in interface AuditQuery

setMaxResults

public AuditQuery setMaxResults(int maxResults)

Specified by:

setMaxResults in interface AuditQuery

setFirstResult

public AuditQuery setFirstResult(int firstResult)

Specified by:

setFirstResult in interface AuditQuery

setCacheable

public AuditQuery setCacheable(boolean cacheable)

Specified by:

setCacheable in interface AuditQuery

setCacheRegion

public AuditQuery setCacheRegion(String cacheRegion)

Specified by:

setCacheRegion in interface AuditQuery

setComment

public AuditQuery setComment(String comment)

Specified by:

setComment in interface AuditQuery

setFlushMode

public AuditQuery setFlushMode(FlushMode flushMode)

Specified by:

setFlushMode in interface AuditQuery

setCacheMode

public AuditQuery setCacheMode(CacheMode cacheMode)

Specified by:

setCacheMode in interface AuditQuery

setTimeout

public AuditQuery setTimeout(int timeout)

Specified by:

setTimeout in interface AuditQuery

setLockMode

@Deprecated
public AuditQuery setLockMode(LockMode lockMode)

Deprecated.

Instead use setLockOptions

Set lock mode

Specified by:

setLockMode in interface AuditQuery

Parameters:

lockMode - The LockMode used for this query.

Returns:

this object

setLockOptions

public AuditQuery setLockOptions(LockOptions lockOptions)

Set lock options

Parameters:

lockOptions - The @{link LockOptions} used for this query.

Returns:

this object

setQueryProperties

protected void setQueryProperties(Query query)

applyProjections

protected List applyProjections(List queryResult,
                                Number revision)

getEntityConfiguration

protected EntityConfiguration getEntityConfiguration()

getEntityName

protected String getEntityName()

addAssociationQuery

protected void addAssociationQuery(String associationName,
                                   AbstractAuditAssociationQuery<org.hibernate.envers.query.internal.impl.AuditQueryImplementor> query)