org.hibernate.boot.internal

Class MetadataImpl

java.lang.Object

org.hibernate.boot.internal.MetadataImpl

All Implemented Interfaces:

Serializable, Metadata, MetadataImplementor, Mapping

public class MetadataImpl
extends Object
implements MetadataImplementor, Serializable

Container for configuration data collected during binding the metamodel.

Author:

Steve Ebersole, Hardy Ferentschik, Gail Badner

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description

MetadataImpl(UUID uuid, MetadataBuildingOptions metadataBuildingOptions, TypeResolver typeResolver, MutableIdentifierGeneratorFactory identifierGeneratorFactory, Map<String,PersistentClass> entityBindingMap, Map<Class,MappedSuperclass> mappedSuperclassMap, Map<String,Collection> collectionBindingMap, Map<String,TypeDefinition> typeDefinitionMap, Map<String,FilterDefinition> filterDefinitionMap, Map<String,FetchProfile> fetchProfileMap, Map<String,String> imports, Map<String,IdentifierGeneratorDefinition> idGeneratorDefinitionMap, Map<String,NamedQueryDefinition> namedQueryMap, Map<String,NamedSQLQueryDefinition> namedNativeQueryMap, Map<String,NamedProcedureCallDefinition> namedProcedureCallMap, Map<String,ResultSetMappingDefinition> sqlResultSetMappingMap, Map<String,NamedEntityGraphDefinition> namedEntityGraphMap, Map<String,SQLFunction> sqlFunctionMap, Database database)

Method Summary

Modifier and Type	Method and Description
NamedQueryRepository	buildNamedQueryRepository(SessionFactoryImpl sessionFactory)
Map<String,ProcedureCallMemento>	buildProcedureCallMementos(SessionFactoryImpl sessionFactory)
SessionFactory	buildSessionFactory() Short-hand form of building a SessionFactory through the builder without any additional option overrides.
Collection<Table>	collectTableMappings()
Collection	getCollectionBinding(String role) Retrieves the collection mapping metadata for the given collection role.
Collection<Collection>	getCollectionBindings() Retrieves the Collection metadata representation for known all collections.
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 known all 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.
IdentifierGeneratorDefinition	getIdentifierGenerator(String name)
IdentifierGeneratorFactory	getIdentifierGeneratorFactory() Allow access to the id generator factory, though this is only needed/allowed from configuration.
String	getIdentifierPropertyName(String entityName)
Type	getIdentifierType(String entityName)
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()
NamedSQLQueryDefinition	getNamedNativeQueryDefinition(String name) Retrieve named SQL query metadata.
Collection<NamedSQLQueryDefinition>	getNamedNativeQueryDefinitions()
Collection<NamedProcedureCallDefinition>	getNamedProcedureCallDefinitions()
NamedQueryDefinition	getNamedQueryDefinition(String name) Retrieve named query metadata by name.
Collection<NamedQueryDefinition>	getNamedQueryDefinitions()
Type	getReferencedPropertyType(String entityName, String propertyName)
ResultSetMappingDefinition	getResultSetMapping(String name) Retrieve the metadata for a named SQL result set mapping.
Map<String,ResultSetMappingDefinition>	getResultSetMappingDefinitions()
SessionFactoryBuilder	getSessionFactoryBuilder() Get the builder for SessionFactory instances based on this metamodel,
Map<String,SQLFunction>	getSqlFunctionMap()
TypeDefinition	getTypeDefinition(String typeName) Retrieve a type definition by name.
TypeResolver	getTypeResolver()
UUID	getUUID() Gets the UUID for this metamodel.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataImpl

public MetadataImpl(UUID uuid,
                    MetadataBuildingOptions metadataBuildingOptions,
                    TypeResolver typeResolver,
                    MutableIdentifierGeneratorFactory identifierGeneratorFactory,
                    Map<String,PersistentClass> entityBindingMap,
                    Map<Class,MappedSuperclass> mappedSuperclassMap,
                    Map<String,Collection> collectionBindingMap,
                    Map<String,TypeDefinition> typeDefinitionMap,
                    Map<String,FilterDefinition> filterDefinitionMap,
                    Map<String,FetchProfile> fetchProfileMap,
                    Map<String,String> imports,
                    Map<String,IdentifierGeneratorDefinition> idGeneratorDefinitionMap,
                    Map<String,NamedQueryDefinition> namedQueryMap,
                    Map<String,NamedSQLQueryDefinition> namedNativeQueryMap,
                    Map<String,NamedProcedureCallDefinition> namedProcedureCallMap,
                    Map<String,ResultSetMappingDefinition> sqlResultSetMappingMap,
                    Map<String,NamedEntityGraphDefinition> namedEntityGraphMap,
                    Map<String,SQLFunction> sqlFunctionMap,
                    Database database)

Method Detail

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:

getTypeResolver

public TypeResolver getTypeResolver()

Specified by:

getTypeResolver in interface MetadataImplementor

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.

getIdentifierGeneratorFactory

public IdentifierGeneratorFactory getIdentifierGeneratorFactory()

Description copied from interface: Mapping

Allow access to the id generator factory, though this is only needed/allowed from configuration.

Specified by:

getIdentifierGeneratorFactory in interface Mapping

Returns:

Access to the identifier generator factory

getEntityBindings

public Collection<PersistentClass> getEntityBindings()

Description copied from interface: Metadata

Retrieves the PersistentClass entity metadata representation for known all 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 known all 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

getNamedQueryDefinition

public NamedQueryDefinition getNamedQueryDefinition(String name)

Description copied from interface: Metadata

Retrieve named query metadata by name.

Specified by:

getNamedQueryDefinition in interface Metadata

Parameters:

name - The query name

Returns:

The named query metadata, or null.

getNamedQueryDefinitions

public Collection<NamedQueryDefinition> getNamedQueryDefinitions()

Specified by:

getNamedQueryDefinitions in interface Metadata

getNamedNativeQueryDefinition

public NamedSQLQueryDefinition getNamedNativeQueryDefinition(String name)

Description copied from interface: Metadata

Retrieve named SQL query metadata.

Specified by:

getNamedNativeQueryDefinition in interface Metadata

Parameters:

name - The SQL query name.

Returns:

The named query metadata, or null

getNamedNativeQueryDefinitions

public Collection<NamedSQLQueryDefinition> getNamedNativeQueryDefinitions()

Specified by:

getNamedNativeQueryDefinitions in interface Metadata

getNamedProcedureCallDefinitions

public Collection<NamedProcedureCallDefinition> getNamedProcedureCallDefinitions()

Specified by:

getNamedProcedureCallDefinitions in interface Metadata

getResultSetMapping

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

getResultSetMappingDefinitions

public Map<String,ResultSetMappingDefinition> getResultSetMappingDefinitions()

Specified by:

getResultSetMappingDefinitions 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

Parameters:

typeName - The name of the type definition to retrieve.

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

getSqlFunctionMap

public Map<String,SQLFunction> getSqlFunctionMap()

Specified by:

getSqlFunctionMap in interface Metadata

collectTableMappings

public Collection<Table> collectTableMappings()

Specified by:

collectTableMappings in interface Metadata

buildNamedQueryRepository

public NamedQueryRepository buildNamedQueryRepository(SessionFactoryImpl sessionFactory)

Specified by:

buildNamedQueryRepository in interface MetadataImplementor

buildProcedureCallMementos

public Map<String,ProcedureCallMemento> buildProcedureCallMementos(SessionFactoryImpl sessionFactory)

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

getIdentifierType

public Type getIdentifierType(String entityName)
                       throws MappingException

Specified by:

getIdentifierType in interface Mapping

Throws:

MappingException

getIdentifierPropertyName

public String getIdentifierPropertyName(String entityName)
                                 throws MappingException

Specified by:

getIdentifierPropertyName in interface Mapping

Throws:

MappingException

getReferencedPropertyType

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

Specified by:

getReferencedPropertyType in interface Mapping

Throws:

MappingException