Top Description Methods
org.hibernate.boot.model.source.spi

public Interface EntityHierarchySource

Known Direct Implementers
org.hibernate.boot.model.source.internal.hbm.EntityHierarchySourceImpl
Imports
org.hibernate.boot.model.Caching, org.hibernate.engine.OptimisticLockStyle

Models the source-agnostic view of an entity hierarchy.
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public Caching

Returns:

The caching configuration.
getCaching
()

Deprecated as a consequence of Caching being deprecated.
Obtain the caching configuration for this entity.
public DiscriminatorSource

Returns:

the source information about the discriminator attribute for single table inheritance
getDiscriminatorSource
()

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

public InheritanceType

Returns:

The inheritance type.
getHierarchyInheritanceType
()

The inheritance type/strategy for the hierarchy.

public IdentifierSource

Returns:

Identifier source information.
getIdentifierSource
()

Obtain source information about this entity's identifier.

public MultiTenancySource

Returns:

the source information about the multi-tenancy discriminator for this entity
getMultiTenancySource
()

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

public Caching

Returns:

The natural id caching configuration.
getNaturalIdCaching
()

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

Returns:

The optimistic locking style.
getOptimisticLockStyle
()

Obtain the optimistic locking style for this entity.

public EntitySource

Returns:

The root type source.
getRoot
()

Obtain the hierarchy's root type source.

public String

Returns:

The row-id name
getRowId
()

Obtain the row-id name for this entity

public VersionAttributeSource

Returns:

the source information about the attribute used for optimistic locking
getVersionAttributeSource
()

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

public String

Returns:

The extra where condition
getWhere
()

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

public boolean

Returns:

true indicates explicit polymorphism; false implicit.
isExplicitPolymorphism
()

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

public boolean

Returns:

true indicates mutable; false non-mutable.
isMutable
()

Is this root entity mutable?

Method Detail

getCachingback to summary
public Caching 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.

getDiscriminatorSourceback to summary
public DiscriminatorSource 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

getHierarchyInheritanceTypeback to summary
public InheritanceType getHierarchyInheritanceType()

The inheritance type/strategy for the hierarchy.

The entire hierarchy must have with the same inheritance strategy.

Returns:InheritanceType

The inheritance type.

getIdentifierSourceback to summary
public IdentifierSource getIdentifierSource()

Obtain source information about this entity's identifier.

Returns:IdentifierSource

Identifier source information.

getMultiTenancySourceback to summary
public MultiTenancySource 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

getNaturalIdCachingback to summary
public Caching 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.

getOptimisticLockStyleback to summary
public OptimisticLockStyle getOptimisticLockStyle()

Obtain the optimistic locking style for this entity.

Returns:OptimisticLockStyle

The optimistic locking style.

getRootback to summary
public EntitySource getRoot()

Obtain the hierarchy's root type source.

Returns:EntitySource

The root type source.

getRowIdback to summary
public String getRowId()

Obtain the row-id name for this entity

Returns:String

The row-id name

getVersionAttributeSourceback to summary
public VersionAttributeSource getVersionAttributeSource()

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

Returns:VersionAttributeSource

the source information about the attribute used for optimistic locking

getWhereback to summary
public String getWhere()

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

Returns:String

The extra where condition

isExplicitPolymorphismback to summary
public boolean isExplicitPolymorphism()

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

Returns:boolean

true indicates explicit polymorphism; false implicit.

isMutableback to summary
public boolean isMutable()

Is this root entity mutable?

Returns:boolean

true indicates mutable; false non-mutable.