org.hibernate.envers.query.criteria.internal.RelatedAuditInExpression Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hibernate-envers-jakarta Show documentation

Hibernate's entity version (audit/history) support Jakarta edition

There is a newer version: 5.6.15.Final

Show newest version

/*
 * 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.criteria.internal;

import java.util.List;

import org.hibernate.envers.boot.internal.EnversService;
import org.hibernate.envers.exception.AuditException;
import org.hibernate.envers.internal.entities.RelationDescription;
import org.hibernate.envers.internal.entities.mapper.id.QueryParameterData;
import org.hibernate.envers.internal.reader.AuditReaderImplementor;
import org.hibernate.envers.internal.tools.query.Parameters;
import org.hibernate.envers.internal.tools.query.QueryBuilder;
import org.hibernate.envers.query.criteria.AuditCriterion;
import org.hibernate.envers.query.internal.property.PropertyNameGetter;

/**
 * @author Chris Cranford
 * @since 5.2
 */
public class RelatedAuditInExpression extends AbstractAtomicExpression {

	private final PropertyNameGetter propertyNameGetter;
	private final Object[] ids;

	public RelatedAuditInExpression(String alias, PropertyNameGetter propertyNameGetter, Object[] ids) {
		super( alias );
		this.propertyNameGetter = propertyNameGetter;
		this.ids = ids;
	}

	@Override
	protected void addToQuery(
			EnversService enversService,
			AuditReaderImplementor versionsReader,
			String entityName,
			String alias,
			QueryBuilder qb,
			Parameters parameters) {
		String propertyName = CriteriaTools.determinePropertyName(
				enversService,
				versionsReader,
				entityName,
				propertyNameGetter
		);

		RelationDescription relatedEntity = CriteriaTools.getRelatedEntity( enversService, entityName, propertyName );
		if ( relatedEntity == null ) {
			throw new AuditException(
					"The criterion can only be used on a property that is a relation to another property."
			);
		}

		// todo: should this throw an error if qpdList is null?  is it possible?
		List qpdList = relatedEntity.getIdMapper().mapToQueryParametersFromId( propertyName );
		if ( qpdList != null ) {
			QueryParameterData qpd = qpdList.iterator().next();
			parameters.addWhereWithParams( alias, qpd.getQueryParameterName(), "in (", ids, ")" );
		}
	}
}