Interface EntityHierarchySource
- All Known Implementing Classes:
EntityHierarchySourceImpl
public interface EntityHierarchySource
Models the source-agnostic view of an entity hierarchy.
-
Method Summary
Modifier and TypeMethodDescriptionObtain the caching configuration for this entity.Obtain the source information about the discriminator attribute for single table inheritanceThe inheritance type/strategy for the hierarchy.Obtain source information about this entity's identifier.Obtain the source information about the multi-tenancy discriminator for this entityObtain the natural id caching configuration for this entity.Obtain the optimistic locking style for this entity.getRoot()
Obtain the hierarchy's root type source.getRowId()
Obtain the row-id name for this entityObtain the source information about the attribute used for optimistic locking.getWhere()
Obtain the specified extra where condition to be applied to this entity.boolean
Should explicit polymorphism (querying) be applied to this entity?boolean
Is this root entity mutable?
-
Method Details
-
getRoot
EntitySource getRoot()Obtain the hierarchy's root type source.- Returns:
- The root type source.
-
getHierarchyInheritanceType
InheritanceType getHierarchyInheritanceType()The inheritance type/strategy for the hierarchy.The entire hierarchy must have with the same inheritance strategy.
- Returns:
- The inheritance type.
-
getIdentifierSource
IdentifierSource getIdentifierSource()Obtain source information about this entity's identifier.- Returns:
- Identifier source information.
-
getVersionAttributeSource
VersionAttributeSource getVersionAttributeSource()Obtain the source information about the attribute used for optimistic locking.- Returns:
- the source information about the attribute used for optimistic locking
-
getDiscriminatorSource
DiscriminatorSource getDiscriminatorSource()Obtain the source information about the discriminator attribute for single table inheritance- Returns:
- the source information about the discriminator attribute for single table inheritance
-
getMultiTenancySource
MultiTenancySource getMultiTenancySource()Obtain the source information about the multi-tenancy discriminator for this entity- Returns:
- the source information about the multi-tenancy discriminator for this entity
-
isMutable
boolean isMutable()Is this root entity mutable?- Returns:
true
indicates mutable;false
non-mutable.
-
isExplicitPolymorphism
boolean isExplicitPolymorphism()Should explicit polymorphism (querying) be applied to this entity?- Returns:
true
indicates explicit polymorphism;false
implicit.
-
getWhere
String getWhere()Obtain the specified extra where condition to be applied to this entity.- Returns:
- The extra where condition
-
getRowId
String getRowId()Obtain the row-id name for this entity- Returns:
- The row-id name
-
getOptimisticLockStyle
OptimisticLockStyle getOptimisticLockStyle()Obtain the optimistic locking style for this entity.- Returns:
- The optimistic locking style.
-
getCaching
Caching getCaching()Obtain the caching configuration for this entity.- Returns:
- The caching configuration.
-
getNaturalIdCaching
Caching getNaturalIdCaching()Obtain the natural id caching configuration for this entity.- Returns:
- The natural id caching configuration.
-