org.hibernate.query.hql.spi.SqmCreationProcessingState 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.Beta1

/*
 * 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.hql.spi;

import org.hibernate.Incubating;
import org.hibernate.query.sqm.tree.SqmQuery;

/**
 * State related to SQM creation, like {@link SqmCreationState}, but specific
 * to its "current processing" - which generally means specific to each statement
 * and sub-query
 *
 * @author Steve Ebersole
 */
@Incubating
public interface SqmCreationProcessingState {
	/**
	 * The parent processing state.  May be null for the top-level processing.
	 *
	 * Intended to be used while processing a sub-query to access the processing
	 * state of the context in which the sub-query occurs.
	 */
	SqmCreationProcessingState getParentProcessingState();

	/**
	 * Access to the query currently being processed.  This should be generally considered
	 * an inflight model - we are still in the process of creating the SQM
	 */
	SqmQuery getProcessingQuery();

	/**
	 * The overall SQM creation state
	 */
	SqmCreationState getCreationState();

	/**
	 * SqmPathRegistry associated with this state.
	 */
	SqmPathRegistry getPathRegistry();
}