Interface NamedObjectRepository

@Incubating(since="8.0")
public interface NamedObjectRepository

Repository for references to named things related to queries. This includes:

• named HQL, JPQL, native, and procedure queries,
• along with named result set mappings.

Method Summary

Modifier and Type	Method	Description
Map<String, HibernateException>	checkNamedQueries(QueryEngine queryPlanCache)	Perform a validity check on all named queries
void	close()	Release any held resources
<R> NamedQueryMemento<R>	findQueryMementoByName(String name, boolean includeProcedureCalls)	Find a query registration by name, regardless of query type.
void	forEachNamedMutation(BiConsumer<String, ? super StatementReference> action)	Perform an action for all registered mutation-query references.
void	forEachNamedQuery(BiConsumer<String, ? super TypedQueryReference<?>> action)	Perform an action for all registered selection-query references.
NamedCallableQueryMemento	getCallableQueryMemento(String name)
<R> NamedMutationMemento<R>	getMutationQueryMemento(String name)
Map<String, StatementReference>	getNamedMutations()	Returns all mutation-query references keyed by registration name.
<R> Map<String, TypedQueryReference<R>>	getNamedQueries(Class<R> resultType)	Returns all selection-query references keyed by registration name.
<R> NamedQueryMemento<R>	getQueryMementoByName(String name, boolean includeProcedureCalls)	Find a query registration by name, regardless of query type, throwing an exception if one could not be found.
NamedResultSetMappingMemento	getResultSetMappingMemento(String mappingName)
<R> NamedSelectionMemento<R>	getSelectionQueryMemento(String name)
void	prepare(SessionFactoryImplementor sessionFactory, Metadata bootMetamodel)	Prepare for runtime use
void	registerCallableQueryMemento(String name, NamedCallableQueryMemento memento)
StatementReference	registerNamedMutation(String name, Statement statement)	Registers the given mutation-query using the given name, returning a registration reference, which can be used later to create a query instance.
<R> TypedQueryReference<R>	registerNamedQuery(String name, TypedQuery<R> query)	Registers the given selection-query using the given name, returning a registration reference, which can be used later to create a query instance.
void	registerResultSetMappingMemento(String name, NamedResultSetMappingMemento memento)
NamedQueryMemento<?>	resolve(SessionFactoryImplementor sessionFactory, MetadataImplementor bootMetamodel, String registrationName)	Resolve the named query with the given name.
void	validateNamedQueries(QueryEngine queryEngine)	Validate the named queries and throw an exception if any are broken
void	visitCallableQueryMementos(Consumer<NamedCallableQueryMemento> action)
void	visitResultSetMappingMementos(Consumer<NamedResultSetMappingMemento> action)

Method Details

getNamedQueries

@Nonnull
<R> Map<String, TypedQueryReference<R>> getNamedQueries(@Nonnull
 Class<R> resultType)

Returns all selection-query references keyed by registration name.

See Also:

• EntityManagerFactory.getNamedQueries(Class)
• NamedQuery
• NamedNativeQuery
• registerNamedQuery(String, TypedQuery)
• SessionFactory.addNamedQuery(String, TypedQuery)
• SelectionQuery

forEachNamedQuery

void forEachNamedQuery(@Nonnull
 BiConsumer<String, ? super TypedQueryReference<?>> action)

Perform an action for all registered selection-query references.

registerNamedQuery

@Nonnull
<R> TypedQueryReference<R> registerNamedQuery(@Nonnull
 String name,
 @Nonnull
 TypedQuery<R> query)

Registers the given selection-query using the given name, returning a registration reference, which can be used later to create a query instance.

See Also:

• getNamedQueries(Class)
• SessionFactory.addNamedQuery(String, TypedQuery)
• Session.createQuery(TypedQueryReference)

getNamedMutations

@Nonnull
Map<String, StatementReference> getNamedMutations()

Returns all mutation-query references keyed by registration name.

See Also:

• EntityManagerFactory.getNamedStatements()
• NamedStatement
• NamedNativeStatement
• registerNamedMutation(String, Statement)
• EntityManagerFactory.addNamedStatement(String, Statement)
• MutationQuery

forEachNamedMutation

void forEachNamedMutation(@Nonnull
 BiConsumer<String, ? super StatementReference> action)

Perform an action for all registered mutation-query references.

registerNamedMutation

@Nonnull
StatementReference registerNamedMutation(@Nonnull
 String name,
 @Nonnull
 Statement statement)

Registers the given mutation-query using the given name, returning a registration reference, which can be used later to create a query instance.

See Also:

• getNamedMutations()
• EntityManagerFactory.addNamedStatement(String, Statement)
• SharedSessionContract.createStatement(StatementReference)

findQueryMementoByName

@Nullable
<R> NamedQueryMemento<R> findQueryMementoByName(@Nonnull
 String name,
 boolean includeProcedureCalls)

Find a query registration by name, regardless of query type.

Returns:

The query registration, or null if one could not be found

getQueryMementoByName

@Nonnull
<R> NamedQueryMemento<R> getQueryMementoByName(@Nonnull
 String name,
 boolean includeProcedureCalls)

Find a query registration by name, regardless of query type, throwing an exception if one could not be found.

Returns:

The query registration.

Throws:

UnknownNamedQueryException - If one could not be found under that name.

getSelectionQueryMemento

@Nullable
<R> NamedSelectionMemento<R> getSelectionQueryMemento(@Nonnull
 String name)

getMutationQueryMemento

@Nullable
<R> NamedMutationMemento<R> getMutationQueryMemento(@Nonnull
 String name)

getCallableQueryMemento

@Nullable
NamedCallableQueryMemento getCallableQueryMemento(@Nonnull
 String name)

visitCallableQueryMementos

void visitCallableQueryMementos(@Nonnull
 Consumer<NamedCallableQueryMemento> action)

registerCallableQueryMemento

void registerCallableQueryMemento(@Nonnull
 String name,
 @Nonnull
 NamedCallableQueryMemento memento)

getResultSetMappingMemento

@Nullable
NamedResultSetMappingMemento getResultSetMappingMemento(@Nonnull
 String mappingName)

visitResultSetMappingMementos

void visitResultSetMappingMementos(@Nonnull
 Consumer<NamedResultSetMappingMemento> action)

registerResultSetMappingMemento

void registerResultSetMappingMemento(@Nonnull
 String name,
 @Nonnull
 NamedResultSetMappingMemento memento)

checkNamedQueries

@Nonnull
Map<String, HibernateException> checkNamedQueries(@Nonnull
 QueryEngine queryPlanCache)

Perform a validity check on all named queries

validateNamedQueries

void validateNamedQueries(@Nonnull
 QueryEngine queryEngine)

Validate the named queries and throw an exception if any are broken

resolve

@Nullable
NamedQueryMemento<?> resolve(@Nonnull
 SessionFactoryImplementor sessionFactory,
 @Nonnull
 MetadataImplementor bootMetamodel,
 @Nonnull
 String registrationName)

Resolve the named query with the given name.

prepare

void prepare(@Nonnull
 SessionFactoryImplementor sessionFactory,
 @Nonnull
 Metadata bootMetamodel)

Prepare for runtime use

close

void close()

Release any held resources