Top Description Fields Constructors Methods
org.hibernate.mapping

public abstract Class PersistentClass

extends Object
implements IdentifiableTypeClass, AttributeContainer, Filterable, MetaAttributable, Contributable, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.hibernate.mapping.Contributable, org.hibernate.mapping.MetaAttributable, org.hibernate.mapping.Filterable, org.hibernate.mapping.AttributeContainer, org.hibernate.mapping.IdentifiableTypeClass, org.hibernate.mapping.TableContainer
Known Direct Subclasses
org.hibernate.mapping.RootClass, org.hibernate.mapping.Subclass
Imports
java.io.Serializable, java.util.ArrayList, .Collection, .HashSet, .List, .Map, .Set, .StringTokenizer, org.hibernate.Internal, .MappingException, org.hibernate.boot.Metadata, org.hibernate.boot.model.CustomSql, org.hibernate.boot.registry.classloading.spi.ClassLoadingException, org.hibernate.boot.spi.ClassLoaderAccess, .MetadataBuildingContext, org.hibernate.dialect.Dialect, org.hibernate.engine.OptimisticLockStyle, org.hibernate.engine.spi.ExecuteUpdateResultCheckStyle, org.hibernate.internal.FilterConfiguration, org.hibernate.internal.util.collections.JoinedList, org.hibernate.metamodel.spi.RuntimeModelCreationContext, org.hibernate.persister.entity.EntityPersister, org.hibernate.jpa.event.spi.CallbackDefinition, org.hibernate.query.sqm.function.SqmFunctionRegistry, org.hibernate.service.ServiceRegistry, org.hibernate.sql.Alias, org.hibernate.type.CollectionType, .Type, org.hibernate.type.spi.TypeConfiguration

A mapping model object that represents an entity class.
Author
Gavin King

Field Summary

Modifier and TypeField and Description
private int
private List<CallbackDefinition>
private final List<CheckConstraint>
private String
private final String
private boolean
private boolean
private String
private String
private String
private boolean
private Component
private final List<Property>
private ExecuteUpdateResultCheckStyle
private String
private boolean
private boolean
private String
private final List<FilterConfiguration>
private Boolean
private boolean
private Component
private ExecuteUpdateResultCheckStyle
private Boolean
private boolean
private final List<Join>
private String
private boolean
private String
private transient Class<?>
private Map<String, MetaAttribute>
private final MetadataBuildingContext
public static final String
NOT_NULL_DISCRIMINATOR_MAPPING

The magic value of jakarta.persistence.DiscriminatorValue#value which indicates that the subclass is distinguished by any non-null value of the discriminator column.

public static final String
NULL_DISCRIMINATOR_MAPPING

The magic value of jakarta.persistence.DiscriminatorValue#value which indicates that the subclass is distinguished by a null value of the discriminator column.

private OptimisticLockStyle
private static final Alias
private final List<Property>
private transient Class<?>
private String
private boolean
private final List<Subclass>
private final List<Join>
private final List<Property>
private final List<Table>
private MappedSuperclass
protected final Set<String>
private ExecuteUpdateResultCheckStyle

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public abstract Object
public void
public void
public void
addFilter(String name, String condition, boolean autoAliasInjection, Map<String, String> aliasTableMap, Map<String, String> aliasEntityMap)

Implements org.hibernate.mapping.Filterable.addFilter.

public void
addJoin(Join join)

public void
public void
public void
protected void
protected void
protected void
addSubclassTable(Table subclassTable)

public void
public void
public void
protected void
private void
private AttributeContainer
container(List<String> constrainedColumnNames)

public boolean
private boolean
public void
private boolean
public Join
public Table
public int
public abstract String
public List<CallbackDefinition>
public List<CheckConstraint>
private ClassLoaderAccess
public String
public String
getContributor()

Implements org.hibernate.mapping.Contributable.getContributor.

The name of the contributor which contributed this
public String
public ExecuteUpdateResultCheckStyle
public String
public ExecuteUpdateResultCheckStyle
public String
public ExecuteUpdateResultCheckStyle
public Component
public abstract Property
public List<Property>
public abstract Property
public List<Subclass>
public abstract Value
public String
public String
public abstract Class<? extends EntityPersister>
public List<FilterConfiguration>
public abstract KeyValue
public Component
public abstract Property
public Table
public Table
public List<Join>
public int
public int
public List<Join>
public String
public abstract KeyValue
public abstract List<KeyValue>
public String
public Class<?>
public MetaAttribute
public Map<String, MetaAttribute>
public abstract String
protected List<Property>
public int
getOptimisticLockMode()

Deprecated for removal. prefer getOptimisticLockStyle
public OptimisticLockStyle
public List<Property>

Returns:

A list over the "normal" properties.
getProperties
()

Build a list of the properties defined on this class.

private Property
getProperty(String propertyName, List<Property> properties)

public Property
getProperty(String propertyName)

public abstract List<Property>
public int
public Class<?>
public String
public Property
private Property
getRecursiveProperty(String propertyPath, List<Property> properties)

public List<Property>

Returns:

The referenceable property iterator.
getReferenceableProperties
()

Build a list of properties which may be referenced in association mappings.

public Property

Returns:

The property reference (never null).
getReferencedProperty
(String
The property path to resolve into a property reference.
propertyPath
)

Given a property path, locate the appropriate referenceable property reference.

public abstract RootClass
public abstract Table
public Join
public ServiceRegistry
public List<PersistentClass>
public List<Subclass>
getSubclasses()

Get the subclasses in a special 'order', most derived subclasses first.

public abstract int
public List<Join>
public Property
getSubclassProperty(String propertyName)

Deprecated for removal since 6.2. This will be removed with no replacement.
public List<Property>
public int
public List<Table>
public List<IdentifiableTypeClass>
public abstract PersistentClass
public MappedSuperclass
public PersistentClass
private static PersistentClass
public IdentifiableTypeClass
public abstract Set<String>
public abstract Table
public Table
public abstract List<Table>
public List<Property>

Returns:

An iterator over the non-joined "normal" properties.
getUnjoinedProperties
()

Get a list of the properties defined on this class which are not defined as part of a join.

public abstract Property
public abstract String
public boolean
private boolean
public abstract boolean
public boolean
public abstract boolean
public boolean
public boolean
public boolean
public boolean

Returns:

true if a property with that name exists; false if not
hasProperty
(String
The property name to check
name
)

Check to see if this PersistentClass defines a property with the given name.

public boolean
public boolean
public boolean
public Boolean
public boolean
public boolean
isCachingExplicitlyRequested()

Deprecated for removal. Use isCached instead
public boolean
public boolean
public boolean
public boolean
public boolean
public boolean
public abstract boolean
public boolean
public boolean
public abstract boolean
public boolean
public abstract boolean
public abstract boolean
public boolean
public abstract boolean
public abstract boolean
public boolean

Returns:

true if a property with that name exists; false if not
isPropertyDefinedInHierarchy
(String
The property name to check
name
)

Check to see if a property with the given name exists in this PersistentClass or in any of its super hierarchy.

public boolean

Returns:

true if a property with that name exists; false if not
isPropertyDefinedInSuperHierarchy
(String
The property name to check
name
)

Check to see if a property with the given name exists in the super hierarchy of this PersistentClass.

public abstract boolean
private static long
pack-priv abstract int
public void
prepareForMappingModel(RuntimeModelCreationContext context)

Deprecated as a consequence of RuntimeModelCreationContext being deprecated.
public void
setAbstract(Boolean isAbstract)

public void
setBatchSize(int batchSize)

public void
setCached(boolean cached)

public void
setCachingExplicitlyRequested(boolean cached)

Deprecated for removal. Use setCached instead
public void
setClassName(String className)

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

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

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

public void
setDeclaredIdentifierMapper(Component declaredIdentifierMapper)

public void
setDiscriminatorValue(String discriminatorValue)

public void
setDynamicInsert(boolean dynamicInsert)

public void
setDynamicUpdate(boolean dynamicUpdate)

public void
setEntityName(String entityName)

public abstract void
setEntityPersisterClass(Class<? extends EntityPersister> classPersisterClass)

public void
public void
setJpaEntityName(String jpaEntityName)

public void
setLazy(boolean lazy)

public void
setLoaderName(String loaderName)

public void
public void
setOptimisticLockMode(int optimisticLockMode)

Deprecated for removal. prefer setOptimisticLockStyle
public void
public void
setProxyInterfaceName(String proxyInterfaceName)

public void
setSelectBeforeUpdate(boolean selectBeforeUpdate)

public void
setSubselectLoadableCollections(boolean hasSubselectCollections)

public void
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public boolean
public boolean
public void
validate(Metadata mapping)

Deprecated as a consequence of Metadata being deprecated.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait