org.hibernate.query.sqm.tree.select.SqmDynamicInstantiation Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Hibernate's core ORM functionality
There is a newer version: 7.0.0.Alpha3
/*
 * 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.query.sqm.tree.select;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;

import org.hibernate.query.DynamicInstantiationNature;
import org.hibernate.query.criteria.JpaCompoundSelection;
import org.hibernate.query.criteria.JpaSelection;
import org.hibernate.query.sqm.NodeBuilder;
import org.hibernate.query.sqm.SemanticQueryWalker;
import org.hibernate.query.sqm.tree.expression.SqmExpression;
import org.hibernate.query.sqm.tree.jpa.AbstractJpaSelection;
import org.hibernate.query.sqm.sql.internal.DomainResultProducer;
import org.hibernate.type.descriptor.java.JavaTypeDescriptor;

import org.jboss.logging.Logger;

import static org.hibernate.query.DynamicInstantiationNature.CLASS;
import static org.hibernate.query.DynamicInstantiationNature.LIST;
import static org.hibernate.query.DynamicInstantiationNature.MAP;

/**
 * Represents a dynamic instantiation ({@code select new XYZ(...) ...}) as part of the SQM.
 *
 * @author Steve Ebersole
 */
public class SqmDynamicInstantiation
		extends AbstractJpaSelection
		implements SqmSelectableNode,
		SqmAliasedExpressionContainer,
		JpaCompoundSelection,
		DomainResultProducer {

	private static final Logger log = Logger.getLogger( SqmDynamicInstantiation.class );

	public static SqmDynamicInstantiation forClassInstantiation(
			JavaTypeDescriptor targetJavaType,
			NodeBuilder nodeBuilder) {
		//noinspection unchecked
		return new SqmDynamicInstantiation(
				new DynamicInstantiationTargetImpl( CLASS, targetJavaType ),
				nodeBuilder
		);
	}

	public static SqmDynamicInstantiation forClassInstantiation(
			Class targetJavaType,
			NodeBuilder nodeBuilder) {
		//noinspection unchecked
		return forClassInstantiation(
				nodeBuilder.getTypeConfiguration().getJavaTypeDescriptorRegistry().getDescriptor( targetJavaType ),
				nodeBuilder
		);
	}

	public static SqmDynamicInstantiation forMapInstantiation(
			JavaTypeDescriptor mapJavaTypeDescriptor,
			NodeBuilder nodeBuilder) {
		//noinspection unchecked
		return new SqmDynamicInstantiation(
				new DynamicInstantiationTargetImpl( MAP, mapJavaTypeDescriptor ),
				nodeBuilder
		);
	}

	public static SqmDynamicInstantiation forMapInstantiation(NodeBuilder nodeBuilder) {
		return forMapInstantiation(
				nodeBuilder.getTypeConfiguration().getJavaTypeDescriptorRegistry().getDescriptor( Map.class ),
				nodeBuilder
		);
	}

	public static SqmDynamicInstantiation forListInstantiation(
			JavaTypeDescriptor listJavaTypeDescriptor,
			NodeBuilder nodeBuilder) {
		//noinspection unchecked
		return new SqmDynamicInstantiation(
				new DynamicInstantiationTargetImpl( LIST, listJavaTypeDescriptor ),
				nodeBuilder
		);
	}

	public static SqmDynamicInstantiation forListInstantiation(NodeBuilder nodeBuilder) {
		return forListInstantiation(
				nodeBuilder.getTypeConfiguration().getJavaTypeDescriptorRegistry().getDescriptor( List.class ),
				nodeBuilder
		);
	}

	private final SqmDynamicInstantiationTarget instantiationTarget;
	private List> arguments;

	private SqmDynamicInstantiation(
			SqmDynamicInstantiationTarget instantiationTarget,
			NodeBuilder nodeBuilder) {
		super( instantiationTarget, nodeBuilder );
		this.instantiationTarget = instantiationTarget;
	}

	public SqmDynamicInstantiationTarget getInstantiationTarget() {
		return instantiationTarget;
	}

	public List> getArguments() {
		return arguments;
	}

	@Override
	public JavaTypeDescriptor getJavaTypeDescriptor() {
		return getInstantiationTarget().getTargetTypeDescriptor();
	}

	@Override
	public String asLoggableText() {
		return "";
	}

	public void addArgument(SqmDynamicInstantiationArgument argument) {
		if ( instantiationTarget.getNature() == LIST ) {
			// really should not have an alias...
			if ( argument.getAlias() != null ) {
				log.debugf(
						"Argument [%s] for dynamic List instantiation declared an 'injection alias' [%s] " +
								"but such aliases are ignored for dynamic List instantiations",
						argument.getSelectableNode().asLoggableText(),
						argument.getAlias()
				);
			}
		}
		else if ( instantiationTarget.getNature() == MAP ) {
			// must(?) have an alias...
			log.warnf(
					"Argument [%s] for dynamic Map instantiation did not declare an 'injection alias' [%s] " +
							"but such aliases are needed for dynamic Map instantiations; " +
							"will likely cause problems later translating sqm",
					argument.getSelectableNode().asLoggableText(),
					argument.getAlias()
			);
		}

		if ( arguments == null ) {
			arguments = new ArrayList<>();
		}
		arguments.add( argument );
	}

	@Override
	public SqmDynamicInstantiationArgument add(SqmExpression expression, String alias) {
		final SqmDynamicInstantiationArgument argument = new SqmDynamicInstantiationArgument<>(
				expression,
				alias,
				nodeBuilder()
		);
		addArgument( argument );
		return argument;
	}

	@Override
	public void add(SqmDynamicInstantiationArgument aliasExpression) {
		addArgument( aliasExpression );
	}

	@Override
	public  X accept(SemanticQueryWalker walker) {
		return walker.visitDynamicInstantiation( this );
	}

	@SuppressWarnings("unused")
	public SqmDynamicInstantiation makeShallowCopy() {
		return new SqmDynamicInstantiation<>( getInstantiationTarget(), nodeBuilder() );
	}

	private static class DynamicInstantiationTargetImpl implements SqmDynamicInstantiationTarget {
		private final DynamicInstantiationNature nature;
		private final JavaTypeDescriptor javaTypeDescriptor;


		private DynamicInstantiationTargetImpl(DynamicInstantiationNature nature, JavaTypeDescriptor javaTypeDescriptor) {
			this.nature = nature;
			this.javaTypeDescriptor = javaTypeDescriptor;
		}

		@Override
		public DynamicInstantiationNature getNature() {
			return nature;
		}

		@Override
		public JavaTypeDescriptor getTargetTypeDescriptor() {
			return javaTypeDescriptor;
		}

		@Override
		public JavaTypeDescriptor getExpressableJavaTypeDescriptor() {
			return getTargetTypeDescriptor();
		}
	}


	// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	// JPA

	@Override
	public void visitSubSelectableNodes(Consumer> consumer) {
		for ( SqmDynamicInstantiationArgument argument : arguments ) {
			consumer.accept( argument.getSelectableNode() );
		}
	}

	@Override
	public List> getSelectionItems() {
		final List> list = new ArrayList<>();
		visitSubSelectableNodes( list::add );
		return list;
	}

	@Override
	public String getAlias() {
		return null;
	}

	@Override
	public JpaSelection alias(String name) {
		return null;
	}

	@Override
	public boolean isCompoundSelection() {
		return false;
	}
}