org.hibernate.metamodel.spi

Interface MetamodelImplementor

All Superinterfaces:

Metamodel

public interface MetamodelImplementor
extends Metamodel

Hibernate extension to the JPA Metamodel contract

Method Summary

Modifier and Type	Method and Description
<T> void	addNamedEntityGraph(String graphName, EntityGraph<T> entityGraph) Deprecated. Use addNamedEntityGraph(String, RootGraphImplementor) instead.
<T> void	addNamedEntityGraph(String graphName, RootGraphImplementor<T> entityGraph)
void	close()
CollectionPersister	collectionPersister(String role) Get the persister object for a collection role.
Map<String,CollectionPersister>	collectionPersisters() Get all collection persisters as a Map, which collection role as the key and the persister is the value.
<X> EmbeddedTypeDescriptor<X>	embeddable(Class<X> cls)
<X> EntityTypeDescriptor<X>	entity(Class<X> cls)
<X> EntityTypeDescriptor<X>	entity(String entityName) Access to an entity supporting Hibernate's entity-name feature
EntityPersister	entityPersister(Class entityClass) Locate the persister for an entity by the entity class.
EntityPersister	entityPersister(String entityName) Locate the persister for an entity by the entity-name
Map<String,EntityPersister>	entityPersisters() Get all entity persisters as a Map, which entity name its the key and the persister is the value.
<T> RootGraphImplementor<T>	findEntityGraphByName(String name)
<T> List<RootGraphImplementor<? super T>>	findEntityGraphsByJavaType(Class<T> entityClass)
default <T> List<EntityGraph<? super T>>	findEntityGraphsByType(Class<T> entityClass) Deprecated. Use findEntityGraphsByJavaType(Class) instead.
String[]	getAllCollectionRoles() Get the names of all collections known to this Metamodel
String[]	getAllEntityNames() Get the names of all entities known to this Metamodel
Set<String>	getCollectionRolesByEntityParticipant(String entityName) Retrieves a set of all the collection roles in which the given entity is a participant, as either an index or an element.
Collection<EntityNameResolver>	getEntityNameResolvers()
default EntityTypeDescriptor	getEntityTypeByName(String entityName)
SessionFactoryImplementor	getSessionFactory() Access to the SessionFactory that this Metamodel instance is bound to.
TypeConfiguration	getTypeConfiguration() Access to the TypeConfiguration in effect for this SessionFactory/Metamodel
EntityPersister	locateEntityPersister(Class byClass) Locate an EntityPersister by the entity class.
EntityPersister	locateEntityPersister(String byName) Locate the entity persister by name.
<X> ManagedTypeDescriptor<X>	managedType(Class<X> cls)

Methods inherited from interface org.hibernate.Metamodel

getImplementors, getImportedClassName

Methods inherited from interface javax.persistence.metamodel.Metamodel

getEmbeddables, getEntities, getManagedTypes

Method Detail

getTypeConfiguration

TypeConfiguration getTypeConfiguration()

Access to the TypeConfiguration in effect for this SessionFactory/Metamodel

Returns:

Access to the TypeConfiguration

getSessionFactory

SessionFactoryImplementor getSessionFactory()

Description copied from interface: Metamodel

Access to the SessionFactory that this Metamodel instance is bound to.

Returns:

The SessionFactory

getEntityNameResolvers

Collection<EntityNameResolver> getEntityNameResolvers()

locateEntityPersister

EntityPersister locateEntityPersister(Class byClass)

Locate an EntityPersister by the entity class. The passed Class might refer to either the entity name directly, or it might name a proxy interface for the entity. This method accounts for both, preferring the direct named entity name.

Parameters:

byClass - The concrete Class or proxy interface for the entity to locate the persister for.

Returns:

The located EntityPersister, never null

Throws:

UnknownEntityTypeException - If a matching EntityPersister cannot be located

locateEntityPersister

EntityPersister locateEntityPersister(String byName)

Locate the entity persister by name.

Parameters:

byName - The entity name

Returns:

The located EntityPersister, never null

Throws:

UnknownEntityTypeException - If a matching EntityPersister cannot be located

entityPersister

EntityPersister entityPersister(Class entityClass)

Locate the persister for an entity by the entity class.

Parameters:

entityClass - The entity class

Returns:

The entity persister

Throws:

MappingException - Indicates persister for that class could not be found.

entityPersister

EntityPersister entityPersister(String entityName)

Locate the persister for an entity by the entity-name

Parameters:

entityName - The name of the entity for which to retrieve the persister.

Returns:

The persister

Throws:

MappingException - Indicates persister could not be found with that name.

entityPersisters

Map<String,EntityPersister> entityPersisters()

Get all entity persisters as a Map, which entity name its the key and the persister is the value.

Returns:

The Map contains all entity persisters.

collectionPersister

CollectionPersister collectionPersister(String role)

Get the persister object for a collection role.

Parameters:

role - The role of the collection for which to retrieve the persister.

Returns:

The persister

Throws:

MappingException - Indicates persister could not be found with that role.

collectionPersisters

Map<String,CollectionPersister> collectionPersisters()

Get all collection persisters as a Map, which collection role as the key and the persister is the value.

Returns:

The Map contains all collection persisters.

getCollectionRolesByEntityParticipant

Set<String> getCollectionRolesByEntityParticipant(String entityName)

Retrieves a set of all the collection roles in which the given entity is a participant, as either an index or an element.

Parameters:

entityName - The entity name for which to get the collection roles.

Returns:

set of all the collection roles in which the given entityName participates.

getAllEntityNames

String[] getAllEntityNames()

Get the names of all entities known to this Metamodel

Returns:

All of the entity names

getAllCollectionRoles

String[] getAllCollectionRoles()

Get the names of all collections known to this Metamodel

Returns:

All of the entity names

addNamedEntityGraph

<T> void addNamedEntityGraph(String graphName,
                             RootGraphImplementor<T> entityGraph)

addNamedEntityGraph

@Deprecated
<T> void addNamedEntityGraph(String graphName,
                                         EntityGraph<T> entityGraph)

Deprecated. Use addNamedEntityGraph(String, RootGraphImplementor) instead.

findEntityGraphByName

<T> RootGraphImplementor<T> findEntityGraphByName(String name)

findEntityGraphsByJavaType

<T> List<RootGraphImplementor<? super T>> findEntityGraphsByJavaType(Class<T> entityClass)

findEntityGraphsByType

@Deprecated
default <T> List<EntityGraph<? super T>> findEntityGraphsByType(Class<T> entityClass)

Deprecated. Use findEntityGraphsByJavaType(Class) instead.

close

void close()

entity

<X> EntityTypeDescriptor<X> entity(String entityName)

Description copied from interface: Metamodel

Access to an entity supporting Hibernate's entity-name feature

Parameters:

entityName - The entity-name

Returns:

The entity descriptor

entity

<X> EntityTypeDescriptor<X> entity(Class<X> cls)

Specified by:

entity in interface Metamodel

managedType

<X> ManagedTypeDescriptor<X> managedType(Class<X> cls)

Specified by:

managedType in interface Metamodel

embeddable

<X> EmbeddedTypeDescriptor<X> embeddable(Class<X> cls)

Specified by:

embeddable in interface Metamodel

getEntityTypeByName

default EntityTypeDescriptor getEntityTypeByName(String entityName)