org.hibernate.query.sqm.tree.expression.SqmTuple 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.expression;

import java.util.Arrays;
import java.util.List;

import org.hibernate.QueryException;
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.SqmExpressable;
import org.hibernate.query.sqm.tree.select.SqmJpaCompoundSelection;
import org.hibernate.type.descriptor.java.JavaTypeDescriptor;

/**
 * Models a tuple of values, generally defined as a series of values
 * wrapped in parentheses, e.g. `(value1, value2, ..., valueN)`.
 *
 * Differs from {@link SqmJpaCompoundSelection} in that this node can be used
 * anywhere in the SQM tree, whereas SqmJpaCompoundSelection is only valid
 * in the SELECT clause per JPA
 *
 * @author Steve Ebersole
 */
public class SqmTuple
		extends AbstractSqmExpression
		implements JpaCompoundSelection {
	private final List> groupedExpressions;

	public SqmTuple(NodeBuilder nodeBuilder, SqmExpression... groupedExpressions) {
		this( Arrays.asList( groupedExpressions ), nodeBuilder );
	}

	public SqmTuple(NodeBuilder nodeBuilder, SqmExpressable type, SqmExpression... groupedExpressions) {
		this( Arrays.asList( groupedExpressions ), nodeBuilder );
		applyInferableType( type );
	}

	public SqmTuple(List> groupedExpressions, NodeBuilder nodeBuilder) {
		super( null, nodeBuilder );
		if ( groupedExpressions.isEmpty() ) {
			throw new QueryException( "tuple grouping cannot be constructed over zero expressions" );
		}
		this.groupedExpressions = groupedExpressions;
	}

	public SqmTuple(List> groupedExpressions, SqmExpressable type, NodeBuilder nodeBuilder) {
		this( groupedExpressions, nodeBuilder );
		applyInferableType( type );
	}

	public List> getGroupedExpressions() {
		return groupedExpressions;
	}

	@Override
	public SqmExpressable getNodeType() {
		final SqmExpressable expressableType = super.getNodeType();
		if ( expressableType != null ) {
			return expressableType;
		}

		for ( SqmExpression groupedExpression : groupedExpressions ) {
			//noinspection unchecked
			final SqmExpressable groupedExpressionExpressableType = groupedExpression.getNodeType();
			if ( groupedExpressionExpressableType != null ) {
				return groupedExpressionExpressableType;
			}
		}

		return null;
	}

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

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

	@Override
	public JavaTypeDescriptor getJavaTypeDescriptor() {
		return getNodeType().getExpressableJavaTypeDescriptor();
	}

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

	@Override
	public List> getSelectionItems() {
		return getGroupedExpressions();
	}

}