Interface NamedObjectRepository

@Incubating
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> @Nullable 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> @NonNull 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)
@NonNull 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

<R> Map<String, TypedQueryReference<R>> getNamedQueries(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(BiConsumer<String, ? super TypedQueryReference<?>> action)

Perform an action for all registered selection-query references.

registerNamedQuery

<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.

See Also:

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

getNamedMutations

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(BiConsumer<String, ? super StatementReference> action)

Perform an action for all registered mutation-query references.

registerNamedMutation

@NonNull 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.

See Also:

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

findQueryMementoByName

<R> @Nullable NamedQueryMemento<R> findQueryMementoByName(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

<R> @NonNull 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.

Returns:

The query registration.

Throws:

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

getSelectionQueryMemento

<R> NamedSelectionMemento<R> getSelectionQueryMemento(String name)

getMutationQueryMemento

<R> NamedMutationMemento<R> getMutationQueryMemento(String name)

getCallableQueryMemento

NamedCallableQueryMemento getCallableQueryMemento(String name)

visitCallableQueryMementos

void visitCallableQueryMementos(Consumer<NamedCallableQueryMemento> action)

registerCallableQueryMemento

void registerCallableQueryMemento(String name,
 NamedCallableQueryMemento memento)

getResultSetMappingMemento

NamedResultSetMappingMemento getResultSetMappingMemento(String mappingName)

visitResultSetMappingMementos

void visitResultSetMappingMementos(Consumer<NamedResultSetMappingMemento> action)

registerResultSetMappingMemento

void registerResultSetMappingMemento(String name,
 NamedResultSetMappingMemento memento)

checkNamedQueries

Map<String, HibernateException> checkNamedQueries(QueryEngine queryPlanCache)

Perform a validity check on all named queries

validateNamedQueries

void validateNamedQueries(QueryEngine queryEngine)

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

resolve

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

Resolve the named query with the given name.

prepare

void prepare(SessionFactoryImplementor sessionFactory,
 Metadata bootMetamodel)

Prepare for runtime use

close

void close()

Release any held resources