org.hibernate.jpa.criteria.path.PluralAttributePath Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-entitymanager
A module of the Hibernate O/RM project
There is a newer version: 5.4.2.Final
/*
 * 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.jpa.criteria.path;

import java.io.Serializable;
import javax.persistence.metamodel.Attribute;
import javax.persistence.metamodel.Bindable;
import javax.persistence.metamodel.EntityType;
import javax.persistence.metamodel.IdentifiableType;
import javax.persistence.metamodel.PluralAttribute;
import javax.persistence.metamodel.Type;

import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.jpa.criteria.CriteriaBuilderImpl;
import org.hibernate.jpa.criteria.PathSource;
import org.hibernate.persister.collection.CollectionPersister;

/**
 * Models a path for a {@link PluralAttribute} generally obtained from a
 * {@link javax.persistence.criteria.Path#get} call
 *
 * @author Steve Ebersole
 */
public class PluralAttributePath extends AbstractPathImpl implements Serializable {
	private final PluralAttribute attribute;
	private final CollectionPersister persister;

	public PluralAttributePath(
			CriteriaBuilderImpl criteriaBuilder,
			PathSource source,
			PluralAttribute attribute) {
		super( criteriaBuilder, attribute.getJavaType(), source );
		this.attribute = attribute;
		this.persister = resolvePersister( criteriaBuilder, attribute );
	}

	private CollectionPersister resolvePersister(CriteriaBuilderImpl criteriaBuilder, PluralAttribute attribute) {
		SessionFactoryImplementor sfi = criteriaBuilder.getEntityManagerFactory().getSessionFactory();
		return sfi.getCollectionPersister( resolveRole( attribute ) );
	}

	private String resolveRole(PluralAttribute attribute) {
		Class roleOwnerType = attribute.getDeclaringType().getJavaType();
		if ( attribute.getDeclaringType().getPersistenceType() == Type.PersistenceType.MAPPED_SUPERCLASS ) {
			// the attribute is declared in a mappedsuperclass
			if ( getPathSource().getModel().getBindableType() == Bindable.BindableType.ENTITY_TYPE ) {
				// the role will be assigned to the "nearest" EnityType subclass of the MappedSuperclassType
				EntityType entityTypeNearestDeclaringType = (EntityType) getPathSource().getModel();
				IdentifiableType superType = entityTypeNearestDeclaringType.getSupertype();
				IdentifiableType previousType = entityTypeNearestDeclaringType;
				while ( superType != attribute.getDeclaringType() ) {
					if ( superType == null ) {
						throw new IllegalStateException(
								String.format(
									"Cannot determine nearest EntityType extending mapped superclass [%s]; [%s] extends [%s], but supertype of [%s] is null",
										attribute.getDeclaringType().getJavaType().getName(),
										( (EntityType) getPathSource().getModel() ).getJavaType().getName(),
										previousType.getJavaType().getName(),
										previousType.getJavaType().getName()
								)
						);
					}
					if ( superType.getPersistenceType() == Type.PersistenceType.ENTITY ) {
						entityTypeNearestDeclaringType = (EntityType) superType;
					}
					previousType = superType;
					superType = superType.getSupertype();
				}
				roleOwnerType = entityTypeNearestDeclaringType.getJavaType();
			}
			// else throw an exception?
		}
		// TODO: still need to deal with a plural attribute declared in an embeddable (HHH-6562)
		return roleOwnerType.getName() +
				'.' + attribute.getName();
	}

	public PluralAttribute getAttribute() {
		return attribute;
	}

	@SuppressWarnings({ "UnusedDeclaration" })
	public CollectionPersister getPersister() {
		return persister;
	}

	@Override
	protected boolean canBeDereferenced() {
		// cannot be dereferenced
		return false;
	}

	@Override
	protected Attribute locateAttributeInternal(String attributeName) {
		throw new IllegalArgumentException( "Plural attribute paths cannot be further dereferenced" );
	}

	public Bindable getModel() {
		// the issue here is the parameterized type; X is the collection
		// type (Map, Set, etc) while the "bindable" for a collection is the
		// elements.
		//
		// TODO : throw exception instead?
		return null;
	}

	@Override
	public  PluralAttributePath treatAs(Class treatAsType) {
		throw new UnsupportedOperationException(
				"Plural attribute path [" + getPathSource().getPathIdentifier() + '.'
						+ attribute.getName() + "] cannot be dereferenced"
		);
	}
}