Package org.hibernate.boot.spi

Class AbstractDelegatingMetadata

java.lang.Object

org.hibernate.boot.spi.AbstractDelegatingMetadata

All Implemented Interfaces:

Metadata, MetadataImplementor, Mapping

public abstract class AbstractDelegatingMetadata
extends Object
implements MetadataImplementor

Convenience base class for custom implementors of MetadataImplementor using delegation.

Constructor Summary

Constructors

Constructor	Description
AbstractDelegatingMetadata(MetadataImplementor delegate)

Method Summary

Modifier and Type	Method	Description
NamedObjectRepository	buildNamedQueryRepository(SessionFactoryImplementor sessionFactory)
SessionFactory	buildSessionFactory()	Short-hand form of building a SessionFactory through the builder without any additional option overrides.
Collection<Table>	collectTableMappings()
protected MetadataImplementor	delegate()
Collection	getCollectionBinding(String role)	Retrieves the collection mapping metadata for the given collection role.
Collection<Collection>	getCollectionBindings()	Retrieves the Collection metadata representation for all known collections.
Set<String>	getContributors()	All of the known model contributors
Database	getDatabase()	Retrieve the database model.
PersistentClass	getEntityBinding(String entityName)	Retrieves the PersistentClass entity mapping metadata representation for the given entity name.
Collection<PersistentClass>	getEntityBindings()	Retrieves the PersistentClass entity metadata representation for all known entities.
FetchProfile	getFetchProfile(String name)
Collection<FetchProfile>	getFetchProfiles()
FilterDefinition	getFilterDefinition(String name)	Retrieves a filter definition by name.
Map<String,FilterDefinition>	getFilterDefinitions()	Retrieves the complete map of filter definitions.
SqmFunctionRegistry	getFunctionRegistry()	Access to the SqmFunctionRegistry belonging to the BootstrapContext
Component	getGenericComponent(Class<?> componentClass)
IdentifierGeneratorDefinition	getIdentifierGenerator(String name)
String	getIdentifierPropertyName(String className)
Type	getIdentifierType(String className)
Map<String,String>	getImports()	Retrieves all defined imports (class renames).
Set<MappedSuperclass>	getMappedSuperclassMappingsCopy()
MetadataBuildingOptions	getMetadataBuildingOptions()	Access to the options used to build this Metadata
NamedEntityGraphDefinition	getNamedEntityGraph(String name)
Map<String,NamedEntityGraphDefinition>	getNamedEntityGraphs()
NamedHqlQueryDefinition	getNamedHqlQueryMapping(String name)	Retrieve named query metadata by name.
NamedNativeQueryDefinition	getNamedNativeQueryMapping(String name)	Retrieve named SQL query metadata.
NamedProcedureCallDefinition	getNamedProcedureCallMapping(String name)	Retrieve named procedure metadata.
Type	getReferencedPropertyType(String className, String propertyName)
NamedResultSetMappingDescriptor	getResultSetMapping(String name)	Retrieve the metadata for a named SQL result set mapping.
SessionFactoryBuilder	getSessionFactoryBuilder()	Get the builder for SessionFactory instances based on this metamodel.
Map<String,SqmFunctionDescriptor>	getSqlFunctionMap()
TypeConfiguration	getTypeConfiguration()	Access to the TypeConfiguration belonging to the BootstrapContext
TypeDefinition	getTypeDefinition(String typeName)	Retrieve a type definition by name.
UUID	getUUID()	Gets the UUID for this metamodel.
void	initSessionFactory(SessionFactoryImplementor sessionFactory)
void	orderColumns(boolean forceOrdering)
void	validate()
void	visitNamedHqlQueryDefinitions(Consumer<NamedHqlQueryDefinition> definitionConsumer)	Visit all named HQL query definitions
void	visitNamedNativeQueryDefinitions(Consumer<NamedNativeQueryDefinition> definitionConsumer)	Visit all named native query definitions
void	visitNamedProcedureCallDefinition(Consumer<NamedProcedureCallDefinition> definitionConsumer)	Visit all named callable query definitions
void	visitNamedResultSetMappingDefinition(Consumer<NamedResultSetMappingDescriptor> definitionConsumer)	Visit all named SQL result set mapping definitions
void	visitRegisteredComponents(Consumer<Component> consumer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractDelegatingMetadata

public AbstractDelegatingMetadata(MetadataImplementor delegate)

Method Detail

delegate

protected MetadataImplementor delegate()

getIdentifierType

public Type getIdentifierType(String className)
                       throws MappingException

Specified by:

getIdentifierType in interface Mapping

Throws:

MappingException

getIdentifierPropertyName

public String getIdentifierPropertyName(String className)
                                 throws MappingException

Specified by:

getIdentifierPropertyName in interface Mapping

Throws:

MappingException

getReferencedPropertyType

public Type getReferencedPropertyType(String className,
                                      String propertyName)
                               throws MappingException

Specified by:

getReferencedPropertyType in interface Mapping

Throws:

MappingException

getSessionFactoryBuilder

public SessionFactoryBuilder getSessionFactoryBuilder()

Description copied from interface: Metadata

Get the builder for SessionFactory instances based on this metamodel.

Specified by:

getSessionFactoryBuilder in interface Metadata

Returns:

The builder for SessionFactory instances.

buildSessionFactory

public SessionFactory buildSessionFactory()

Description copied from interface: Metadata

Short-hand form of building a SessionFactory through the builder without any additional option overrides.

Specified by:

buildSessionFactory in interface Metadata

Returns:

THe built SessionFactory.

getUUID

public UUID getUUID()

Description copied from interface: Metadata

Gets the UUID for this metamodel.

Specified by:

getUUID in interface Metadata

Returns:

the UUID.

getDatabase

public Database getDatabase()

Description copied from interface: Metadata

Retrieve the database model.

Specified by:

getDatabase in interface Metadata

Returns:

The database model.

getEntityBindings

public Collection<PersistentClass> getEntityBindings()

Description copied from interface: Metadata

Retrieves the PersistentClass entity metadata representation for all known entities. Returned collection is immutable

Specified by:

getEntityBindings in interface Metadata

Returns:

All PersistentClass representations.

getEntityBinding

public PersistentClass getEntityBinding(String entityName)

Description copied from interface: Metadata

Retrieves the PersistentClass entity mapping metadata representation for the given entity name.

Specified by:

getEntityBinding in interface Metadata

Parameters:

entityName - The entity name for which to retrieve the metadata.

Returns:

The entity mapping metadata, or null if no matching entity found.

getCollectionBindings

public Collection<Collection> getCollectionBindings()

Description copied from interface: Metadata

Retrieves the Collection metadata representation for all known collections. Returned collection is immutable

Specified by:

getCollectionBindings in interface Metadata

Returns:

All Collection representations.

getCollectionBinding

public Collection getCollectionBinding(String role)

Description copied from interface: Metadata

Retrieves the collection mapping metadata for the given collection role.

Specified by:

getCollectionBinding in interface Metadata

Parameters:

role - The collection role for which to retrieve the metadata.

Returns:

The collection mapping metadata, or null if no matching collection found.

getImports

public Map<String,String> getImports()

Description copied from interface: Metadata

Retrieves all defined imports (class renames).

Specified by:

getImports in interface Metadata

Returns:

All imports

getNamedHqlQueryMapping

public NamedHqlQueryDefinition getNamedHqlQueryMapping(String name)

Description copied from interface: Metadata

Retrieve named query metadata by name.

Specified by:

getNamedHqlQueryMapping in interface Metadata

Returns:

The named query metadata, or null.

visitNamedHqlQueryDefinitions

public void visitNamedHqlQueryDefinitions(Consumer<NamedHqlQueryDefinition> definitionConsumer)

Description copied from interface: Metadata

Visit all named HQL query definitions

Specified by:

visitNamedHqlQueryDefinitions in interface Metadata

getNamedNativeQueryMapping

public NamedNativeQueryDefinition getNamedNativeQueryMapping(String name)

Description copied from interface: Metadata

Retrieve named SQL query metadata.

Specified by:

getNamedNativeQueryMapping in interface Metadata

Returns:

The named query metadata, or null

visitNamedNativeQueryDefinitions

public void visitNamedNativeQueryDefinitions(Consumer<NamedNativeQueryDefinition> definitionConsumer)

Description copied from interface: Metadata

Visit all named native query definitions

Specified by:

visitNamedNativeQueryDefinitions in interface Metadata

getNamedProcedureCallMapping

public NamedProcedureCallDefinition getNamedProcedureCallMapping(String name)

Description copied from interface: Metadata

Retrieve named procedure metadata.

Specified by:

getNamedProcedureCallMapping in interface Metadata

Returns:

The named procedure metadata, or null

visitNamedProcedureCallDefinition

public void visitNamedProcedureCallDefinition(Consumer<NamedProcedureCallDefinition> definitionConsumer)

Description copied from interface: Metadata

Visit all named callable query definitions

Specified by:

visitNamedProcedureCallDefinition in interface Metadata

getResultSetMapping

public NamedResultSetMappingDescriptor getResultSetMapping(String name)

Description copied from interface: Metadata

Retrieve the metadata for a named SQL result set mapping.

Specified by:

getResultSetMapping in interface Metadata

Parameters:

name - The mapping name.

Returns:

The named result set mapping metadata, or null if none found.

visitNamedResultSetMappingDefinition

public void visitNamedResultSetMappingDefinition(Consumer<NamedResultSetMappingDescriptor> definitionConsumer)

Description copied from interface: Metadata

Visit all named SQL result set mapping definitions

Specified by:

visitNamedResultSetMappingDefinition in interface Metadata

getTypeDefinition

public TypeDefinition getTypeDefinition(String typeName)

Description copied from interface: Metadata

Retrieve a type definition by name.

Specified by:

getTypeDefinition in interface Metadata

Returns:

The named type definition, or null

getFilterDefinitions

public Map<String,FilterDefinition> getFilterDefinitions()

Description copied from interface: Metadata

Retrieves the complete map of filter definitions. Returned map is immutable

Specified by:

getFilterDefinitions in interface Metadata

Returns:

The filter definition map.

getFilterDefinition

public FilterDefinition getFilterDefinition(String name)

Description copied from interface: Metadata

Retrieves a filter definition by name.

Specified by:

getFilterDefinition in interface Metadata

Parameters:

name - The name of the filter definition to retrieve .

Returns:

The filter definition, or null.

getFetchProfile

public FetchProfile getFetchProfile(String name)

Specified by:

getFetchProfile in interface Metadata

getFetchProfiles

public Collection<FetchProfile> getFetchProfiles()

Specified by:

getFetchProfiles in interface Metadata

getNamedEntityGraph

public NamedEntityGraphDefinition getNamedEntityGraph(String name)

Specified by:

getNamedEntityGraph in interface Metadata

getNamedEntityGraphs

public Map<String,NamedEntityGraphDefinition> getNamedEntityGraphs()

Specified by:

getNamedEntityGraphs in interface Metadata

getIdentifierGenerator

public IdentifierGeneratorDefinition getIdentifierGenerator(String name)

Specified by:

getIdentifierGenerator in interface Metadata

collectTableMappings

public Collection<Table> collectTableMappings()

Specified by:

collectTableMappings in interface Metadata

getSqlFunctionMap

public Map<String,SqmFunctionDescriptor> getSqlFunctionMap()

Specified by:

getSqlFunctionMap in interface Metadata

getMetadataBuildingOptions

public MetadataBuildingOptions getMetadataBuildingOptions()

Description copied from interface: MetadataImplementor

Access to the options used to build this Metadata

Specified by:

getMetadataBuildingOptions in interface MetadataImplementor

Returns:

The MetadataBuildingOptions

getTypeConfiguration

public TypeConfiguration getTypeConfiguration()

Description copied from interface: MetadataImplementor

Access to the TypeConfiguration belonging to the BootstrapContext

Specified by:

getTypeConfiguration in interface MetadataImplementor

getFunctionRegistry

public SqmFunctionRegistry getFunctionRegistry()

Description copied from interface: MetadataImplementor

Access to the SqmFunctionRegistry belonging to the BootstrapContext

Specified by:

getFunctionRegistry in interface MetadataImplementor

orderColumns

public void orderColumns(boolean forceOrdering)

Specified by:

orderColumns in interface MetadataImplementor

validate

public void validate()
              throws MappingException

Specified by:

validate in interface MetadataImplementor

Throws:

MappingException

getMappedSuperclassMappingsCopy

public Set<MappedSuperclass> getMappedSuperclassMappingsCopy()

Specified by:

getMappedSuperclassMappingsCopy in interface MetadataImplementor

initSessionFactory

public void initSessionFactory(SessionFactoryImplementor sessionFactory)

Specified by:

initSessionFactory in interface MetadataImplementor

visitRegisteredComponents

public void visitRegisteredComponents(Consumer<Component> consumer)

Specified by:

visitRegisteredComponents in interface MetadataImplementor

getGenericComponent

public Component getGenericComponent(Class<?> componentClass)

Specified by:

getGenericComponent in interface MetadataImplementor

buildNamedQueryRepository

public NamedObjectRepository buildNamedQueryRepository(SessionFactoryImplementor sessionFactory)

Specified by:

buildNamedQueryRepository in interface MetadataImplementor

getContributors

public Set<String> getContributors()

Description copied from interface: Metadata

All of the known model contributors

Specified by:

getContributors in interface Metadata