Top Description Inners Methods
org.hibernate.boot.spi

public Interface InFlightMetadataCollector

extends Mapping, MetadataImplementor
Known Direct Implementers
org.hibernate.boot.internal.InFlightMetadataCollectorImpl
Imports
java.io.Serializable, java.util.List, .Locale, .Map, javax.persistence.AttributeConverter, org.hibernate.DuplicateMappingException, .HibernateException, .MappingException, org.hibernate.annotations.AnyMetaDef, org.hibernate.annotations.common.reflection.XClass, org.hibernate.boot.internal.ClassmateContext, org.hibernate.boot.model.IdentifierGeneratorDefinition, .TypeDefinition, org.hibernate.boot.model.convert.internal.InstanceBasedConverterDescriptor, org.hibernate.boot.model.convert.spi.ConverterAutoApplyHandler, .ConverterDescriptor, org.hibernate.boot.model.naming.Identifier, org.hibernate.boot.model.relational.AuxiliaryDatabaseObject, .Database, .QualifiedTableName, org.hibernate.boot.model.source.spi.LocalMetadataBuildingContext, org.hibernate.cfg.AnnotatedClassType, .AttributeConverterDefinition, .JPAIndexHolder, .PropertyData, .SecondPass, .UniqueConstraintHolder, org.hibernate.cfg.annotations.NamedEntityGraphDefinition, .NamedProcedureCallDefinition, org.hibernate.engine.ResultSetMappingDefinition, org.hibernate.engine.spi.FilterDefinition, .Mapping, .NamedQueryDefinition, .NamedSQLQueryDefinition, org.hibernate.mapping.Collection, .Column, .FetchProfile, .Join, .MappedSuperclass, .PersistentClass, .Table

An in-flight representation of Metadata while Metadata is being built.
Author
Steve Ebersole
Since
5.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
public static class
public static interface

Method Summary

Modifier and TypeMethod and Description
public void
addAnyMetaDef(AnyMetaDef defAnn)

Deprecated as a consequence of AnyMetaDef being deprecated.
public default void
addAttributeConverter(AttributeConverterDefinition converter)

Deprecated AttributeConverterDefinition forces early resolution of the AttributeConverter instance, which precludes resolution of the converter from org.hibernate.resource.beans.spi.ManagedBeanRegistry (CDI, etc).
public void
public void
addAttributeConverter(Class<? extends AttributeConverter<X, Y>> converterClass)

public void
addAuxiliaryDatabaseObject(AuxiliaryDatabaseObject
The metadata.
auxiliaryDatabaseObject
)

Add metadata pertaining to an auxiliary database object to this repository.

public AnnotatedClassType
public void
addCollectionBinding(Collection
The collection metadata
collection
)

Add collection mapping metadata to this repository.

public void
addColumnNameBinding(Table table, Identifier logicalColumnName, Column column)

Deprecated as a consequence of Table being deprecated.
public void
addColumnNameBinding(Table table, String logicalColumnName, Column column)

Deprecated as a consequence of Table being deprecated.
public void
public void
public void
public void
public void
public void
public Table

Returns:

The created table metadata.
addDenormalizedTable
(String
The named schema in which the table belongs (or null).
schema
,
String
The named catalog in which the table belongs (or null).
catalog
,
String
The table name
name
,
boolean
Is the table abstract (i.e. not really existing in the DB)?
isAbstract
,
String
A select statement which defines a logical table, much like a DB view.
subselect
,
Table
???
includedTable
)

Deprecated as a consequence of Table being deprecated.
Adds a 'denormalized table' to this repository.
public void
addEntityBinding(PersistentClass
The entity metadata
persistentClass
)

Add the PersistentClass for an entity mapping.

public InFlightMetadataCollector.EntityTableXref
addEntityTableXref(String entityName, Identifier primaryTableLogicalName, Table primaryTable, InFlightMetadataCollector.EntityTableXref superEntityTableXref)

Deprecated as a consequence of Table being deprecated.
public void
public void
addFilterDefinition(FilterDefinition
The filter definition to add.
definition
)

Adds a filter definition to this repository.

public void
public void
addImport(String
The entity name being renamed.
entityName
,
String
The rename
rename
)

Adds an import (HQL entity rename).

public void
addJpaIndexHolders(Table table, List<JPAIndexHolder> jpaIndexHolders)

Deprecated as a consequence of Table being deprecated.
public void
addMappedBy(String name, String mappedBy, String propertyName)

public void
addMappedSuperclass(Class<T> type, MappedSuperclass mappedSuperclass)

public void
addNamedEntityGraph(NamedEntityGraphDefinition
The procedure call information
namedEntityGraphDefinition
)

Adds metadata for a named entity graph to this repository

public void
addNamedNativeQuery(NamedSQLQueryDefinition
The metadata
query
)

Adds metadata for a named SQL query to this repository.

public void
addNamedProcedureCallDefinition(NamedProcedureCallDefinition
The procedure call information
definition
)

Adds metadata for a named stored procedure call to this repository.

public void
addNamedQuery(NamedQueryDefinition
The metadata
query
)

Adds metadata for a named query to this repository.

public void
addPropertyAnnotatedWithMapsId(XClass entity, PropertyData propertyAnnotatedElement)

public void
public void
addPropertyReference(String entityName, String propertyName)

public void
addPropertyReferencedAssociation(String s, String propertyName, String syntheticPropertyName)

public void
addResultSetMapping(ResultSetMappingDefinition
The metadata
sqlResultSetMapping
)

Adds the metadata for a named SQL result set mapping to this repository.

public void
public void
addSecondPass(SecondPass sp, boolean onTopOfTheQueue)

public Table

Returns:

The created table metadata, or the existing reference.
addTable
(String
The named schema in which the table belongs (or null).
schema
,
String
The named catalog in which the table belongs (or null).
catalog
,
String
The table name
name
,
String
A select statement which defines a logical table, much like a DB view.
subselect
,
boolean
Is the table abstract (i.e. not really existing in the DB)?
isAbstract
)

Deprecated as a consequence of Table being deprecated.
Adds table metadata to this repository returning the created metadata instance.
public void
addTableNameBinding(Identifier logicalName, Table table)

Deprecated as a consequence of Table being deprecated.
public void
addTableNameBinding(String schema, String catalog, String logicalName, String realTableName, Table denormalizedSuperTable)

Deprecated as a consequence of Table being deprecated.
public void
addToOneAndIdProperty(XClass entity, PropertyData propertyAnnotatedElement)

public void
addTypeDefinition(TypeDefinition
The named type definition to add.
typeDefinition
)

Adds a type definition to this metadata repository.

public void
addUniqueConstraintHolders(Table table, List<UniqueConstraintHolder> uniqueConstraints)

Deprecated as a consequence of Table being deprecated.
public void
addUniqueConstraints(Table table, List<E> uniqueConstraints)

Deprecated as a consequence of Table being deprecated.
public void
addUniquePropertyReference(String entityName, String propertyName)

public AnyMetaDef
getAnyMetaDef(String anyMetaDefName)

Deprecated as a consequence of AnyMetaDef being deprecated.
public ConverterAutoApplyHandler
public BootstrapContext
public ClassmateContext

Returns:

Access to the shared Classmate delegates.
getClassmateContext
()

Deprecated Use BootstrapContext#getClassmateContext() instead.
Access to the shared Classmate objects used throughout Hibernate's bootstrap process.
public AnnotatedClassType
public Map<String, PersistentClass>
getEntityBindingMap()

Needed for SecondPass handling

public InFlightMetadataCollector.EntityTableXref
public String
getFromMappedBy(String ownerEntityName, String propertyName)

public Map<String, Join>
getJoins(String entityName)

public String
getLogicalColumnName(Table table, Identifier physicalName)

Deprecated as a consequence of Table being deprecated.
public String
getLogicalColumnName(Table table, String physicalName)

Deprecated as a consequence of Table being deprecated.
public String
getLogicalTableName(Table ownerTable)

Deprecated as a consequence of Table being deprecated.
public MappedSuperclass
public String
getPhysicalColumnName(Table table, Identifier logicalName)

Deprecated as a consequence of Table being deprecated.
public String
getPhysicalColumnName(Table table, String logicalName)

Deprecated as a consequence of Table being deprecated.
public String
public String
public PropertyData
getPropertyAnnotatedWithIdAndToOne(XClass persistentXClass, String propertyName)

public PropertyData
getPropertyAnnotatedWithMapsId(XClass persistentXClass, String propertyName)

public String
public boolean
public NaturalIdUniqueKeyBinder
public void
Inherited from org.hibernate.boot.spi.MetadataImplementor:
buildNamedQueryRepositorygetMappedSuperclassMappingsCopygetMetadataBuildingOptionsgetTypeConfigurationgetTypeResolverinitSessionFactoryvalidate
Inherited from org.hibernate.engine.spi.Mapping:
getIdentifierGeneratorFactorygetIdentifierPropertyNamegetIdentifierTypegetReferencedPropertyType

Method Detail

addAnyMetaDefback to summary
public void addAnyMetaDef(AnyMetaDef defAnn)

Deprecated

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

addAttributeConverterback to summary
public default void addAttributeConverter(AttributeConverterDefinition converter)

Deprecated

AttributeConverterDefinition forces early resolution of the AttributeConverter instance, which precludes resolution of the converter from org.hibernate.resource.beans.spi.ManagedBeanRegistry (CDI, etc). Instead one of: * addAttributeConverter(ConverterDescriptor) * addAttributeConverter(Class) * addAttributeConverter(Class)

Annotations
@Deprecated
addAttributeConverterback to summary
public void addAttributeConverter(ConverterDescriptor descriptor)
addAttributeConverterback to summary
public void addAttributeConverter(Class<? extends AttributeConverter<X, Y>> converterClass)
addAuxiliaryDatabaseObjectback to summary
public void addAuxiliaryDatabaseObject(AuxiliaryDatabaseObject auxiliaryDatabaseObject)

Add metadata pertaining to an auxiliary database object to this repository.

Parameters
auxiliaryDatabaseObject:AuxiliaryDatabaseObject

The metadata.

addClassTypeback to summary
public AnnotatedClassType addClassType(XClass clazz)
addCollectionBindingback to summary
public void addCollectionBinding(Collection collection) throws DuplicateMappingException

Add collection mapping metadata to this repository.

Parameters
collection:Collection

The collection metadata

Exceptions
DuplicateMappingException:
Indicates there was already an entry corresponding to the given collection role
addColumnNameBindingback to summary
public void addColumnNameBinding(Table table, Identifier logicalColumnName, Column column)

Deprecated

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

addColumnNameBindingback to summary
public void addColumnNameBinding(Table table, String logicalColumnName, Column column)

Deprecated

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

addDefaultIdentifierGeneratorback to summary
public void addDefaultIdentifierGenerator(IdentifierGeneratorDefinition generatorDefinition)
addDefaultNamedNativeQueryback to summary
public void addDefaultNamedNativeQuery(NamedSQLQueryDefinition query)
addDefaultNamedProcedureCallDefinitionback to summary
public void addDefaultNamedProcedureCallDefinition(NamedProcedureCallDefinition procedureCallDefinition)
addDefaultQueryback to summary
public void addDefaultQuery(NamedQueryDefinition queryDefinition)
addDefaultResultSetMappingback to summary
public void addDefaultResultSetMapping(ResultSetMappingDefinition definition)
addDelayedPropertyReferenceHandlerback to summary
public void addDelayedPropertyReferenceHandler(InFlightMetadataCollector.DelayedPropertyReferenceHandler handler)
addDenormalizedTableback to summary
public Table addDenormalizedTable(String schema, String catalog, String name, boolean isAbstract, String subselect, Table includedTable) throws DuplicateMappingException

Deprecated

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

Adds a 'denormalized table' to this repository.

Parameters
schema:String

The named schema in which the table belongs (or null).

catalog:String

The named catalog in which the table belongs (or null).

name:String

The table name

isAbstract:boolean

Is the table abstract (i.e. not really existing in the DB)?

subselect:String

A select statement which defines a logical table, much like a DB view.

includedTable:Table

???

Returns:Table

The created table metadata.

Exceptions
DuplicateMappingException:
If such a table mapping already exists.
addEntityBindingback to summary
public void addEntityBinding(PersistentClass persistentClass) throws DuplicateMappingException

Add the PersistentClass for an entity mapping.

Parameters
persistentClass:PersistentClass

The entity metadata

Exceptions
DuplicateMappingException:
Indicates there was already an entry corresponding to the given entity name.
addEntityTableXrefback to summary
public InFlightMetadataCollector.EntityTableXref addEntityTableXref(String entityName, Identifier primaryTableLogicalName, Table primaryTable, InFlightMetadataCollector.EntityTableXref superEntityTableXref)

Deprecated

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

addFetchProfileback to summary
public void addFetchProfile(FetchProfile profile)
addFilterDefinitionback to summary
public void addFilterDefinition(FilterDefinition definition)

Adds a filter definition to this repository.

Parameters
definition:FilterDefinition

The filter definition to add.

Exceptions
DuplicateMappingException:
If a FilterDefinition already exists with that name.
addIdentifierGeneratorback to summary
public void addIdentifierGenerator(IdentifierGeneratorDefinition generatorDefinition)
addImportback to summary
public void addImport(String entityName, String rename) throws DuplicateMappingException

Adds an import (HQL entity rename).

Parameters
entityName:String

The entity name being renamed.

rename:String

The rename

Exceptions
DuplicateMappingException:
If rename already is mapped to another entity name in this repository.
addJpaIndexHoldersback to summary
public void addJpaIndexHolders(Table table, List<JPAIndexHolder> jpaIndexHolders)

Deprecated

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

addMappedByback to summary
public void addMappedBy(String name, String mappedBy, String propertyName)
addMappedSuperclassback to summary
public void addMappedSuperclass(Class<T> type, MappedSuperclass mappedSuperclass)
addNamedEntityGraphback to summary
public void addNamedEntityGraph(NamedEntityGraphDefinition namedEntityGraphDefinition)

Adds metadata for a named entity graph to this repository

Parameters
namedEntityGraphDefinition:NamedEntityGraphDefinition

The procedure call information

Exceptions
DuplicateMappingException:
If an entity graph already exists with that name.
addNamedNativeQueryback to summary
public void addNamedNativeQuery(NamedSQLQueryDefinition query) throws DuplicateMappingException

Adds metadata for a named SQL query to this repository.

Parameters
query:NamedSQLQueryDefinition

The metadata

Exceptions
DuplicateMappingException:
If a query already exists with that name.
addNamedProcedureCallDefinitionback to summary
public void addNamedProcedureCallDefinition(NamedProcedureCallDefinition definition) throws DuplicateMappingException

Adds metadata for a named stored procedure call to this repository.

Parameters
definition:NamedProcedureCallDefinition

The procedure call information

Exceptions
DuplicateMappingException:
If a query already exists with that name.
addNamedQueryback to summary
public void addNamedQuery(NamedQueryDefinition query) throws DuplicateMappingException

Adds metadata for a named query to this repository.

Parameters
query:NamedQueryDefinition

The metadata

Exceptions
DuplicateMappingException:
If a query already exists with that name.
addPropertyAnnotatedWithMapsIdback to summary
public void addPropertyAnnotatedWithMapsId(XClass entity, PropertyData propertyAnnotatedElement)
addPropertyAnnotatedWithMapsIdSpecjback to summary
public void addPropertyAnnotatedWithMapsIdSpecj(XClass entity, PropertyData specJPropertyData, String s)
addPropertyReferenceback to summary
public void addPropertyReference(String entityName, String propertyName)
addPropertyReferencedAssociationback to summary
public void addPropertyReferencedAssociation(String s, String propertyName, String syntheticPropertyName)
addResultSetMappingback to summary
public void addResultSetMapping(ResultSetMappingDefinition sqlResultSetMapping) throws DuplicateMappingException

Adds the metadata for a named SQL result set mapping to this repository.

Parameters
sqlResultSetMapping:ResultSetMappingDefinition

The metadata

Exceptions
DuplicateMappingException:
If metadata for another SQL result mapping was already found under the given name.
addSecondPassback to summary
public void addSecondPass(SecondPass secondPass)
addSecondPassback to summary
public void addSecondPass(SecondPass sp, boolean onTopOfTheQueue)
addTableback to summary
public Table addTable(String schema, String catalog, String name, String subselect, boolean isAbstract)

Deprecated

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

Adds table metadata to this repository returning the created metadata instance.

Parameters
schema:String

The named schema in which the table belongs (or null).

catalog:String

The named catalog in which the table belongs (or null).

name:String

The table name

subselect:String

A select statement which defines a logical table, much like a DB view.

isAbstract:boolean

Is the table abstract (i.e. not really existing in the DB)?

Returns:Table

The created table metadata, or the existing reference.

addTableNameBindingback to summary
public void addTableNameBinding(Identifier logicalName, Table table)

Deprecated

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

addTableNameBindingback to summary
public void addTableNameBinding(String schema, String catalog, String logicalName, String realTableName, Table denormalizedSuperTable)

Deprecated

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

addToOneAndIdPropertyback to summary
public void addToOneAndIdProperty(XClass entity, PropertyData propertyAnnotatedElement)
addTypeDefinitionback to summary
public void addTypeDefinition(TypeDefinition typeDefinition)

Adds a type definition to this metadata repository.

Parameters
typeDefinition:TypeDefinition

The named type definition to add.

Exceptions
DuplicateMappingException:
If a TypeDefinition already exists with that name.
addUniqueConstraintHoldersback to summary
public void addUniqueConstraintHolders(Table table, List<UniqueConstraintHolder> uniqueConstraints)

Deprecated

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

addUniqueConstraintsback to summary
public void addUniqueConstraints(Table table, List<E> uniqueConstraints)

Deprecated

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

addUniquePropertyReferenceback to summary
public void addUniquePropertyReference(String entityName, String propertyName)
getAnyMetaDefback to summary
public AnyMetaDef getAnyMetaDef(String anyMetaDefName)

Deprecated

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

getAttributeConverterAutoApplyHandlerback to summary
public ConverterAutoApplyHandler getAttributeConverterAutoApplyHandler()
getBootstrapContextback to summary
public BootstrapContext getBootstrapContext()
getClassmateContextback to summary
public ClassmateContext getClassmateContext()

Access to the shared Classmate objects used throughout Hibernate's bootstrap process.

Returns:ClassmateContext

Access to the shared Classmate delegates.

Annotations
@Deprecated
getClassTypeback to summary
public AnnotatedClassType getClassType(XClass clazz)
getEntityBindingMapback to summary
public Map<String, PersistentClass> getEntityBindingMap()

Needed for SecondPass handling

getEntityTableXrefback to summary
public InFlightMetadataCollector.EntityTableXref getEntityTableXref(String entityName)
getFromMappedByback to summary
public String getFromMappedBy(String ownerEntityName, String propertyName)
getJoinsback to summary
public Map<String, Join> getJoins(String entityName)
getLogicalColumnNameback to summary
public String getLogicalColumnName(Table table, Identifier physicalName)

Deprecated

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

getLogicalColumnNameback to summary
public String getLogicalColumnName(Table table, String physicalName)

Deprecated

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

getLogicalTableNameback to summary
public String getLogicalTableName(Table ownerTable)

Deprecated

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

getMappedSuperclassback to summary
public MappedSuperclass getMappedSuperclass(Class<T> type)
getPhysicalColumnNameback to summary
public String getPhysicalColumnName(Table table, Identifier logicalName) throws MappingException

Deprecated

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

getPhysicalColumnNameback to summary
public String getPhysicalColumnName(Table table, String logicalName) throws MappingException

Deprecated

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

getPhysicalTableNameback to summary
public String getPhysicalTableName(Identifier logicalName)
getPhysicalTableNameback to summary
public String getPhysicalTableName(String logicalName)
getPropertyAnnotatedWithIdAndToOneback to summary
public PropertyData getPropertyAnnotatedWithIdAndToOne(XClass persistentXClass, String propertyName)
getPropertyAnnotatedWithMapsIdback to summary
public PropertyData getPropertyAnnotatedWithMapsId(XClass persistentXClass, String propertyName)
getPropertyReferencedAssociationback to summary
public String getPropertyReferencedAssociation(String entityName, String mappedBy)
isInSecondPassback to summary
public boolean isInSecondPass()
locateNaturalIdUniqueKeyBinderback to summary
public NaturalIdUniqueKeyBinder locateNaturalIdUniqueKeyBinder(String entityName)
registerNaturalIdUniqueKeyBinderback to summary
public void registerNaturalIdUniqueKeyBinder(String entityName, NaturalIdUniqueKeyBinder ukBinder)
org.hibernate.boot.spi back to summary

public Interface InFlightMetadataCollector.DelayedPropertyReferenceHandler

extends Serializable
Known Direct Implementers
org.hibernate.boot.internal.InFlightMetadataCollectorImpl.DelayedPropertyReferenceHandlerAnnotationImpl, org.hibernate.boot.model.source.internal.hbm.ModelBinder.DelayedPropertyReferenceHandlerImpl

Method Summary

Modifier and TypeMethod and Description
public void

Method Detail

processback to summary
public void process(InFlightMetadataCollector metadataCollector)
org.hibernate.boot.spi back to summary

public Class InFlightMetadataCollector.DuplicateSecondaryTableException

extends HibernateException
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final Identifier

Constructor Summary

AccessConstructor and Description
public

Field Detail

tableNameback to summary
private final Identifier tableName

Constructor Detail

DuplicateSecondaryTableExceptionback to summary
public DuplicateSecondaryTableException(Identifier tableName)
org.hibernate.boot.spi back to summary

public Interface InFlightMetadataCollector.EntityTableXref

Known Direct Implementers
org.hibernate.boot.internal.InFlightMetadataCollectorImpl.EntityTableXrefImpl

Method Summary

Modifier and TypeMethod and Description
public void
addSecondaryTable(LocalMetadataBuildingContext buildingContext, Identifier logicalName, Join secondaryTableJoin)

public void
addSecondaryTable(QualifiedTableName logicalName, Join secondaryTableJoin)

public Table
getPrimaryTable()

Deprecated as a consequence of Table being deprecated.
public Join
public Table
resolveTable(Identifier tableName)

Deprecated as a consequence of Table being deprecated.

Method Detail

addSecondaryTableback to summary
public void addSecondaryTable(LocalMetadataBuildingContext buildingContext, Identifier logicalName, Join secondaryTableJoin)
addSecondaryTableback to summary
public void addSecondaryTable(QualifiedTableName logicalName, Join secondaryTableJoin)
getPrimaryTableback to summary
public Table getPrimaryTable()

Deprecated

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

locateJoinback to summary
public Join locateJoin(Identifier tableName)
resolveTableback to summary
public Table resolveTable(Identifier tableName)

Deprecated

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