org.hibernate.engine.query.spi.NativeQueryInterpreter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Show all versions of hibernate-core Show documentation
Hibernate's core ORM functionality
/*
* 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.engine.query.spi;
import org.hibernate.engine.query.spi.sql.NativeSQLQuerySpecification;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.loader.custom.CustomLoader;
import org.hibernate.loader.custom.CustomQuery;
import org.hibernate.query.internal.ParameterMetadataImpl;
import org.hibernate.service.Service;
/**
* Service contract for dealing with native queries.
*
* @author Steve Ebersole
* @author Gunnar Morling
* @author Guillaume Smet
*/
public interface NativeQueryInterpreter extends Service {
/**
* Returns a meta-data object with information about the named and ordinal
* parameters contained in the given native query.
*
* @param nativeQuery the native query to analyze.
*
* @return a meta-data object describing the parameters of the given query.
* Must not be {@code null}.
*/
ParameterMetadataImpl getParameterMetadata(String nativeQuery);
/**
* Creates a new query plan for the specified native query.
*
* @param specification Describes the query to create a plan for
* @param sessionFactory The current session factory
*
* @return A query plan for the specified native query.
*/
NativeSQLQueryPlan createQueryPlan(NativeSQLQuerySpecification specification, SessionFactoryImplementor sessionFactory);
/**
* Creates a {@link CustomLoader} for the given {@link CustomQuery}.
*
* @param customQuery The CustomQuery to create a loader for
* @param sessionFactory The current session factory
*
* @deprecated This method will be removed in 6.
*/
@Deprecated
default CustomLoader createCustomLoader(CustomQuery customQuery, SessionFactoryImplementor sessionFactory) {
return new CustomLoader( customQuery, sessionFactory );
}
}