Skip to content

Commit

Permalink
HHH-3555 - Extend the Envers query system with the ability to travers…
Browse files Browse the repository at this point in the history 
…e associations
  • Loading branch information
@sebersole
sebersole committed Feb 9, 2016
1 parent 83f060b commit c783aab
Show file tree
Hide file tree
Showing 11 changed files with 162 additions and 70 deletions.
9 changes: 7 additions & 2 deletions hibernate-envers/src/main/java/org/hibernate/envers/query/AuditAssociationQuery.java
View file
@@ -1,10 +1,14 @@
/**
*
/*
* 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 <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.envers.query;

import org.hibernate.CacheMode;
import org.hibernate.FlushMode;
import org.hibernate.Incubating;
import org.hibernate.LockMode;
import org.hibernate.envers.query.criteria.AuditCriterion;
import org.hibernate.envers.query.order.AuditOrder;
Expand All @@ -13,6 +17,7 @@
/**
* @author Felix Feisst (feisst dot felix at gmail dot com)
*/
@Incubating
public interface AuditAssociationQuery<Q extends AuditQuery> extends AuditQuery {

@Override
Expand Down
9 changes: 4 additions & 5 deletions ...ate-envers/src/main/java/org/hibernate/envers/query/internal/impl/AbstractAuditQuery.java
View file
Expand Up @@ -10,7 +10,6 @@
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.persistence.NoResultException;
import javax.persistence.NonUniqueResultException;
import javax.persistence.criteria.JoinType;
Expand Down Expand Up @@ -54,8 +53,8 @@ public abstract class AbstractAuditQuery implements AuditQueryImplementor {
protected final EnversService enversService;
protected final AuditReaderImplementor versionsReader;

protected final List<AuditAssociationQueryImplementor<?>> associationQueries = new ArrayList<AuditAssociationQueryImplementor<?>>();
protected final Map<String, AuditAssociationQueryImplementor<AuditQueryImplementor>> associationQueryMap = new HashMap<String, AuditAssociationQueryImplementor<AuditQueryImplementor>>();
protected final List<AuditAssociationQueryImpl<?>> associationQueries = new ArrayList<AuditAssociationQueryImpl<?>>();
protected final Map<String, AuditAssociationQueryImpl<AuditQueryImplementor>> associationQueryMap = new HashMap<String, AuditAssociationQueryImpl<AuditQueryImplementor>>();
protected final List<Pair<String, AuditProjection>> projections = new ArrayList<Pair<String,AuditProjection>>();

protected AbstractAuditQuery(
Expand Down Expand Up @@ -159,9 +158,9 @@ public AuditQuery addOrder(AuditOrder order) {

@Override
public AuditAssociationQuery<? extends AuditQuery> traverseRelation(String associationName, JoinType joinType) {
AuditAssociationQueryImplementor<AuditQueryImplementor> result = associationQueryMap.get( associationName );
AuditAssociationQueryImpl<AuditQueryImplementor> result = associationQueryMap.get( associationName );
if (result == null) {
result = new AuditAssociationQueryImplementor<AuditQueryImplementor>( enversService, versionsReader, this, qb, entityName, associationName, joinType, REFERENCED_ENTITY_ALIAS );
result = new AuditAssociationQueryImpl<AuditQueryImplementor>( enversService, versionsReader, this, qb, entityName, associationName, joinType, REFERENCED_ENTITY_ALIAS );
associationQueries.add( result );
associationQueryMap.put( associationName, result );
}
Expand Down
148 changes: 106 additions & 42 deletions ...mpl/AuditAssociationQueryImplementor.java → ...ernal/impl/AuditAssociationQueryImpl.java
View file
@@ -1,19 +1,22 @@
/**
*
/*
* 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 <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.envers.query.internal.impl;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.persistence.NoResultException;
import javax.persistence.NonUniqueResultException;
import javax.persistence.criteria.JoinType;

import org.hibernate.CacheMode;
import org.hibernate.FlushMode;
import org.hibernate.Incubating;
import org.hibernate.LockMode;
import org.hibernate.envers.boot.internal.EnversService;
import org.hibernate.envers.configuration.internal.AuditEntitiesConfiguration;
Expand All @@ -35,7 +38,9 @@
/**
* @author Felix Feisst (feisst dot felix at gmail dot com)
*/
public class AuditAssociationQueryImplementor<Q extends AuditQueryImplementor> implements AuditAssociationQuery<Q>, AuditQueryImplementor {
@Incubating
public class AuditAssociationQueryImpl<Q extends AuditQueryImplementor>
implements AuditAssociationQuery<Q>, AuditQueryImplementor {

private final EnversService enversService;
private final AuditReaderImplementor auditReader;
Expand All @@ -48,20 +53,31 @@ public class AuditAssociationQueryImplementor<Q extends AuditQueryImplementor> i
private final String alias;
private final List<AuditCriterion> criterions = new ArrayList<AuditCriterion>();
private final Parameters parameters;
private final List<AuditAssociationQueryImplementor<?>> associationQueries = new ArrayList<AuditAssociationQueryImplementor<?>>();
private final Map<String, AuditAssociationQueryImplementor<AuditAssociationQueryImplementor<Q>>> associationQueryMap = new HashMap<String, AuditAssociationQueryImplementor<AuditAssociationQueryImplementor<Q>>>();
private final List<AuditAssociationQueryImpl<?>> associationQueries = new ArrayList<AuditAssociationQueryImpl<?>>();
private final Map<String, AuditAssociationQueryImpl<AuditAssociationQueryImpl<Q>>> associationQueryMap = new HashMap<String, AuditAssociationQueryImpl<AuditAssociationQueryImpl<Q>>>();
private boolean hasProjections;
private boolean hasOrders;

public AuditAssociationQueryImplementor(final EnversService enversService, final AuditReaderImplementor auditReader, final Q parent,
final QueryBuilder queryBuilder, final String ownerEntityName, final String propertyName, final JoinType joinType, final String ownerAlias) {
public AuditAssociationQueryImpl(
final EnversService enversService,
final AuditReaderImplementor auditReader,
final Q parent,
final QueryBuilder queryBuilder,
final String ownerEntityName,
final String propertyName,
final JoinType joinType,
final String ownerAlias) {
this.enversService = enversService;
this.auditReader = auditReader;
this.parent = parent;
this.queryBuilder = queryBuilder;
this.joinType = joinType;

final RelationDescription relationDescription = CriteriaTools.getRelatedEntity( enversService, ownerEntityName, propertyName );
final RelationDescription relationDescription = CriteriaTools.getRelatedEntity(
enversService,
ownerEntityName,
propertyName
);
if ( relationDescription == null ) {
throw new IllegalArgumentException( "Property " + propertyName + " of entity " + ownerEntityName + " is not a valid association for queries" );
}
Expand All @@ -83,92 +99,112 @@ public Object getSingleResult() throws AuditException, NonUniqueResultException,
}

@Override
public AuditAssociationQueryImplementor<AuditAssociationQueryImplementor<Q>> traverseRelation(String associationName, JoinType joinType) {
AuditAssociationQueryImplementor<AuditAssociationQueryImplementor<Q>> result = associationQueryMap.get( associationName );
if (result == null) {
result = new AuditAssociationQueryImplementor<AuditAssociationQueryImplementor<Q>>(
enversService, auditReader, this, queryBuilder, entityName, associationName, joinType, alias );
associationQueries.add( result );
associationQueryMap.put( associationName, result );
public AuditAssociationQueryImpl<AuditAssociationQueryImpl<Q>> traverseRelation(
String associationName,
JoinType joinType) {
AuditAssociationQueryImpl<AuditAssociationQueryImpl<Q>> result = associationQueryMap.get( associationName );
if ( result == null ) {
result = new AuditAssociationQueryImpl<AuditAssociationQueryImpl<Q>>(
enversService,
auditReader,
this,
queryBuilder,
entityName,
associationName,
joinType,
alias
);
associationQueries.add( result );
associationQueryMap.put( associationName, result );
}
return result;
}

@Override
public AuditAssociationQueryImplementor<Q> add(AuditCriterion criterion) {
public AuditAssociationQueryImpl<Q> add(AuditCriterion criterion) {
criterions.add( criterion );
return this;
}

@Override
public AuditAssociationQueryImplementor<Q> addProjection(AuditProjection projection) {
public AuditAssociationQueryImpl<Q> addProjection(AuditProjection projection) {
hasProjections = true;
Triple<String, String, Boolean> projectionData = projection.getData( enversService );
String propertyName = CriteriaTools.determinePropertyName( enversService, auditReader, entityName, projectionData.getSecond() );
String propertyName = CriteriaTools.determinePropertyName(
enversService,
auditReader,
entityName,
projectionData.getSecond()
);
queryBuilder.addProjection( projectionData.getFirst(), alias, propertyName, projectionData.getThird() );
registerProjection( entityName, projection );
return this;
}

@Override
public AuditAssociationQueryImplementor<Q> addOrder(AuditOrder order) {
public AuditAssociationQueryImpl<Q> addOrder(AuditOrder order) {
hasOrders = true;
Pair<String, Boolean> orderData = order.getData( enversService );
String propertyName = CriteriaTools.determinePropertyName( enversService, auditReader, entityName, orderData.getFirst() );
String propertyName = CriteriaTools.determinePropertyName(
enversService,
auditReader,
entityName,
orderData.getFirst()
);
queryBuilder.addOrder( alias, propertyName, orderData.getSecond() );
return this;
}

@Override
public AuditAssociationQueryImplementor<Q> setMaxResults(int maxResults) {
public AuditAssociationQueryImpl<Q> setMaxResults(int maxResults) {
parent.setMaxResults( maxResults );
return this;
}

@Override
public AuditAssociationQueryImplementor<Q> setFirstResult(int firstResult) {
public AuditAssociationQueryImpl<Q> setFirstResult(int firstResult) {
parent.setFirstResult( firstResult );
return this;
}

@Override
public AuditAssociationQueryImplementor<Q> setCacheable(boolean cacheable) {
public AuditAssociationQueryImpl<Q> setCacheable(boolean cacheable) {
parent.setCacheable( cacheable );
return this;
}

@Override
public AuditAssociationQueryImplementor<Q> setCacheRegion(String cacheRegion) {
public AuditAssociationQueryImpl<Q> setCacheRegion(String cacheRegion) {
parent.setCacheRegion( cacheRegion );
return this;
}

@Override
public AuditAssociationQueryImplementor<Q> setComment(String comment) {
public AuditAssociationQueryImpl<Q> setComment(String comment) {
parent.setComment( comment );
return this;
}

@Override
public AuditAssociationQueryImplementor<Q> setFlushMode(FlushMode flushMode) {
public AuditAssociationQueryImpl<Q> setFlushMode(FlushMode flushMode) {
parent.setFlushMode( flushMode );
return this;
}

@Override
public AuditAssociationQueryImplementor<Q> setCacheMode(CacheMode cacheMode) {
public AuditAssociationQueryImpl<Q> setCacheMode(CacheMode cacheMode) {
parent.setCacheMode( cacheMode );
return this;
}

@Override
public AuditAssociationQueryImplementor<Q> setTimeout(int timeout) {
public AuditAssociationQueryImpl<Q> setTimeout(int timeout) {
parent.setTimeout( timeout );
return this;
}

@Override
public AuditAssociationQueryImplementor<Q> setLockMode(LockMode lockMode) {
public AuditAssociationQueryImpl<Q> setLockMode(LockMode lockMode) {
parent.setLockMode( lockMode );
return this;
}
Expand All @@ -180,7 +216,7 @@ public Q up() {
protected boolean hasCriterions() {
boolean result = !criterions.isEmpty();
if ( !result ) {
for ( final AuditAssociationQueryImplementor<?> sub : associationQueries ) {
for ( final AuditAssociationQueryImpl<?> sub : associationQueries ) {
if ( sub.hasCriterions() ) {
result = true;
break;
Expand All @@ -193,7 +229,7 @@ protected boolean hasCriterions() {
protected boolean hasOrders() {
boolean result = hasOrders;
if ( !result ) {
for ( final AuditAssociationQueryImplementor<?> sub : associationQueries ) {
for ( final AuditAssociationQueryImpl<?> sub : associationQueries ) {
if ( sub.hasOrders() ) {
result = true;
break;
Expand All @@ -206,7 +242,7 @@ protected boolean hasOrders() {
protected boolean hasProjections() {
boolean result = hasProjections;
if ( !result ) {
for ( final AuditAssociationQueryImplementor<?> sub : associationQueries ) {
for ( final AuditAssociationQueryImpl<?> sub : associationQueries ) {
if ( sub.hasProjections() ) {
result = true;
break;
Expand All @@ -227,28 +263,56 @@ protected void addCriterionsToQuery(AuditReaderImplementor versionsReader) {
String originalIdPropertyName = verEntCfg.getOriginalIdPropName();
IdMapper idMapperTarget = enversService.getEntitiesConfigurations().get( entityName ).getIdMapper();
final String prefix = alias.concat( "." ).concat( originalIdPropertyName );
ownerAssociationIdMapper.addIdsEqualToQuery( queryBuilder.getRootParameters(), ownerAlias, idMapperTarget, prefix );
ownerAssociationIdMapper.addIdsEqualToQuery(
queryBuilder.getRootParameters(),
ownerAlias,
idMapperTarget,
prefix
);

// filter reference of target entity
String revisionPropertyPath = verEntCfg.getRevisionNumberPath();
MiddleIdData referencedIdData = new MiddleIdData( verEntCfg, enversService.getEntitiesConfigurations().get( entityName ).getIdMappingData(), null, entityName,
enversService.getEntitiesConfigurations().isVersioned( entityName ) );
enversService.getAuditStrategy().addEntityAtRevisionRestriction( enversService.getGlobalConfiguration(), queryBuilder, parameters, revisionPropertyPath,
verEntCfg.getRevisionEndFieldName(), true, referencedIdData, revisionPropertyPath, originalIdPropertyName, alias,
queryBuilder.generateAlias(), true );
MiddleIdData referencedIdData = new MiddleIdData(
verEntCfg,
enversService.getEntitiesConfigurations().get( entityName ).getIdMappingData(),
null,
entityName,
enversService.getEntitiesConfigurations().isVersioned( entityName )
);
enversService.getAuditStrategy().addEntityAtRevisionRestriction(
enversService.getGlobalConfiguration(),
queryBuilder,
parameters,
revisionPropertyPath,
verEntCfg.getRevisionEndFieldName(),
true,
referencedIdData,
revisionPropertyPath,
originalIdPropertyName,
alias,
queryBuilder.generateAlias(),
true
);
}
else {
queryBuilder.addFrom( entityName, alias, false );
// owner.reference_id = target.id
IdMapper idMapperTarget = enversService.getEntitiesConfigurations().getNotVersionEntityConfiguration( entityName ).getIdMapper();
ownerAssociationIdMapper.addIdsEqualToQuery( queryBuilder.getRootParameters(), ownerAlias, idMapperTarget, alias );
final IdMapper idMapperTarget = enversService.getEntitiesConfigurations()
.getNotVersionEntityConfiguration( entityName )
.getIdMapper();
ownerAssociationIdMapper.addIdsEqualToQuery(
queryBuilder.getRootParameters(),
ownerAlias,
idMapperTarget,
alias
);
}

for ( AuditCriterion criterion : criterions ) {
criterion.addToQuery( enversService, versionsReader, entityName, alias, queryBuilder, parameters );
}

for ( final AuditAssociationQueryImplementor<?> sub : associationQueries ) {
for ( final AuditAssociationQueryImpl<?> sub : associationQueries ) {
sub.addCriterionsToQuery( versionsReader );
}
}
Expand Down
9 changes: 7 additions & 2 deletions ...-envers/src/main/java/org/hibernate/envers/query/internal/impl/AuditQueryImplementor.java
View file
@@ -1,14 +1,19 @@
/**
*
/*
* 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 <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.envers.query.internal.impl;

import org.hibernate.Incubating;
import org.hibernate.envers.query.AuditQuery;
import org.hibernate.envers.query.projection.AuditProjection;

/**
* @author Felix Feisst (feisst dot felix at gmail dot com)
*/
@Incubating
interface AuditQueryImplementor extends AuditQuery {

void registerProjection(final String entityName, final AuditProjection projection);
Expand Down
2 changes: 1 addition & 1 deletion ...nvers/src/main/java/org/hibernate/envers/query/internal/impl/EntitiesAtRevisionQuery.java
View file
Expand Up @@ -114,7 +114,7 @@ public List list() {
);
}

for (final AuditAssociationQueryImplementor<?> associationQuery : associationQueries) {
for (final AuditAssociationQueryImpl<?> associationQuery : associationQueries) {
associationQuery.addCriterionsToQuery( versionsReader );
}

Expand Down
2 changes: 1 addition & 1 deletion ...c/main/java/org/hibernate/envers/query/internal/impl/EntitiesModifiedAtRevisionQuery.java
View file
Expand Up @@ -70,7 +70,7 @@ public List list() {
);
}

for (final AuditAssociationQueryImplementor<?> associationQuery : associationQueries) {
for (final AuditAssociationQueryImpl<?> associationQuery : associationQueries) {
associationQuery.addCriterionsToQuery(versionsReader);
}

Expand Down

0 comments on commit c783aab

Please sign in to comment.