Top Description Fields Constructors Methods
org.hibernate.boot.model.source.internal.hbm

public Class MappingDocument

extends Object
implements HbmLocalMetadataBuildingContext, MetadataSourceProcessor
Class Inheritance
All Implemented Interfaces
org.hibernate.boot.model.source.spi.MetadataSourceProcessor, org.hibernate.boot.model.source.internal.hbm.HbmLocalMetadataBuildingContext, org.hibernate.boot.model.source.spi.LocalMetadataBuildingContext, org.hibernate.boot.spi.MetadataBuildingContext
Imports
java.util.Set, org.hibernate.boot.jaxb.Origin, org.hibernate.boot.jaxb.hbm.spi.EntityInfo, .JaxbHbmAuxiliaryDatabaseObjectType, .JaxbHbmClassRenameType, .JaxbHbmFetchProfileType, .JaxbHbmFilterDefinitionType, .JaxbHbmHibernateMapping, .JaxbHbmIdentifierGeneratorDefinitionType, .JaxbHbmNamedNativeQueryType, .JaxbHbmNamedQueryType, .JaxbHbmTypeDefinitionType, .ResultSetMappingBindingDefinition, org.hibernate.boot.model.naming.ObjectNameNormalizer, org.hibernate.boot.model.source.internal.OverriddenMappingDefaults, org.hibernate.boot.model.source.spi.MetadataSourceProcessor, .ToolingHintContext, org.hibernate.boot.spi.BootstrapContext, .ClassLoaderAccess, .InFlightMetadataCollector, .MappingDefaults, .MetadataBuildingContext, .MetadataBuildingOptions, org.hibernate.engine.ResultSetMappingDefinition, org.hibernate.internal.util.StringHelper, org.hibernate.mapping.PersistentClass, org.jboss.logging.Logger
Aggregates together information about a mapping document.
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final JaxbHbmHibernateMapping
documentRoot

private static final Logger
log

private final MappingDefaults
mappingDefaults

private final Origin
origin

private final MetadataBuildingContext
rootBuildingContext

private final ToolingHintContext
toolingHintContext

Constructor Summary

AccessConstructor and Description
public
MappingDocument(JaxbHbmHibernateMapping documentRoot, Origin origin, MetadataBuildingContext rootBuildingContext)

Method Summary

Modifier and TypeMethod and Description
public String
determineEntityName(EntityInfo entityElement)

Implements org.hibernate.boot.model.source.internal.hbm.HbmLocalMetadataBuildingContext.determineEntityName.

public String
determineEntityName(String entityName, String clazz)

Implements org.hibernate.boot.model.source.internal.hbm.HbmLocalMetadataBuildingContext.determineEntityName.

public PersistentClass
findEntityBinding(String entityName, String clazz)

Implements org.hibernate.boot.model.source.internal.hbm.HbmLocalMetadataBuildingContext.findEntityBinding.

public void
finishUp()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.finishUp.

General finish up step.
public BootstrapContext
getBootstrapContext()

Implements org.hibernate.boot.spi.MetadataBuildingContext.getBootstrapContext.

public MetadataBuildingOptions
getBuildingOptions()

Implements org.hibernate.boot.spi.MetadataBuildingContext.getBuildingOptions.

Access to the options specified by the org.hibernate.boot.MetadataBuilder
public ClassLoaderAccess
getClassLoaderAccess()

Implements org.hibernate.boot.spi.MetadataBuildingContext.getClassLoaderAccess.

Provides access to ClassLoader services when needed during binding
public JaxbHbmHibernateMapping
getDocumentRoot()

public MappingDefaults
getMappingDefaults()

Implements org.hibernate.boot.spi.MetadataBuildingContext.getMappingDefaults.

Access to mapping defaults in effect for this context
public InFlightMetadataCollector
getMetadataCollector()

Implements org.hibernate.boot.spi.MetadataBuildingContext.getMetadataCollector.

Access to the collector of metadata as we build it.
public ObjectNameNormalizer
getObjectNameNormalizer()

Implements org.hibernate.boot.spi.MetadataBuildingContext.getObjectNameNormalizer.

Not sure how I feel about this exposed here
public Origin
getOrigin()

Implements org.hibernate.boot.model.source.spi.LocalMetadataBuildingContext.getOrigin.

Obtain the origin for this context
public ToolingHintContext
getToolingHintContext()

Implements org.hibernate.boot.model.source.internal.hbm.HbmLocalMetadataBuildingContext.getToolingHintContext.

public void
postProcessEntityHierarchies()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.postProcessEntityHierarchies.

public void
prepare()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.prepare.

A general preparation step.
public void
prepareForEntityHierarchyProcessing()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.prepareForEntityHierarchyProcessing.

public void
processAuxiliaryDatabaseObjectDefinitions()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processAuxiliaryDatabaseObjectDefinitions.

Process all org.hibernate.boot.model.relational.AuxiliaryDatabaseObject definitions.
public void
processEntityHierarchies(Set<String> processedEntityNames)

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processEntityHierarchies.

public void
processFetchProfiles()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processFetchProfiles.

Process all fetch profiles.
public void
processFilterDefinitions()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processFilterDefinitions.

Process all filter definitions.
public void
processIdentifierGenerators()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processIdentifierGenerators.

Process all custom identifier generator declarations,

Depends on processTypeDefinitions()

public void
processNamedQueries()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processNamedQueries.

Process all "root" named queries.
public void
processQueryRenames()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processQueryRenames.

Process all explicit query renames (imports).
public void
processResultSetMappings()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processResultSetMappings.

Process ResultSet mappings for native queries.
public void
processTypeDefinitions()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processTypeDefinitions.

Process all custom Type definitions.
public String
qualifyClassName(String name)

Implements org.hibernate.boot.model.source.internal.hbm.HbmLocalMetadataBuildingContext.qualifyClassName.

private static String
qualifyIfNeeded(String name, String implicitPackageName)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

documentRootback to summary
private final JaxbHbmHibernateMapping documentRoot
logback to summary
private static final Logger log
mappingDefaultsback to summary
private final MappingDefaults mappingDefaults
originback to summary
private final Origin origin
rootBuildingContextback to summary
private final MetadataBuildingContext rootBuildingContext
toolingHintContextback to summary
private final ToolingHintContext toolingHintContext

Constructor Detail

MappingDocumentback to summary
public MappingDocument(JaxbHbmHibernateMapping documentRoot, Origin origin, MetadataBuildingContext rootBuildingContext)

Method Detail

determineEntityNameback to summary
public String determineEntityName(EntityInfo entityElement)

Implements org.hibernate.boot.model.source.internal.hbm.HbmLocalMetadataBuildingContext.determineEntityName.

Annotations
@Override
determineEntityNameback to summary
public String determineEntityName(String entityName, String clazz)

Implements org.hibernate.boot.model.source.internal.hbm.HbmLocalMetadataBuildingContext.determineEntityName.

Annotations
@Override
findEntityBindingback to summary
public PersistentClass findEntityBinding(String entityName, String clazz)

Implements org.hibernate.boot.model.source.internal.hbm.HbmLocalMetadataBuildingContext.findEntityBinding.

Annotations
@Override
finishUpback to summary
public void finishUp()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.finishUp.

Doc from org.hibernate.boot.model.source.spi.MetadataSourceProcessor.finishUp.

General finish up step. Called last.

Annotations
@Override
getBootstrapContextback to summary
public BootstrapContext getBootstrapContext()

Implements org.hibernate.boot.spi.MetadataBuildingContext.getBootstrapContext.

Annotations
@Override
getBuildingOptionsback to summary
public MetadataBuildingOptions getBuildingOptions()

Implements org.hibernate.boot.spi.MetadataBuildingContext.getBuildingOptions.

Doc from org.hibernate.boot.spi.MetadataBuildingContext.getBuildingOptions.

Access to the options specified by the org.hibernate.boot.MetadataBuilder

Returns:MetadataBuildingOptions

The options

Annotations
@Override
getClassLoaderAccessback to summary
public ClassLoaderAccess getClassLoaderAccess()

Implements org.hibernate.boot.spi.MetadataBuildingContext.getClassLoaderAccess.

Doc from org.hibernate.boot.spi.MetadataBuildingContext.getClassLoaderAccess.

Provides access to ClassLoader services when needed during binding

Returns:ClassLoaderAccess

The ClassLoaderAccess

Annotations
@Override
getDocumentRootback to summary
public JaxbHbmHibernateMapping getDocumentRoot()
getMappingDefaultsback to summary
public MappingDefaults getMappingDefaults()

Implements org.hibernate.boot.spi.MetadataBuildingContext.getMappingDefaults.

Doc from org.hibernate.boot.spi.MetadataBuildingContext.getMappingDefaults.

Access to mapping defaults in effect for this context

Returns:MappingDefaults

The mapping defaults.

Annotations
@Override
getMetadataCollectorback to summary
public InFlightMetadataCollector getMetadataCollector()

Implements org.hibernate.boot.spi.MetadataBuildingContext.getMetadataCollector.

Doc from org.hibernate.boot.spi.MetadataBuildingContext.getMetadataCollector.

Access to the collector of metadata as we build it.

Returns:InFlightMetadataCollector

The metadata collector.

Annotations
@Override
getObjectNameNormalizerback to summary
public ObjectNameNormalizer getObjectNameNormalizer()

Implements org.hibernate.boot.spi.MetadataBuildingContext.getObjectNameNormalizer.

Doc from org.hibernate.boot.spi.MetadataBuildingContext.getObjectNameNormalizer.

Not sure how I feel about this exposed here

Returns:ObjectNameNormalizer

The ObjectNameNormalizer

Annotations
@Override
getOriginback to summary
public Origin getOrigin()

Implements org.hibernate.boot.model.source.spi.LocalMetadataBuildingContext.getOrigin.

Doc from org.hibernate.boot.model.source.spi.LocalMetadataBuildingContext.getOrigin.

Obtain the origin for this context

Returns:Origin

The origin

Annotations
@Override
getToolingHintContextback to summary
public ToolingHintContext getToolingHintContext()

Implements org.hibernate.boot.model.source.internal.hbm.HbmLocalMetadataBuildingContext.getToolingHintContext.

Annotations
@Override
postProcessEntityHierarchiesback to summary
public void postProcessEntityHierarchies()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.postProcessEntityHierarchies.

Annotations
@Override
prepareback to summary
public void prepare()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.prepare.

Doc from org.hibernate.boot.model.source.spi.MetadataSourceProcessor.prepare.

A general preparation step. Called first.

Annotations
@Override
prepareForEntityHierarchyProcessingback to summary
public void prepareForEntityHierarchyProcessing()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.prepareForEntityHierarchyProcessing.

Annotations
@Override
processAuxiliaryDatabaseObjectDefinitionsback to summary
public void processAuxiliaryDatabaseObjectDefinitions()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processAuxiliaryDatabaseObjectDefinitions.

Doc from org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processAuxiliaryDatabaseObjectDefinitions.

Process all org.hibernate.boot.model.relational.AuxiliaryDatabaseObject definitions.

This step has no prerequisites.

Annotations
@Override
processEntityHierarchiesback to summary
public void processEntityHierarchies(Set<String> processedEntityNames)

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processEntityHierarchies.

Annotations
@Override
processFetchProfilesback to summary
public void processFetchProfiles()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processFetchProfiles.

Doc from org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processFetchProfiles.

Process all fetch profiles.

todo : does this step depend on any others??

Annotations
@Override
processFilterDefinitionsback to summary
public void processFilterDefinitions()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processFilterDefinitions.

Doc from org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processFilterDefinitions.

Process all filter definitions.

This step depends on processTypeDefinitions()

Annotations
@Override
processIdentifierGeneratorsback to summary
public void processIdentifierGenerators()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processIdentifierGenerators.

Doc from org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processIdentifierGenerators.

Process all custom identifier generator declarations,

Depends on processTypeDefinitions()

Annotations
@Override
processNamedQueriesback to summary
public void processNamedQueries()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processNamedQueries.

Doc from org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processNamedQueries.

Process all "root" named queries. These are named queries not defined on a specific entity (which will be handled later during processEntityHierarchies).

This step has no prerequisites. The returns associated with named native queries can depend on entity binding being complete, but those are handled later during processResultSetMappings().

Annotations
@Override
processQueryRenamesback to summary
public void processQueryRenames()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processQueryRenames.

Doc from org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processQueryRenames.

Process all explicit query renames (imports). This step has no prerequisites.

Annotations
@Override
processResultSetMappingsback to summary
public void processResultSetMappings()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processResultSetMappings.

Doc from org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processResultSetMappings.

Process ResultSet mappings for native queries. At the moment, this step has processEntityHierarchies as a prerequisite because the parsing of the returns access the entity bindings.

Annotations
@Override
processTypeDefinitionsback to summary
public void processTypeDefinitions()

Implements org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processTypeDefinitions.

Doc from org.hibernate.boot.model.source.spi.MetadataSourceProcessor.processTypeDefinitions.

Process all custom Type definitions. This step has no prerequisites.

Annotations
@Override
qualifyClassNameback to summary
public String qualifyClassName(String name)

Implements org.hibernate.boot.model.source.internal.hbm.HbmLocalMetadataBuildingContext.qualifyClassName.

Annotations
@Override
qualifyIfNeededback to summary
private static String qualifyIfNeeded(String name, String implicitPackageName)