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

public Class EntityHierarchySourceImpl

extends Object
implements EntityHierarchySource
Class Inheritance
All Implemented Interfaces
org.hibernate.boot.model.source.spi.EntityHierarchySource
Imports
java.util.Collections, .HashSet, .List, .Locale, .Set, org.hibernate.boot.MappingException, org.hibernate.boot.jaxb.hbm.spi.JaxbHbmCompositeIdType, .JaxbHbmEntityDiscriminatorType, .JaxbHbmGeneratorSpecificationType, .JaxbHbmMultiTenancyType, .JaxbHbmPolymorphismEnum, .JaxbHbmRootEntityType, .JaxbHbmSimpleIdType, org.hibernate.boot.model.Caching, .IdentifierGeneratorDefinition, org.hibernate.boot.model.naming.EntityNaming, org.hibernate.boot.model.source.spi.DiscriminatorSource, .EntityHierarchySource, .EntityNamingSource, .IdentifierSource, .InheritanceType, .MultiTenancySource, .RelationalValueSource, .SizeSource, .VersionAttributeSource, org.hibernate.boot.spi.MetadataBuildingContext, org.hibernate.engine.OptimisticLockStyle, org.hibernate.internal.util.StringHelper
Models an entity hierarchy as defined by hbm.xml documents
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final Caching
caching

Deprecated as a consequence of Caching being deprecated.
private Set<String>
collectedEntityNames

private final DiscriminatorSource
discriminatorSource

private InheritanceType
hierarchyInheritanceType

private final IdentifierSource
identifierSource

private final MultiTenancySource
multiTenancySource

private final Caching
naturalIdCaching

Deprecated as a consequence of Caching being deprecated.
private final MappingDocument
rootEntityMappingDocument

private final RootEntitySourceImpl
rootEntitySource

private final VersionAttributeSource
versionAttributeSource

Constructor Summary

AccessConstructor and Description
public
EntityHierarchySourceImpl(RootEntitySourceImpl rootEntitySource, MappingDocument rootEntityMappingDocument)

Method Summary

Modifier and TypeMethod and Description
protected JaxbHbmRootEntityType
entityElement()

public Caching
getCaching()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getCaching.

Deprecated as a consequence of Caching being deprecated.
Obtain the caching configuration for this entity.
public Set<String>
getContainedEntityNames()

public DiscriminatorSource
getDiscriminatorSource()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getDiscriminatorSource.

Obtain the source information about the discriminator attribute for single table inheritance
public InheritanceType
getHierarchyInheritanceType()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getHierarchyInheritanceType.

The inheritance type/strategy for the hierarchy.
public IdentifierSource
getIdentifierSource()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getIdentifierSource.

Obtain source information about this entity's identifier.
public MultiTenancySource
getMultiTenancySource()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getMultiTenancySource.

Obtain the source information about the multi-tenancy discriminator for this entity
public Caching
getNaturalIdCaching()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getNaturalIdCaching.

Deprecated as a consequence of Caching being deprecated.
Obtain the natural id caching configuration for this entity.
public OptimisticLockStyle
getOptimisticLockStyle()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getOptimisticLockStyle.

Obtain the optimistic locking style for this entity.
public RootEntitySourceImpl
getRoot()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getRoot.

Obtain the hierarchy's root type source.
public MappingDocument
getRootEntityMappingDocument()

public String
getRowId()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getRowId.

Obtain the row-id name for this entity
public VersionAttributeSource
getVersionAttributeSource()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getVersionAttributeSource.

Obtain the source information about the attribute used for optimistic locking.
public String
getWhere()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getWhere.

Obtain the specified extra where condition to be applied to this entity.
private static DiscriminatorSource
interpretDiscriminatorSource(final RootEntitySourceImpl rootEntitySource)

pack-priv static IdentifierGeneratorDefinition

Returns:

The collected information.
interpretGeneratorDefinition(MappingDocument
The source mapping document
mappingDocument, EntityNamingSource
The entity naming
entityNaming, JaxbHbmGeneratorSpecificationType
The identifier generator mapping
jaxbGeneratorMapping)

Package-protected to allow IdentifierSource implementations to access it.

private static IdentifierSource
interpretIdentifierSource(RootEntitySourceImpl rootEntitySource)

private static MultiTenancySource
interpretMultiTenancySource(final RootEntitySourceImpl rootEntitySource)

private static VersionAttributeSource
interpretVersionSource(RootEntitySourceImpl rootEntitySource)

public boolean
isExplicitPolymorphism()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.isExplicitPolymorphism.

Should explicit polymorphism (querying) be applied to this entity?
public boolean
isMutable()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.isMutable.

Is this root entity mutable?
public void
processSubclass(SubclassEntitySourceImpl subclassEntitySource)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cachingback to summary
private final Caching caching

Deprecated

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

collectedEntityNamesback to summary
private Set<String> collectedEntityNames
discriminatorSourceback to summary
private final DiscriminatorSource discriminatorSource
hierarchyInheritanceTypeback to summary
private InheritanceType hierarchyInheritanceType
identifierSourceback to summary
private final IdentifierSource identifierSource
multiTenancySourceback to summary
private final MultiTenancySource multiTenancySource
naturalIdCachingback to summary
private final Caching naturalIdCaching

Deprecated

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

rootEntityMappingDocumentback to summary
private final MappingDocument rootEntityMappingDocument
rootEntitySourceback to summary
private final RootEntitySourceImpl rootEntitySource
versionAttributeSourceback to summary
private final VersionAttributeSource versionAttributeSource

Constructor Detail

EntityHierarchySourceImplback to summary
public EntityHierarchySourceImpl(RootEntitySourceImpl rootEntitySource, MappingDocument rootEntityMappingDocument)

Method Detail

entityElementback to summary
protected JaxbHbmRootEntityType entityElement()
getCachingback to summary
public Caching getCaching()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getCaching.

Doc from org.hibernate.boot.model.source.spi.EntityHierarchySource.getCaching.

Deprecated

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

Obtain the caching configuration for this entity.

Returns:Caching

The caching configuration.

Annotations
@Override
getContainedEntityNamesback to summary
public Set<String> getContainedEntityNames()
getDiscriminatorSourceback to summary
public DiscriminatorSource getDiscriminatorSource()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getDiscriminatorSource.

Doc from org.hibernate.boot.model.source.spi.EntityHierarchySource.getDiscriminatorSource.

Obtain the source information about the discriminator attribute for single table inheritance

Returns:DiscriminatorSource

the source information about the discriminator attribute for single table inheritance

Annotations
@Override
getHierarchyInheritanceTypeback to summary
public InheritanceType getHierarchyInheritanceType()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getHierarchyInheritanceType.

Doc from org.hibernate.boot.model.source.spi.EntityHierarchySource.getHierarchyInheritanceType.

The inheritance type/strategy for the hierarchy.

The entire hierarchy must have with the same inheritance strategy.

Returns:InheritanceType

The inheritance type.

Annotations
@Override
getIdentifierSourceback to summary
public IdentifierSource getIdentifierSource()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getIdentifierSource.

Doc from org.hibernate.boot.model.source.spi.EntityHierarchySource.getIdentifierSource.

Obtain source information about this entity's identifier.

Returns:IdentifierSource

Identifier source information.

Annotations
@Override
getMultiTenancySourceback to summary
public MultiTenancySource getMultiTenancySource()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getMultiTenancySource.

Doc from org.hibernate.boot.model.source.spi.EntityHierarchySource.getMultiTenancySource.

Obtain the source information about the multi-tenancy discriminator for this entity

Returns:MultiTenancySource

the source information about the multi-tenancy discriminator for this entity

Annotations
@Override
getNaturalIdCachingback to summary
public Caching getNaturalIdCaching()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getNaturalIdCaching.

Doc from org.hibernate.boot.model.source.spi.EntityHierarchySource.getNaturalIdCaching.

Deprecated

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

Obtain the natural id caching configuration for this entity.

Returns:Caching

The natural id caching configuration.

Annotations
@Override
getOptimisticLockStyleback to summary
public OptimisticLockStyle getOptimisticLockStyle()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getOptimisticLockStyle.

Doc from org.hibernate.boot.model.source.spi.EntityHierarchySource.getOptimisticLockStyle.

Obtain the optimistic locking style for this entity.

Returns:OptimisticLockStyle

The optimistic locking style.

Annotations
@Override
getRootback to summary
public RootEntitySourceImpl getRoot()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getRoot.

Doc from org.hibernate.boot.model.source.spi.EntityHierarchySource.getRoot.

Obtain the hierarchy's root type source.

Returns:RootEntitySourceImpl

The root type source.

Annotations
@Override
getRootEntityMappingDocumentback to summary
public MappingDocument getRootEntityMappingDocument()
getRowIdback to summary
public String getRowId()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getRowId.

Doc from org.hibernate.boot.model.source.spi.EntityHierarchySource.getRowId.

Obtain the row-id name for this entity

Returns:String

The row-id name

Annotations
@Override
getVersionAttributeSourceback to summary
public VersionAttributeSource getVersionAttributeSource()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getVersionAttributeSource.

Doc from org.hibernate.boot.model.source.spi.EntityHierarchySource.getVersionAttributeSource.

Obtain the source information about the attribute used for optimistic locking.

Returns:VersionAttributeSource

the source information about the attribute used for optimistic locking

Annotations
@Override
getWhereback to summary
public String getWhere()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.getWhere.

Doc from org.hibernate.boot.model.source.spi.EntityHierarchySource.getWhere.

Obtain the specified extra where condition to be applied to this entity.

Returns:String

The extra where condition

Annotations
@Override
interpretDiscriminatorSourceback to summary
private static DiscriminatorSource interpretDiscriminatorSource(final RootEntitySourceImpl rootEntitySource)
interpretGeneratorDefinitionback to summary
pack-priv static IdentifierGeneratorDefinition interpretGeneratorDefinition(MappingDocument mappingDocument, EntityNamingSource entityNaming, JaxbHbmGeneratorSpecificationType jaxbGeneratorMapping)

Package-protected to allow IdentifierSource implementations to access it.

Parameters
mappingDocument:MappingDocument

The source mapping document

entityNaming:EntityNamingSource

The entity naming

jaxbGeneratorMapping:JaxbHbmGeneratorSpecificationType

The identifier generator mapping

Returns:IdentifierGeneratorDefinition

The collected information.

interpretIdentifierSourceback to summary
private static IdentifierSource interpretIdentifierSource(RootEntitySourceImpl rootEntitySource)
interpretMultiTenancySourceback to summary
private static MultiTenancySource interpretMultiTenancySource(final RootEntitySourceImpl rootEntitySource)
interpretVersionSourceback to summary
private static VersionAttributeSource interpretVersionSource(RootEntitySourceImpl rootEntitySource)
isExplicitPolymorphismback to summary
public boolean isExplicitPolymorphism()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.isExplicitPolymorphism.

Doc from org.hibernate.boot.model.source.spi.EntityHierarchySource.isExplicitPolymorphism.

Should explicit polymorphism (querying) be applied to this entity?

Returns:boolean

true indicates explicit polymorphism; false implicit.

Annotations
@Override
isMutableback to summary
public boolean isMutable()

Implements org.hibernate.boot.model.source.spi.EntityHierarchySource.isMutable.

Doc from org.hibernate.boot.model.source.spi.EntityHierarchySource.isMutable.

Is this root entity mutable?

Returns:boolean

true indicates mutable; false non-mutable.

Annotations
@Override
processSubclassback to summary
public void processSubclass(SubclassEntitySourceImpl subclassEntitySource)