Top Description Methods
org.hibernate.boot

public Interface Metadata

extends Mapping
Known Direct Subinterfaces
org.hibernate.boot.spi.MetadataImplementor
Imports
java.util.Map, .Set, .UUID, java.util.function.Consumer, org.hibernate.SessionFactory, org.hibernate.boot.model.IdentifierGeneratorDefinition, .NamedEntityGraphDefinition, .TypeDefinition, org.hibernate.boot.model.relational.Database, org.hibernate.boot.query.NamedHqlQueryDefinition, .NamedNativeQueryDefinition, .NamedProcedureCallDefinition, .NamedResultSetMappingDescriptor, org.hibernate.engine.spi.FilterDefinition, .Mapping, org.hibernate.mapping.Collection, .FetchProfile, .PersistentClass, .Table, org.hibernate.query.sqm.function.SqmFunctionDescriptor

Deprecated

as a consequence of Mapping being deprecated. See corresponding docs for further information.

Represents the ORM model as determined by aggregating the provided mapping sources. An instance may be obtained by calling MetadataSources#buildMetadata().
Author
Steve Ebersole
Since
5.0

Method Summary

Modifier and TypeMethod and Description
public SessionFactory

Returns:

THe built SessionFactory.
buildSessionFactory()

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

public Collection<Table>
collectTableMappings()

public Collection

Returns:

The collection mapping metadata, or null if no matching collection found.
getCollectionBinding(String
The collection role for which to retrieve the metadata.
role)

Retrieves the collection mapping metadata for the given collection role.

public Collection<Collection>

Returns:

All Collection representations.
getCollectionBindings()

Retrieves the Collection metadata representation for all known collections.

public Set<String>
getContributors()

All of the known model contributors

public Database

Returns:

The database model.
getDatabase()

Retrieve the database model.

public PersistentClass

Returns:

The entity mapping metadata, or null if no matching entity found.
getEntityBinding(String
The entity name for which to retrieve the metadata.
entityName)

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

public Collection<PersistentClass>

Returns:

All PersistentClass representations.
getEntityBindings()

Retrieves the PersistentClass entity metadata representation for all known entities.

public FetchProfile
getFetchProfile(String name)

public Collection<FetchProfile>
getFetchProfiles()

public FilterDefinition

Returns:

The filter definition, or null.
getFilterDefinition(String
The name of the filter definition to retrieve .
name)

Retrieves a filter definition by name.

public Map<String, FilterDefinition>

Returns:

The filter definition map.
getFilterDefinitions()

Retrieves the complete map of filter definitions.

public IdentifierGeneratorDefinition
getIdentifierGenerator(String name)

public Map<String, String>

Returns:

All imports
getImports()

Retrieves all defined imports (class renames).

public NamedEntityGraphDefinition
getNamedEntityGraph(String name)

public Map<String, NamedEntityGraphDefinition>
getNamedEntityGraphs()

public NamedHqlQueryDefinition

Returns:

The named query metadata, or null.
getNamedHqlQueryMapping(String name)

Retrieve named query metadata by name.

public NamedNativeQueryDefinition

Returns:

The named query metadata, or null
getNamedNativeQueryMapping(String name)

Retrieve named SQL query metadata.

public NamedProcedureCallDefinition

Returns:

The named procedure metadata, or null
getNamedProcedureCallMapping(String name)

Retrieve named procedure metadata.

public NamedResultSetMappingDescriptor

Returns:

The named result set mapping metadata, or null if none found.
getResultSetMapping(String
The mapping name.
name)

Retrieve the metadata for a named SQL result set mapping.

public SessionFactoryBuilder

Returns:

The builder for SessionFactory instances.
getSessionFactoryBuilder()

Get the builder for SessionFactory instances based on this metamodel.

public Map<String, SqmFunctionDescriptor>
getSqlFunctionMap()

public TypeDefinition

Returns:

The named type definition, or null
getTypeDefinition(String typeName)

Retrieve a type definition by name.

public UUID

Returns:

the UUID.
getUUID()

Gets the UUID for this metamodel.

public void
visitNamedHqlQueryDefinitions(Consumer<NamedHqlQueryDefinition> definitionConsumer)

Visit all named HQL query definitions

public void
visitNamedNativeQueryDefinitions(Consumer<NamedNativeQueryDefinition> definitionConsumer)

Visit all named native query definitions

public void
visitNamedProcedureCallDefinition(Consumer<NamedProcedureCallDefinition> definitionConsumer)

Visit all named callable query definitions

public void
visitNamedResultSetMappingDefinition(Consumer<NamedResultSetMappingDescriptor> definitionConsumer)

Visit all named SQL result set mapping definitions

Inherited from org.hibernate.engine.spi.Mapping:
getIdentifierPropertyNamegetIdentifierTypegetReferencedPropertyType

Method Detail

buildSessionFactoryback to summary
public SessionFactory buildSessionFactory()

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

Returns:SessionFactory

THe built SessionFactory.

collectTableMappingsback to summary
public Collection<Table> collectTableMappings()
getCollectionBindingback to summary
public Collection getCollectionBinding(String role)

Retrieves the collection mapping metadata for the given collection role.

Parameters
role:String

The collection role for which to retrieve the metadata.

Returns:Collection

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

getCollectionBindingsback to summary
public Collection<Collection> getCollectionBindings()

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

Returns:Collection<Collection>

All Collection representations.

getContributorsback to summary
public Set<String> getContributors()

All of the known model contributors

getDatabaseback to summary
public Database getDatabase()

Retrieve the database model.

Returns:Database

The database model.

getEntityBindingback to summary
public PersistentClass getEntityBinding(String entityName)

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

Parameters
entityName:String

The entity name for which to retrieve the metadata.

Returns:PersistentClass

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

getEntityBindingsback to summary
public Collection<PersistentClass> getEntityBindings()

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

Returns:Collection<PersistentClass>

All PersistentClass representations.

getFetchProfileback to summary
public FetchProfile getFetchProfile(String name)
getFetchProfilesback to summary
public Collection<FetchProfile> getFetchProfiles()
getFilterDefinitionback to summary
public FilterDefinition getFilterDefinition(String name)

Retrieves a filter definition by name.

Parameters
name:String

The name of the filter definition to retrieve .

Returns:FilterDefinition

The filter definition, or null.

getFilterDefinitionsback to summary
public Map<String, FilterDefinition> getFilterDefinitions()

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

Returns:Map<String, FilterDefinition>

The filter definition map.

getIdentifierGeneratorback to summary
public IdentifierGeneratorDefinition getIdentifierGenerator(String name)
getImportsback to summary
public Map<String, String> getImports()

Retrieves all defined imports (class renames).

Returns:Map<String, String>

All imports

getNamedEntityGraphback to summary
public NamedEntityGraphDefinition getNamedEntityGraph(String name)
getNamedEntityGraphsback to summary
public Map<String, NamedEntityGraphDefinition> getNamedEntityGraphs()
getNamedHqlQueryMappingback to summary
public NamedHqlQueryDefinition getNamedHqlQueryMapping(String name)

Retrieve named query metadata by name.

Returns:NamedHqlQueryDefinition

The named query metadata, or null.

getNamedNativeQueryMappingback to summary
public NamedNativeQueryDefinition getNamedNativeQueryMapping(String name)

Retrieve named SQL query metadata.

Returns:NamedNativeQueryDefinition

The named query metadata, or null

getNamedProcedureCallMappingback to summary
public NamedProcedureCallDefinition getNamedProcedureCallMapping(String name)

Retrieve named procedure metadata.

Returns:NamedProcedureCallDefinition

The named procedure metadata, or null

getResultSetMappingback to summary
public NamedResultSetMappingDescriptor getResultSetMapping(String name)

Retrieve the metadata for a named SQL result set mapping.

Parameters
name:String

The mapping name.

Returns:NamedResultSetMappingDescriptor

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

getSessionFactoryBuilderback to summary
public SessionFactoryBuilder getSessionFactoryBuilder()

Get the builder for SessionFactory instances based on this metamodel.

Returns:SessionFactoryBuilder

The builder for SessionFactory instances.

getSqlFunctionMapback to summary
public Map<String, SqmFunctionDescriptor> getSqlFunctionMap()
getTypeDefinitionback to summary
public TypeDefinition getTypeDefinition(String typeName)

Retrieve a type definition by name.

Returns:TypeDefinition

The named type definition, or null

getUUIDback to summary
public UUID getUUID()

Gets the UUID for this metamodel.

Returns:UUID

the UUID.

visitNamedHqlQueryDefinitionsback to summary
public void visitNamedHqlQueryDefinitions(Consumer<NamedHqlQueryDefinition> definitionConsumer)

Visit all named HQL query definitions

visitNamedNativeQueryDefinitionsback to summary
public void visitNamedNativeQueryDefinitions(Consumer<NamedNativeQueryDefinition> definitionConsumer)

Visit all named native query definitions

visitNamedProcedureCallDefinitionback to summary
public void visitNamedProcedureCallDefinition(Consumer<NamedProcedureCallDefinition> definitionConsumer)

Visit all named callable query definitions

visitNamedResultSetMappingDefinitionback to summary
public void visitNamedResultSetMappingDefinition(Consumer<NamedResultSetMappingDescriptor> definitionConsumer)

Visit all named SQL result set mapping definitions