org.hibernate.sql.ast.tree.spi.expression.domain.NavigableReference 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.sql.ast.tree.spi.expression.domain;

import org.hibernate.internal.util.Loggable;
import org.hibernate.metamodel.model.domain.spi.Navigable;
import org.hibernate.query.NavigablePath;
import org.hibernate.sql.ast.produce.spi.ColumnReferenceQualifier;
import org.hibernate.sql.results.spi.DomainResult;
import org.hibernate.sql.results.spi.DomainResultCreationContext;
import org.hibernate.sql.results.spi.DomainResultCreationState;
import org.hibernate.sql.results.spi.DomainResultProducer;

/**
 * Models the QueryResultProducer generated as part of walking an SQM AST
 * to generate an SQL AST.
 *
 * @see org.hibernate.query.sqm.tree.select.SqmSelectableNode#accept
 *
 * @author Steve Ebersole
 */
public interface NavigableReference extends DomainResultProducer, Loggable {

	// todo (6.0) : I think it might be better to distinguish NavigableReference based on "classification".
	//		E.g.:
	//			* BasicValuedNavigableReference (basic attributes, simple ids, "element collection" elements, etc)
	//			* EntityValuedNavigableReference (root reference, many-to-one, one-to-one, elements of one-to-many, etc)
	//			* CompositeValuedNavigableReference (embedded, composite ids, etc)
	//			* AnyValuedNavigableReference (any, many-to-any, etc)



	@Override
	default String toLoggableFragment() {
		return getNavigablePath().toLoggableFragment() + "(" + getColumnReferenceQualifier() + ")";

	}

	/**
	 * Get the Navigable referenced by this expression
	 *
	 * @return The Navigable
	 */
	Navigable getNavigable();

	NavigablePath getNavigablePath();

	/**
	 * Corollary to {@link Navigable#getContainer()} on the reference/expression side
	 */
	NavigableContainerReference getNavigableContainerReference();

	ColumnReferenceQualifier getColumnReferenceQualifier();

	@Override
	default DomainResult createDomainResult(
			String resultVariable,
			DomainResultCreationState creationState,
			DomainResultCreationContext creationContext) {
		creationState.getColumnReferenceQualifierStack().push( getColumnReferenceQualifier() );
		creationState.getNavigableReferenceStack().push( this );
		try {
			return getNavigable().createDomainResult(
					this,
					resultVariable,
					creationState, creationContext
			);
		}
		finally {
			creationState.getNavigableReferenceStack().pop();
			creationState.getColumnReferenceQualifierStack().pop();
		}
	}
}