Package org.hibernate.mapping

Class PersistentClass

java.lang.Object
org.hibernate.mapping.PersistentClass
All Implemented Interfaces:
Serializable, AttributeContainer, Contributable, Filterable, IdentifiableTypeClass, MetaAttributable, TableContainer
Direct Known Subclasses:
RootClass, Subclass
public abstract sealed class PersistentClass extends Object implements IdentifiableTypeClass, AttributeContainer, Filterable, MetaAttributable, Contributable, Serializable permits RootClass, Subclass
A mapping model object that represents an entity class.
See Also:

  • Field Details

    • NULL_DISCRIMINATOR_MAPPING

      public static final String NULL_DISCRIMINATOR_MAPPING
      The magic value of DiscriminatorValue.value() which indicates that the subclass is distinguished by a null value of the discriminator column.
      See Also:

    • NOT_NULL_DISCRIMINATOR_MAPPING

      public static final String NOT_NULL_DISCRIMINATOR_MAPPING
      The magic value of DiscriminatorValue.value() which indicates that the subclass is distinguished by any non-null value of the discriminator column.
      See Also:

    • synchronizedTables

      protected final Set<String> synchronizedTables

  • Constructor Details

  • Method Details

    • getContributor

      public String getContributor()
      Description copied from interface: Contributable
      The name of the contributor which contributed this
      Specified by:
      getContributor in interface Contributable

    • getServiceRegistry

      public ServiceRegistry getServiceRegistry()

    • getClassName

      public String getClassName()

    • setClassName

      public void setClassName(String className)

    • getProxyInterfaceName

      public String getProxyInterfaceName()

    • setProxyInterfaceName

      public void setProxyInterfaceName(String proxyInterfaceName)

    • getMappedClass

      public Class<?> getMappedClass() throws MappingException
      Throws:
      MappingException

    • getProxyInterface

      public Class<?> getProxyInterface()

    • useDynamicInsert

      public boolean useDynamicInsert()

    • getSubclassId

      public abstract int getSubclassId()

    • useDynamicUpdate

      public boolean useDynamicUpdate()

    • setDynamicInsert

      public void setDynamicInsert(boolean dynamicInsert)

    • setDynamicUpdate

      public void setDynamicUpdate(boolean dynamicUpdate)

    • getDiscriminatorValue

      public String getDiscriminatorValue()

    • addSubclass

      public void addSubclass(Subclass subclass) throws MappingException
      Throws:
      MappingException

    • hasSubclasses

      public boolean hasSubclasses()

    • getSubclassSpan

      public int getSubclassSpan()

    • getSubclasses

      public List<Subclass> getSubclasses()
      Get the subclasses in a special 'order', most derived subclasses first.

    • getSubclassClosure

      public List<PersistentClass> getSubclassClosure()

    • getIdentityTable

      public Table getIdentityTable()

    • getDirectSubclasses

      public List<Subclass> getDirectSubclasses()

    • addProperty

      public void addProperty(Property property)
      Description copied from interface: AttributeContainer
      Add a property to this PersistentClass or Join.
      Specified by:
      addProperty in interface AttributeContainer

    • contains

      public boolean contains(Property property)
      Specified by:
      contains in interface AttributeContainer

    • getTable

      public abstract Table getTable()
      Specified by:
      getTable in interface AttributeContainer

    • getEntityName

      public String getEntityName()

    • isMutable

      public abstract boolean isMutable()

    • hasIdentifierProperty

      public abstract boolean hasIdentifierProperty()

    • getIdentifierProperty

      public abstract Property getIdentifierProperty()

    • getDeclaredIdentifierProperty

      public abstract Property getDeclaredIdentifierProperty()

    • getIdentifier

      public abstract KeyValue getIdentifier()

    • getVersion

      public abstract Property getVersion()

    • getDeclaredVersion

      public abstract Property getDeclaredVersion()

    • getDiscriminator

      public abstract Value getDiscriminator()

    • isInherited

      public abstract boolean isInherited()

    • isPolymorphic

      public abstract boolean isPolymorphic()

    • isVersioned

      public abstract boolean isVersioned()

    • isCached

      public boolean isCached()

    • setCached

      public void setCached(boolean cached)

    • getQueryCacheLayout

      public CacheLayout getQueryCacheLayout()

    • setQueryCacheLayout

      public void setQueryCacheLayout(CacheLayout queryCacheLayout)

    • getCacheConcurrencyStrategy

      public abstract String getCacheConcurrencyStrategy()

    • getNaturalIdCacheRegionName

      public abstract String getNaturalIdCacheRegionName()

    • getSuperclass

      public abstract PersistentClass getSuperclass()

    • isExplicitPolymorphism

      @Deprecated public boolean isExplicitPolymorphism()
      Deprecated.
      No longer supported

    • isDiscriminatorInsertable

      public abstract boolean isDiscriminatorInsertable()

    • getPropertyClosure

      public abstract List<Property> getPropertyClosure()

    • getTableClosure

      public abstract List<Table> getTableClosure()

    • getKeyClosure

      public abstract List<KeyValue> getKeyClosure()

    • addSubclassProperty

      protected void addSubclassProperty(Property prop)

    • addSubclassJoin

      protected void addSubclassJoin(Join join)

    • addSubclassTable

      protected void addSubclassTable(Table subclassTable)

    • getSubclassPropertyClosure

      public List<Property> getSubclassPropertyClosure()

    • getSubclassJoinClosure

      public List<Join> getSubclassJoinClosure()

    • getSubclassTableClosure

      public List<Table> getSubclassTableClosure()

    • isClassOrSuperclassJoin

      public boolean isClassOrSuperclassJoin(Join join)

    • isClassOrSuperclassTable

      public boolean isClassOrSuperclassTable(Table closureTable)

    • isLazy

      public boolean isLazy()

    • setLazy

      public void setLazy(boolean lazy)

    • isConcreteProxy

      public abstract boolean isConcreteProxy()

    • hasEmbeddedIdentifier

      public abstract boolean hasEmbeddedIdentifier()

    • getRootTable

      public abstract Table getRootTable()

    • getRootClass

      public abstract RootClass getRootClass()

    • getKey

      public abstract KeyValue getKey()

    • setDiscriminatorValue

      public void setDiscriminatorValue(String discriminatorValue)

    • setEntityName

      public void setEntityName(String entityName)

    • createPrimaryKey

      public void createPrimaryKey()

    • getWhere

      public abstract String getWhere()

    • getBatchSize

      public int getBatchSize()

    • setBatchSize

      public void setBatchSize(int batchSize)

    • hasSelectBeforeUpdate

      public boolean hasSelectBeforeUpdate()

    • setSelectBeforeUpdate

      public void setSelectBeforeUpdate(boolean selectBeforeUpdate)

    • getReferenceableProperties

      public List<Property> getReferenceableProperties()
      Build a list of properties which may be referenced in association mappings.

      Includes properties defined in superclasses of the mapping inheritance. Includes all properties defined as part of a join.

      Returns:
      The referenceable property iterator.
      See Also:

    • getReferencedProperty

      public Property getReferencedProperty(String propertyPath) throws MappingException
      Given a property path, locate the appropriate referenceable property reference.

      A referenceable property is a property which can be a target of a foreign-key mapping (e.g. @ManyToOne, @OneToOne).

      Parameters:
      propertyPath - The property path to resolve into a property reference.
      Returns:
      The property reference (never null).
      Throws:
      MappingException - If the property could not be found.

    • getRecursiveProperty

      public Property getRecursiveProperty(String propertyPath) throws MappingException
      Throws:
      MappingException

    • getProperty

      public Property getProperty(String propertyName) throws MappingException
      Throws:
      MappingException

    • hasProperty

      public boolean hasProperty(String name)
      Check to see if this PersistentClass defines a property with the given name.
      Parameters:
      name - The property name to check
      Returns:
      true if a property with that name exists; false if not

    • isPropertyDefinedInSuperHierarchy

      public boolean isPropertyDefinedInSuperHierarchy(String name)
      Check to see if a property with the given name exists in the super hierarchy of this PersistentClass. Does not check this PersistentClass, just up the hierarchy
      Parameters:
      name - The property name to check
      Returns:
      true if a property with that name exists; false if not

    • isPropertyDefinedInHierarchy

      public boolean isPropertyDefinedInHierarchy(String name)
      Check to see if a property with the given name exists in this PersistentClass or in any of its super hierarchy. Unlike isPropertyDefinedInSuperHierarchy(java.lang.String), this method does check this PersistentClass
      Parameters:
      name - The property name to check
      Returns:
      true if a property with that name exists; false if not

    • getOptimisticLockStyle

      public OptimisticLockStyle getOptimisticLockStyle()

    • setOptimisticLockStyle

      public void setOptimisticLockStyle(OptimisticLockStyle optimisticLockStyle)

    • validate

      public void validate(Metadata mapping) throws MappingException
      Throws:
      MappingException

    • isDiscriminatorValueNotNull

      public boolean isDiscriminatorValueNotNull()

    • isDiscriminatorValueNull

      public boolean isDiscriminatorValueNull()

    • getMetaAttributes

      public Map<String,MetaAttribute> getMetaAttributes()
      Specified by:
      getMetaAttributes in interface MetaAttributable

    • setMetaAttributes

      public void setMetaAttributes(Map<String,MetaAttribute> metas)
      Specified by:
      setMetaAttributes in interface MetaAttributable

    • getMetaAttribute

      public MetaAttribute getMetaAttribute(String name)
      Specified by:
      getMetaAttribute in interface MetaAttributable

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getJoins

      public List<Join> getJoins()

    • getJoinClosure

      public List<Join> getJoinClosure()

    • addJoin

      public void addJoin(Join join)

    • getJoinClosureSpan

      public int getJoinClosureSpan()

    • getPropertyClosureSpan

      public int getPropertyClosureSpan()

    • getJoinNumber

      public int getJoinNumber(Property prop)

    • getProperties

      public List<Property> getProperties()
      Build a list of the properties defined on this class. The returned iterator only accounts for "normal" properties (i.e. non-identifier properties).

      Differs from getUnjoinedProperties() in that the returned list will include properties defined as part of a join.

      Differs from getReferenceableProperties() in that the properties defined in superclasses of the mapping inheritance are not included.

      Returns:
      A list over the "normal" properties.

    • getUnjoinedProperties

      public List<Property> getUnjoinedProperties()
      Get a list of the properties defined on this class which are not defined as part of a join. As with getProperties(), the returned iterator only accounts for non-identifier properties.
      Returns:
      An iterator over the non-joined "normal" properties.

    • setCustomSQLInsert

      public void setCustomSQLInsert(String customSQLInsert, boolean callable, ExecuteUpdateResultCheckStyle checkStyle)

    • getCustomSQLInsert

      public String getCustomSQLInsert()

    • isCustomInsertCallable

      public boolean isCustomInsertCallable()

    • setCustomSQLUpdate

      public void setCustomSQLUpdate(String customSQLUpdate, boolean callable, ExecuteUpdateResultCheckStyle checkStyle)

    • getCustomSQLUpdate

      public String getCustomSQLUpdate()

    • isCustomUpdateCallable

      public boolean isCustomUpdateCallable()

    • setCustomSQLDelete

      public void setCustomSQLDelete(String customSQLDelete, boolean callable, ExecuteUpdateResultCheckStyle checkStyle)

    • getCustomSQLDelete

      public String getCustomSQLDelete()

    • isCustomDeleteCallable

      public boolean isCustomDeleteCallable()

    • addFilter

      public void addFilter(String name, String condition, boolean autoAliasInjection, Map<String,String> aliasTableMap, Map<String,String> aliasEntityMap)
      Specified by:
      addFilter in interface Filterable

    • getFilters

      public List<FilterConfiguration> getFilters()
      Specified by:
      getFilters in interface Filterable

    • isForceDiscriminator

      public boolean isForceDiscriminator()

    • isJoinedSubclass

      public abstract boolean isJoinedSubclass()

    • getLoaderName

      public String getLoaderName()

    • setLoaderName

      public void setLoaderName(String loaderName)

    • getSynchronizedTables

      public abstract Set<String> getSynchronizedTables()

    • addSynchronizedTable

      public void addSynchronizedTable(String table)

    • isAbstract

      public Boolean isAbstract()

    • setAbstract

      public void setAbstract(Boolean isAbstract)

    • getNonDuplicatedProperties

      protected List<Property> getNonDuplicatedProperties()

    • checkColumnDuplication

      protected void checkColumnDuplication()

    • accept

      public abstract Object accept(PersistentClassVisitor mv)

    • getJpaEntityName

      public String getJpaEntityName()

    • setJpaEntityName

      public void setJpaEntityName(String jpaEntityName)

    • hasPojoRepresentation

      public boolean hasPojoRepresentation()

    • hasSubselectLoadableCollections

      public boolean hasSubselectLoadableCollections()

    • setSubselectLoadableCollections

      public void setSubselectLoadableCollections(boolean hasSubselectCollections)

    • hasCollectionNotReferencingPK

      public boolean hasCollectionNotReferencingPK()

    • hasPartitionedSelectionMapping

      public boolean hasPartitionedSelectionMapping()

    • getIdentifierMapper

      public Component getIdentifierMapper()

    • getDeclaredIdentifierMapper

      public Component getDeclaredIdentifierMapper()

    • setDeclaredIdentifierMapper

      public void setDeclaredIdentifierMapper(Component declaredIdentifierMapper)

    • hasIdentifierMapper

      public boolean hasIdentifierMapper()

    • addCallbackDefinitions

      public void addCallbackDefinitions(List<CallbackDefinition> callbackDefinitions)

    • getCallbackDefinitions

      public List<CallbackDefinition> getCallbackDefinitions()

    • setIdentifierMapper

      public void setIdentifierMapper(Component handle)

    • hasNaturalId

      public boolean hasNaturalId()

    • getDeclaredProperties

      public List<Property> getDeclaredProperties()
      Specified by:
      getDeclaredProperties in interface IdentifiableTypeClass

    • addMappedSuperclassProperty

      public void addMappedSuperclassProperty(Property p)

    • getSuperMappedSuperclass

      public MappedSuperclass getSuperMappedSuperclass()

    • setSuperMappedSuperclass

      public void setSuperMappedSuperclass(MappedSuperclass superMappedSuperclass)

    • assignCheckConstraintsToTable

      public void assignCheckConstraintsToTable(Dialect dialect, TypeConfiguration types)

    • prepareForMappingModel

      public void prepareForMappingModel(RuntimeModelCreationContext context)

    • addCheckConstraint

      public void addCheckConstraint(CheckConstraint checkConstraint)

    • getCheckConstraints

      public List<CheckConstraint> getCheckConstraints()

    • getImplicitTable

      public Table getImplicitTable()
      Specified by:
      getImplicitTable in interface IdentifiableTypeClass

    • findTable

      public Table findTable(String name)
      Specified by:
      findTable in interface TableContainer

    • getTable

      public Table getTable(String name)
      Specified by:
      getTable in interface TableContainer

    • findSecondaryTable

      public Join findSecondaryTable(String name)
      Specified by:
      findSecondaryTable in interface TableContainer

    • getSecondaryTable

      public Join getSecondaryTable(String name)
      Specified by:
      getSecondaryTable in interface TableContainer

    • getSuperType

      public IdentifiableTypeClass getSuperType()
      Specified by:
      getSuperType in interface IdentifiableTypeClass

    • getSubTypes

      public List<IdentifiableTypeClass> getSubTypes()
      Specified by:
      getSubTypes in interface IdentifiableTypeClass

    • applyProperty

      public void applyProperty(Property property)
      Specified by:
      applyProperty in interface IdentifiableTypeClass

    • isDefinedOnMultipleSubclasses

      @Internal public boolean isDefinedOnMultipleSubclasses(Column column)

    • getSuperPersistentClass

      @Internal public PersistentClass getSuperPersistentClass()

    • getInsertExpectation

      public Supplier<? extends Expectation> getInsertExpectation()

    • setInsertExpectation

      public void setInsertExpectation(Supplier<? extends Expectation> insertExpectation)

    • getUpdateExpectation

      public Supplier<? extends Expectation> getUpdateExpectation()

    • setUpdateExpectation

      public void setUpdateExpectation(Supplier<? extends Expectation> updateExpectation)

    • getDeleteExpectation

      public Supplier<? extends Expectation> getDeleteExpectation()

    • setDeleteExpectation

      public void setDeleteExpectation(Supplier<? extends Expectation> deleteExpectation)

    • removeProperty

      public void removeProperty(Property property)

    • createConstraints

      public void createConstraints(MetadataBuildingContext context)