Class AbstractEntityPersister

java.lang.Object

org.hibernate.tuple.entity.EntityMetamodel

org.hibernate.persister.entity.AbstractEntityPersister

All Implemented Interfaces:

Serializable, LazyPropertyInitializer, org.hibernate.engine.profile.internal.FetchProfileAffectee, Loadable, Bindable, Discriminable, EntityMappingType, EntityValuedModelPart, FilterRestrictable, org.hibernate.metamodel.mapping.internal.InFlightEntityMappingType, JdbcMappingContainer, ManagedMappingType, MappingModelExpressible, MappingType, ModelPart, ModelPartContainer, Restrictable, SoftDeletableModelPart, WhereRestrictable, EntityPersister, Joinable, EntityMutationTarget, AttributeSource, RootTableGroupProducer, TableGroupProducer, MutationTarget<EntityTableMapping>, FetchableContainer

Direct Known Subclasses:

JoinedSubclassEntityPersister, SingleTableEntityPersister, UnionSubclassEntityPersister

@Internal
public abstract class AbstractEntityPersister
extends EntityMetamodel
implements EntityPersister, org.hibernate.metamodel.mapping.internal.InFlightEntityMappingType, EntityMutationTarget, LazyPropertyInitializer, org.hibernate.engine.profile.internal.FetchProfileAffectee, Joinable

Basic functionality for persisting an entity via JDBC, using either generated or custom SQL.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractEntityPersister.CacheEntryHelper	Consolidated these onto a single helper because the 2 pieces work in tandem.
protected static interface	AbstractEntityPersister.MutabilityOrderedTableConsumer	Consumer for processing table details.

Nested classes/interfaces inherited from interface Bindable

Bindable.JdbcValuesBiConsumer<X,Y>, Bindable.JdbcValuesConsumer

Nested classes/interfaces inherited from interface EntityMappingType

EntityMappingType.ConstraintOrderedTableConsumer

Nested classes/interfaces inherited from interface LazyPropertyInitializer

LazyPropertyInitializer.InterceptorImplementor

Nested classes/interfaces inherited from interface ModelPart

ModelPart.JdbcValueBiConsumer<X,Y>, ModelPart.JdbcValueConsumer

Field Summary

Fields

Modifier and Type	Field	Description
protected ReflectionOptimizer.AccessOptimizer	accessOptimizer
protected final int	batchSize
protected String[]	customSQLDelete	Deprecated.
protected String[]	customSQLInsert	Deprecated.
protected String[]	customSQLUpdate	Deprecated.
protected AttributeMappingsMap	declaredAttributeMappings
protected boolean[]	deleteCallable	Deprecated.
protected Expectation[]	deleteExpectations	Deprecated.
static final String	ENTITY_CLASS
static final String	ENTITY_ID	Deprecated. this feature of HQL is now deprecated
protected final String[]	fullDiscriminatorSQLValues
protected boolean[]	insertCallable	Deprecated.
protected Expectation[]	insertExpectations	Deprecated.
protected List<? extends ModelPart>	insertGeneratedProperties
static final String	ROWID_ALIAS
protected final String	rowIdName
protected AttributeMappingsList	staticFetchableList
protected boolean[]	updateCallable	Deprecated.
protected Expectation[]	updateExpectations	Deprecated.
protected List<? extends ModelPart>	updateGeneratedProperties
static final String	VERSION_COLUMN_ALIAS

Fields inherited from class EntityMetamodel

NO_VERSION_INDX

Fields inherited from interface LazyPropertyInitializer

UNFETCHED_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AbstractEntityPersister(PersistentClass persistentClass, EntityDataAccess cacheAccessStrategy, NaturalIdDataAccess naturalIdRegionAccessStrategy, RuntimeModelCreationContext creationContext)

Method Summary

Modifier and Type	Method	Description
void	addDiscriminatorToInsertGroup(MutationGroupBuilder insertGroupBuilder)
void	addSoftDeleteToInsertGroup(MutationGroupBuilder insertGroupBuilder)
void	afterInitialize(Object entity, SharedSessionContractImplementor session)	Called just after the entities properties have been initialized
void	afterReassociate(Object entity, SharedSessionContractImplementor session)	Called just after the entity has been reassociated with the session
void	applyBaseRestrictions(Consumer<Predicate> predicateConsumer, TableGroup tableGroup, boolean useQualifier, Map<String,Filter> enabledFilters, boolean onlyApplyLoadByKeyFilters, Set<String> treatAsDeclarations, SqlAstCreationState creationState)	Applies the base set of restrictions.
void	applyDiscriminator(Consumer<Predicate> predicateConsumer, String alias, TableGroup tableGroup, SqlAstCreationState creationState)	Apply the discriminator as a predicate via the predicateConsumer
void	applyFilterRestrictions(Consumer<Predicate> predicateConsumer, TableGroup tableGroup, boolean useQualifier, Map<String,Filter> enabledFilters, boolean onlyApplyLoadByKeyFilters, SqlAstCreationState creationState)	Applies just the Filter values enabled for the associated entity
void	applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState)	Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.
void	applySqlSelections(NavigablePath navigablePath, TableGroup tableGroup, DomainResultCreationState creationState, BiConsumer<SqlSelection, JdbcMapping> selectionConsumer)	Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.
void	applyWhereRestrictions(Consumer<Predicate> predicateConsumer, TableGroup tableGroup, boolean useQualifier, SqlAstCreationState creationState)	Apply the SQLRestriction restrictions
CacheEntry	buildCacheEntry(Object entity, Object[] state, Object version, SharedSessionContractImplementor session)
protected AbstractEntityPersister.CacheEntryHelper	buildCacheEntryHelper(SessionFactoryOptions options)
protected DeleteCoordinator	buildDeleteCoordinator()
protected org.hibernate.metamodel.mapping.internal.EmbeddedAttributeMapping	buildEmbeddedAttributeMapping(String attrName, int stateArrayPosition, int fetchableIndex, Property bootProperty, DependantValue dependantValue, int dependantColumnIndex, ManagedMappingType declaringType, CompositeType attrType, String tableExpression, String[] rootTableKeyColumnNames, PropertyAccess propertyAccess, CascadeStyle cascadeStyle, org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)	For Hibernate Reactive
protected InsertCoordinator	buildInsertCoordinator()
protected UpdateCoordinator	buildMergeCoordinator()
protected MultiIdEntityLoader<?>	buildMultiIdLoader()	Used by Hibernate Reactive
protected AttributeMapping	buildPluralAttributeMapping(String attrName, int stateArrayPosition, int fetchableIndex, Property bootProperty, ManagedMappingType declaringType, PropertyAccess propertyAccess, CascadeStyle cascadeStyle, FetchMode fetchMode, org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)	For Hibernate Reactive
protected SingleIdEntityLoader<?>	buildSingleIdEntityLoader()	For Hibernate Reactive
protected AttributeMapping	buildSingularAssociationAttributeMapping(String attrName, NavigableRole navigableRole, int stateArrayPosition, int fetchableIndex, Property bootProperty, ManagedMappingType declaringType, EntityPersister declaringEntityPersister, EntityType attrType, PropertyAccess propertyAccess, CascadeStyle cascadeStyle, org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)	For Hibernate Reactive
protected EntityTableMapping[]	buildTableMappings()	Builds the EntityTableMapping descriptors for the tables mapped by this entity.
protected UpdateCoordinator	buildUpdateCoordinator()
boolean	canReadFromCache()
boolean	canUseReferenceCacheEntries()
boolean	canWriteToCache()
boolean	containsTableReference(String tableExpression)
int	countSubclassProperties()
<T> DomainResult<T>	createDomainResult(NavigablePath navigablePath, TableGroup tableGroup, String resultVariable, DomainResultCreationState creationState)	Create a DomainResult for a specific reference to this ModelPart.
protected org.hibernate.metamodel.mapping.internal.GeneratedValuesProcessor	createGeneratedValuesProcessor(EventType timing, List<AttributeMapping> generatedAttributes)
protected GeneratedValuesMutationDelegate	createInsertDelegate()
TableReference	createPrimaryTableReference(SqlAliasBase sqlAliasBase, SqlAstCreationState sqlAstCreationState)
Object	createProxy(Object id, SharedSessionContractImplementor session)	Create a new proxy instance
TableGroup	createRootTableGroup(boolean canUseInnerJoins, NavigablePath navigablePath, String explicitSourceAlias, SqlAliasBase explicitSqlAliasBase, Supplier<Consumer<Predicate>> additionalPredicateCollectorAccess, SqlAstCreationState creationState)	Create a root TableGroup as defined by this producer
TableReferenceJoin	createTableReferenceJoin(String joinTableExpression, SqlAliasBase sqlAliasBase, TableReference lhs, SqlAstCreationState creationState)
protected GeneratedValuesMutationDelegate	createUpdateDelegate()
protected SingleIdEntityLoader<?>	determineLoaderToUse(SharedSessionContractImplementor session, LockOptions lockOptions)
protected String	determineTableName(Table table)
protected int	determineTableNumberForColumn(String columnName)
Object	disassemble(Object value, SharedSessionContractImplementor session)	Breaks down a value of J into its simple pieces.
AttributeMapping	findAttributeMapping(String name)	Find an attribute by name.
AttributeMapping	findDeclaredAttributeMapping(String name)	Find an attribute-mapping, declared on this entity mapping (not super or subs), by name
int[]	findDirty(Object[] currentState, Object[] previousState, Object entity, SharedSessionContractImplementor session)	Locate the property-indices of all properties considered to be dirty.
int[]	findModified(Object[] old, Object[] current, Object entity, SharedSessionContractImplementor session)	Locate the property-indices of all properties considered to be dirty.
ModelPart	findSubPart(String name, EntityMappingType treatTargetType)
ModelPart	findSubTypesSubPart(String name, EntityMappingType treatTargetType)
Object	forceVersionIncrement(Object id, Object currentVersion, boolean batching, SharedSessionContractImplementor session)
Object	forceVersionIncrement(Object id, Object currentVersion, SharedSessionContractImplementor session)
void	forEachAttributeMapping(Consumer<? super AttributeMapping> action)	Visit each attribute mapping
void	forEachAttributeMapping(org.hibernate.internal.util.IndexedConsumer<? super AttributeMapping> consumer)	Visit attributes defined on this class and any supers
<X,Y> int	forEachDisassembledJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer, SharedSessionContractImplementor session)	Like Bindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when calling Bindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).
int	forEachJdbcType(int offset, org.hibernate.internal.util.IndexedConsumer<JdbcMapping> action)	Visit each JdbcMapping starting from the given offset
<X,Y> int	forEachJdbcValue(Object value, int offset, X x, Y y, Bindable.JdbcValuesBiConsumer<X,Y> consumer, SharedSessionContractImplementor session)	Visit each constituent JDBC value extracted from the entity instance itself.
void	forEachMutableTable(Consumer<EntityTableMapping> consumer)	Visit each table.
void	forEachMutableTableReverse(Consumer<EntityTableMapping> consumer)	Same as MutationTarget.forEachMutableTable(Consumer) except that here the tables are visited in reverse order
int	forEachSelectable(int offset, SelectableConsumer selectableConsumer)	Visits each selectable mapping with the selectable index offset by the given value.
void	forEachTableDetails(Consumer<TableDetails> consumer)	Visit details for each table associated with the entity.
protected EntityDiscriminatorMapping	generateDiscriminatorMapping(PersistentClass bootEntityDescriptor)
protected EntityIdentifierMapping	generateIdentifierMapping(Supplier<?> templateInstanceCreator, PersistentClass bootEntityDescriptor, org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)
protected Predicate	generateJoinPredicate(TableReference rootTableReference, TableReference joinedTableReference, String[] pkColumnNames, String[] fkColumnNames, SqlAstCreationState creationState)
protected LockingStrategy	generateLocker(LockMode lockMode, Locking.Scope lockScope)
protected NaturalIdMapping	generateNaturalIdMapping(org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess, PersistentClass bootEntityDescriptor)
protected EntityIdentifierMapping	generateNonEncapsulatedCompositeIdentifierMapping(org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess, PersistentClass bootEntityDescriptor)
protected AttributeMapping	generateNonIdAttributeMapping(NonIdentifierAttribute tupleAttrDefinition, Property bootProperty, int stateArrayPosition, int fetchableIndex, org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)
String	generateSelectVersionString()	Generate the SQL that selects the version number by id
static String	generateTableAlias(String rootAlias, int tableNumber)
protected TableReferenceJoin	generateTableReferenceJoin(TableReference lhs, String joinTableExpression, SqlAliasBase sqlAliasBase, boolean innerJoin, String[] targetColumns, SqlAstCreationState creationState)
protected EntityVersionMapping	generateVersionMapping(Supplier<?> templateInstanceCreator, PersistentClass bootEntityDescriptor, org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)
protected static EntityVersionMapping	generateVersionMapping(AbstractEntityPersister entityPersister, Supplier<?> templateInstanceCreator, PersistentClass bootModelRootEntityDescriptor, org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)
AttributeMapping	getAttributeMapping(int position)	Retrieve an attribute mapping by position, relative to all attributes
AttributeMappingsList	getAttributeMappings()	The attributes mapping for this entity, including those declared on supertype mappings
int	getBatchSize()	The batch size for batch loading.
EntityDataAccess	getCacheAccessStrategy()	Get the cache (optional operation)
CacheEntryStructure	getCacheEntryStructure()	Get the cache structure
static @Nullable Object	getCollectionKey(CollectionPersister persister, Object owner, EntityEntry ownerEntry, SharedSessionContractImplementor session)
Class<?>	getConcreteProxyClass()	Get the proxy interface that instances of this concrete class will be cast to (optional operation).
abstract String[]	getConstraintOrderedTableNameClosure()
Object	getCurrentVersion(Object id, SharedSessionContractImplementor session)	Retrieve the version number
Object[]	getDatabaseSnapshot(Object id, SharedSessionContractImplementor session)	Get the current database state of the object, in a "hydrated" form, without resolving identifiers.
AttributeMappingsMap	getDeclaredAttributeMappings()	Get access to the attributes defined on this class - do not access attributes defined on the super
DeleteCoordinator	getDeleteCoordinator()	Get the delete coordinator instance.
String	getDiscriminatorAlias()
String	getDiscriminatorAlias(String suffix)	Get the result set aliases used for the identifier columns, given a suffix
String	getDiscriminatorColumnName()
String	getDiscriminatorColumnReaders()
String	getDiscriminatorColumnReaderTemplate()
DiscriminatorType<?>	getDiscriminatorDomainType()	The type of the discriminator, or null if the entity does not have a discriminator.
String	getDiscriminatorFormulaTemplate()
EntityDiscriminatorMapping	getDiscriminatorMapping()	Mapping details for the entity's discriminator.
abstract BasicType<?>	getDiscriminatorType()	Get the discriminator type
EntityEntryFactory	getEntityEntryFactory()	Get the EntityEntryFactory indicated for the entity mapped by this persister.
EntityMetamodel	getEntityMetamodel()	Retrieve the underlying entity metamodel instance.
final String	getEntityName()	The entity name which this persister maps.
static Map<String,String>	getEntityNameByTableNameMap(PersistentClass persistentClass, SqlStringGenerationContext stringGenerationContext)
EntityPersister	getEntityPersister()	Safety-net.
SessionFactoryImplementor	getFactory()	Return the SessionFactory to which this persister belongs.
AttributeMapping	getFetchable(int position)
FetchMode	getFetchMode(int i)
Generator	getGenerator()
Object	getIdByUniqueKey(Object key, String uniquePropertyName, SharedSessionContractImplementor session)
Object	getIdentifier(Object entity, SharedSessionContractImplementor session)	Get the identifier of an instance from the object's identifier property.
Object	getIdentifier(Object entity, MergeContext mergeContext)	Get the identifier of an instance from the object's identifier property.
String[]	getIdentifierAliases()
String[]	getIdentifierAliases(String suffix)	Get the result set aliases used for the identifier columns, given a suffix
String[]	getIdentifierColumnNames()	Get the names of columns used to persist the identifier
String[]	getIdentifierColumnReaders()
String[]	getIdentifierColumnReaderTemplates()
int	getIdentifierColumnSpan()
ModelPart	getIdentifierDescriptor()	The ModelPart describing the identifier/key for this target
IdentifierGenerator	getIdentifierGenerator()	Deprecated.
EntityIdentifierMapping	getIdentifierMapping()	Mapping details for the entity's identifier.
String	getIdentifierPropertyName()	Get the name of the identifier property (or return null) - need not return the name of an actual Java property
EntityTableMapping	getIdentifierTableMapping()	The descriptor for the table containing the identifier for the target
String	getIdentifierTableName()	The name of the table defining the identifier for this target
Type	getIdentifierType()	Get the identifier type
String	getIdentitySelectString()	Get the database-specific SQL command to retrieve the last generated IDENTITY value.
InsertCoordinator	getInsertCoordinator()	Get the insert coordinator instance.
GeneratedValuesMutationDelegate	getInsertDelegate()
List<? extends ModelPart>	getInsertGeneratedProperties()
org.hibernate.metamodel.mapping.internal.GeneratedValuesProcessor	getInsertGeneratedValuesProcessor()
BytecodeEnhancementMetadata	getInstrumentationMetadata()	Deprecated, for removal: This API element is subject to removal in a future version.
JdbcMapping	getJdbcMapping(int index)
int	getJdbcTypeCount()	The number of JDBC mappings
@Nullable String	getJpaEntityName()	The JPA entity name, if one, associated with the entity.
Fetchable	getKeyFetchable(int position)
protected Map<String, org.hibernate.loader.ast.internal.SingleIdArrayLoadPlan>	getLazyLoadPlanByFetchGroup()
protected LockingStrategy	getLocker(LockMode lockMode, Locking.Scope lockScope)
final Class<?>	getMappedClass()	The persistent class, or null
JavaType<?>	getMappedJavaType()	The descriptor descriptor for the mapped Java type
String	getMappedSuperclass()	Get the name of the entity that is the "super class" for this entity
UpdateCoordinator	getMergeCoordinator()	Get the merge coordinator instance.
MultiNaturalIdLoader<?>	getMultiNaturalIdLoader()	Access to performing multi-value natural-id database selection.
NaturalIdDataAccess	getNaturalIdCacheAccessStrategy()	Get the NaturalId cache (optional operation)
Object	getNaturalIdentifierSnapshot(Object id, SharedSessionContractImplementor session)	Retrieve the current state of the natural-id properties from the database.
NaturalIdLoader<?>	getNaturalIdLoader()	Access to performing natural-id database selection.
NaturalIdMapping	getNaturalIdMapping()	The mapping for the natural-id of the entity, if one is defined
NavigableRole	getNavigableRole()	The model role of this target
boolean[]	getNonLazyPropertyUpdateability()
int	getNumberOfAttributeMappings()	The total number of attributes for this entity, including those declared on supertype mappings
int	getNumberOfDeclaredAttributeMappings()	Get the number of attributes defined on this entity mapping - do not access attributes defined on the super
int	getNumberOfFetchableKeys()	The number of fetchables in the container
int	getNumberOfFetchables()	The number of fetchables in the container
String	getPartName()	The local part name, which is generally the unqualified role name
String[]	getPropertyAliases(String suffix, int i)	Get the result set aliases used for the property columns, given a suffix (properties of this class, only).
CascadeStyle[]	getPropertyCascadeStyles()	Get the cascade styles of the properties (optional operation)
String[]	getPropertyColumnNames(int i)
String[]	getPropertyColumnNames(String propertyName)	Get the column names for the given property path
protected abstract int[]	getPropertyTableNumbers()
Type	getPropertyType(String propertyName)	Deprecated. by the supertypes
boolean[]	getPropertyUpdateability(Object entity)	Which properties appear in the SQL update? (Initialized, updateable ones!)
Object	getPropertyValue(Object object, int i)
Object	getPropertyValue(Object object, String path)	Get the value of a particular property
Object[]	getPropertyValues(Object object)
Object[]	getPropertyValuesToInsert(Object entity, Map<Object,Object> mergeMap, SharedSessionContractImplementor session)	Return the values of the insertable properties of the object (including backrefs)
protected String	getPrunedDiscriminatorPredicate(Map<String, EntityNameUse> entityNameUses, MappingMetamodelImplementor mappingMetamodel, String alias)
Serializable[]	getQuerySpaces()	Returns an array of objects that identify spaces in which properties of this entity are persisted, for instances of this class and its subclasses.
EntityRepresentationStrategy	getRepresentationStrategy()	Describes how the entity is represented in the application's domain model.
String	getRootEntityName()	Returns an object that identifies the space in which identifiers of this entity hierarchy are unique.
String[]	getRootTableIdentifierColumnNames()	Get the names of columns on the root table used to persist the identifier.
String[]	getRootTableKeyColumnNames()	The names of the primary key columns in the root table.
String	getRootTableName()	Locks are always applied to the "root table".
EntityRowIdMapping	getRowIdMapping()	The mapping for the row-id of the entity, if one is defined.
String	getSelectByUniqueKeyString(String propertyName)	Get a SQL select string that performs a select based on a unique key determined by the given property name.
String	getSelectByUniqueKeyString(String[] propertyNames)	Get a SQL select string that performs a select based on a unique key determined by the given property names.
String	getSelectByUniqueKeyString(String[] propertyNames, String[] columnNames)
SingleIdEntityLoader<?>	getSingleIdLoader()
SoftDeleteMapping	getSoftDeleteMapping()	Mapping for soft-delete support, or null if soft-delete not defined
String	getSqlAliasStem()	Get the "stem" used as the base for generating SQL table aliases for table references that are part of the TableGroup being generated
protected String	getSqlWhereStringTableExpression()
SqmMultiTableInsertStrategy	getSqmMultiTableInsertStrategy()
SqmMultiTableMutationStrategy	getSqmMultiTableMutationStrategy()	The strategy to use for SQM mutation statements where the target entity has multiple tables.
protected int	getStateArrayInitialPosition(org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)
protected AttributeMappingsList	getStaticFetchableList()
abstract Map<Object,String>	getSubclassByDiscriminatorValue()
protected String[]	getSubclassColumnAliasClosure()	Deprecated. Hibernate no longer uses aliases to read from result sets
EntityPersister	getSubclassEntityPersister(Object instance, SessionFactoryImplementor factory)	Obtain the EntityPersister for the concrete class of the given entity instance which participates in a mapped inheritance hierarchy with this persister.
protected String[]	getSubclassFormulaAliasClosure()	Deprecated. Hibernate no longer uses aliases to read from result sets
String[]	getSubclassPropertyColumnAliases(String propertyName, String suffix)	Deprecated. Hibernate no longer uses aliases to read from result sets
protected String[][]	getSubclassPropertyColumnNameClosure()
String[]	getSubclassPropertyColumnNames(int i)
String[][]	getSubclassPropertyColumnReaderClosure()
String[][]	getSubclassPropertyColumnReaderTemplateClosure()
String[][]	getSubclassPropertyFormulaTemplateClosure()
protected String[]	getSubclassPropertyNameClosure()
Type	getSubclassPropertyType(int i)
protected Type[]	getSubclassPropertyTypeClosure()
protected abstract String[]	getSubclassTableKeyColumns(int j)
protected abstract String[]	getSubclassTableNames()
Collection<EntityMappingType>	getSubMappingTypes()	Retrieve mappings for all subtypes
EntityMappingType	getSuperMappingType()	The mapping for the entity which is the supertype for this entity mapping.
static int	getTableId(String tableName, String[] tables)
protected EntityTableMapping	getTableMapping(int i)
EntityTableMapping[]	getTableMappings()
String	getTableNameForColumn(String columnName)
String[]	getTableNames()
EntityMappingType	getTargetPart()	The ModelPart describing the mutation target
protected SingleUniqueKeyEntityLoader<?>	getUniqueKeyLoader(String attributeName, SharedSessionContractImplementor session)
UpdateCoordinator	getUpdateCoordinator()	Get the update coordinator instance.
GeneratedValuesMutationDelegate	getUpdateDelegate()
List<? extends ModelPart>	getUpdateGeneratedProperties()
org.hibernate.metamodel.mapping.internal.GeneratedValuesProcessor	getUpdateGeneratedValuesProcessor()
Object	getVersion(Object object)	Get the version number (or timestamp) from the object's version property.
String	getVersionColumnName()	For versioned entities, get the name of the column (again, expected on the root table) used to store the version values.
String	getVersionedTableName()
BeforeExecutionGenerator	getVersionGenerator()
EntityVersionMapping	getVersionMapping()	Mapping details for the entity's version when using the version strategy.
String	getVersionSelectString()
BasicType<?>	getVersionType()	If EntityPersister.isVersioned(), then what is the type of the property holding the locking value.
boolean	hasCache()	Does this class have a cache.
boolean	hasCollectionNotReferencingPK()	Determine whether this entity contains references to persistent collections not referencing the primary key.
boolean	hasFilterForLoadByKey()
boolean	hasFormulaProperties()
boolean	hasIdentifierProperty()	Determine whether the entity has a particular property holding the identifier value.
boolean	hasInsertGeneratedProperties()	Does this entity define any properties as being database generated on insert?
boolean	hasMultipleTables()
boolean	hasNaturalIdCache()	Does this class have a natural id cache
boolean	hasPartitionedSelectionMapping()
boolean	hasPreInsertGeneratedProperties()
boolean	hasPreUpdateGeneratedProperties()
boolean	hasProxy()	Determine whether this entity supports dynamic proxies.
boolean	hasRowId()	Does the result set contain rowids?
boolean	hasSubselectLoadableCollections()	Determine whether this entity contains references to persistent collections which are fetchable by subselect?
boolean	hasUninitializedLazyProperties(Object object)	Does the given instance have any uninitialized lazy properties?
boolean	hasUpdateGeneratedProperties()	Does this entity define any properties as being database generated on update?
boolean	hasWhereRestrictions()	Does this restrictable have a where restriction?
Object	initializeEnhancedEntityUsedAsProxy(Object entity, String nameOfAttributeBeingAccessed, SharedSessionContractImplementor session)	Called from EnhancementAsProxyLazinessInterceptor to trigger load of the entity's non-lazy state as well as the named attribute we are accessing if it is still uninitialized after fetching non-lazy state.
protected Object	initializeLazyPropertiesFromCache(String fieldName, Object entity, SharedSessionContractImplementor session, EntityEntry entry, CacheEntry cacheEntry)
protected Object	initializeLazyPropertiesFromDatastore(Object entity, Object id, EntityEntry entry, String fieldName, SharedSessionContractImplementor session)
protected void	initializeLazyProperty(Object entity, EntityEntry entry, Object propValue, int index, Type type)
protected boolean	initializeLazyProperty(String fieldName, Object entity, EntityEntry entry, int index, Object propValue)	Called by Hibernate Reactive
protected boolean	initializeLazyProperty(String fieldName, Object entity, EntityEntry entry, LazyAttributeDescriptor fetchGroupAttributeDescriptor, Object propValue)	Deprecated, for removal: This API element is subject to removal in a future version.
Object	initializeLazyProperty(String fieldName, Object entity, SharedSessionContractImplementor session)	Initialize the property, and return its new value.
protected List<? extends ModelPart>	initInsertGeneratedProperties(List<AttributeMapping> generatedAttributes)
protected void	initPropertyPaths(Metadata mapping)
protected void	initSubclassPropertyAliasesMap(PersistentClass model)	Deprecated. Hibernate no longer uses aliases to read from result sets
protected List<? extends ModelPart>	initUpdateGeneratedProperties(List<AttributeMapping> generatedAttributes)
Object	instantiate(Object id, SharedSessionContractImplementor session)	Create a class instance initialized with the given identifier
protected static SqmMultiTableInsertStrategy	interpretSqmMultiTableInsertStrategy(AbstractEntityPersister entityMappingDescriptor, org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)
protected static SqmMultiTableMutationStrategy	interpretSqmMultiTableStrategy(AbstractEntityPersister entityMappingDescriptor, org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)
boolean	isAffectedByEnabledFetchProfiles(LoadQueryInfluencers loadQueryInfluencers)	Whether any of the LoadQueryInfluencers.getEnabledFetchProfileNames() apply to this loadable
boolean	isAffectedByEnabledFilters(LoadQueryInfluencers loadQueryInfluencers, boolean onlyApplyForLoadByKeyFilters)	Whether any of the "influencers" affect this loadable.
boolean	isAffectedByEntityGraph(LoadQueryInfluencers loadQueryInfluencers)	Whether the effective entity-graph applies to this loadable
boolean	isCacheInvalidationRequired()	We can't immediately add to the cache if we have formulas which must be evaluated, or if we have the possibility of two concurrent updates to the same item being merged on the database.
protected boolean	isClassOrSuperclassJoin(int j)
protected abstract boolean	isClassOrSuperclassTable(int j)
boolean	isConcreteProxy()	Returns true if this entity type's hierarchy is configured to return concrete-typed proxies.
protected boolean	isDiscriminatorFormula()
boolean	isIdentifierAssignedByInsert()	Are identifiers of this entity assigned known before the insert execution? Or, are they generated (in the database) by the insert execution.
protected abstract boolean	isIdentifierTable(String tableExpression)
boolean	isInstance(Object object)	Is the given object an instance of this entity?
boolean	isInstrumented()	Whether this class can be lazy (ie intercepted)
boolean	isInverseTable(int j)
boolean	isLazyPropertiesCacheable()	Should lazy properties of this entity be cached?
protected boolean	isNonLazyPropertyName(String fieldName)
protected boolean	isNullableSubclassTable(int j)
boolean	isNullableTable(int j)
protected boolean	isPhysicalDiscriminator()
abstract boolean	isPropertyOfTable(int property, int j)
boolean	isSelectBeforeUpdateRequired()	Is select snapshot before update enabled?
boolean	isSharedColumn(String columnExpression)
boolean	isSubclassEntityName(String entityName)	Determine whether the given name represents a subclass entity (or this entity itself) of the entity mapped by this persister.
protected boolean	isSubclassTableIndicatedByTreatAsDeclarations(int subclassTableNumber, Set<String> treatAsDeclarations)
abstract boolean	isTableCascadeDeleteEnabled(int j)
Boolean	isTransient(Object entity, SharedSessionContractImplementor session)	Is this a new transient instance?
boolean	isTypeOrSuperType(EntityMappingType targetType)	Whether the passed entity mapping is the same as or is a supertype of this entity mapping
boolean	isVersionGeneratedBeforeExecution()
boolean	isVersionGeneratedOnExecution()
boolean	isVersionPropertyGenerated()	Does this entity contain a version property that is defined to be database generated?
protected void	linkToSession(Object entity, SharedSessionContractImplementor session)
void	linkWithSubType(EntityMappingType sub, org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)
void	linkWithSuperType(org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)
Object	load(Object id, Object optionalObject, LockMode lockMode, SharedSessionContractImplementor session)	Load an instance using either the forUpdateLoader or the outer joining loader, depending upon the value of the lock parameter
Object	load(Object id, Object optionalObject, LockOptions lockOptions, SharedSessionContractImplementor session)	Load an instance using either the forUpdateLoader or the outer joining loader, depending upon the value of the lock parameter
Object	load(Object id, Object optionalObject, LockOptions lockOptions, SharedSessionContractImplementor session, Boolean readOnly)
Object	loadByUniqueKey(String propertyName, Object uniqueKey, Boolean readOnly, SharedSessionContractImplementor session)
Object	loadByUniqueKey(String propertyName, Object uniqueKey, SharedSessionContractImplementor session)	Load an instance of the persistent class, by a unique key other than the primary key.
Object	loadEntityIdByNaturalId(Object[] naturalIdValues, LockOptions lockOptions, SharedSessionContractImplementor session)	Load the id for the entity based on the natural id.
void	lock(Object id, Object version, Object object, LockMode lockMode, SharedSessionContractImplementor session)	Do a version check (optional operation)
void	lock(Object id, Object version, Object object, LockMode lockMode, EventSource session)	Do a version check (optional operation)
void	lock(Object id, Object version, Object object, LockOptions lockOptions, SharedSessionContractImplementor session)	Do a version check (optional operation)
void	lock(Object id, Object version, Object object, LockOptions lockOptions, EventSource session)	Do a version check (optional operation)
protected void	logStaticSQL()
boolean	managesColumns(String[] columnNames)
List<?>	multiLoad(Object[] ids, SharedSessionContractImplementor session, MultiIdLoadOptions loadOptions)	Performs a load of multiple entities (of this type) by identifier simultaneously.
List<?>	multiLoad(Object[] ids, EventSource session, MultiIdLoadOptions loadOptions)	Performs a load of multiple entities (of this type) by identifier simultaneously.
abstract boolean	needsDiscriminator()
final OptimisticLockStyle	optimisticLockStyle()	The type of optimistic locking, if any, defined for this entity mapping
String	physicalTableNameForMutation(SelectableMapping selectableMapping)	Unfortunately we cannot directly use `SelectableMapping#getContainingTableExpression()` as that blows up for attributes declared on super-type for union-subclass mappings
protected void	postConstruct(Metadata mapping)	Post-construct is a callback for AbstractEntityPersister subclasses to call after they are all done with their constructor processing.
final void	postInstantiate()	Finish the initialization of this object.
void	prepareLoaders()	Prepare loaders associated with the persister.
void	prepareMappingModel(org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)
void	processInsertGeneratedProperties(Object id, Object entity, Object[] state, GeneratedValues generatedValues, SharedSessionContractImplementor session)	Retrieve the values of any insert generated properties through the provided GeneratedValues or, when that's not available, by selecting them back from the database, injecting these generated values into the given entity as well as writing this state to the PersistenceContext.
void	processUpdateGeneratedProperties(Object id, Object entity, Object[] state, GeneratedValues generatedValues, SharedSessionContractImplementor session)	Retrieve the values of any update generated properties through the provided GeneratedValues or, when that's not available, by selecting them back from the database, injecting these generated values into the given entity as well as writing this state to the PersistenceContext.
void	registerAffectingFetchProfile(String fetchProfileName)
void	resetIdentifier(Object entity, Object currentId, Object currentVersion, SharedSessionContractImplementor session)	Set the identifier and version of the given instance back to its "unsaved" value, that is, the value it had before it was made persistent.
int[]	resolveAttributeIndexes(String[] attributeNames)	Converts an array of attribute names to a set of indexes, according to the entity metamodel
EntityMappingType	resolveConcreteProxyTypeForId(Object id, SharedSessionContractImplementor session)	If this entity is configured to return concrete-typed proxies, this method queries the entity table(s) do determine the concrete entity type associated with the provided id and returns its persister.
int[]	resolveDirtyAttributeIndexes(Object[] currentState, Object[] previousState, String[] attributeNames, SessionImplementor session)	Like EntityPersister.resolveAttributeIndexes(String[]) but also always returns mutable attributes
String	selectFragment(String alias, String suffix)	All columns to select, when loading.
void	setIdentifier(Object entity, Object id, SharedSessionContractImplementor session)	Inject the identifier value into the given entity.
void	setPropertyValue(Object object, int i, Object value)	Set the value of a particular property of the given instance.
void	setPropertyValues(Object object, Object[] values)	Set the given values to the mapped properties of the given object.
protected boolean	shouldGetAllProperties(Object entity)
protected boolean	shouldInnerJoinSubclassTable(int subclassTableNumber, Set<String> treatAsDeclarations)
protected boolean	shouldProcessSuperMapping()
boolean	storeDiscriminatorInShallowQueryCacheLayout()
protected String	substituteBrackets(String sql)
String[]	toColumns(String propertyName)	Given a property path, return the corresponding column name(s).
String	toString()
Iterable<UniqueKeyEntry>	uniqueKeyEntries()
boolean	useShallowQueryCacheLayout()
protected void	verifyHasNaturalId()
void	visitAttributeMappings(Consumer<? super AttributeMapping> action)	Visit the mappings, but limited to just attributes defined in the targetType or its super-type(s) if any.
void	visitDeclaredAttributeMappings(Consumer<? super AttributeMapping> action)	Visit attributes defined on this class - do not visit attributes defined on the super
void	visitFetchables(Consumer<? super Fetchable> fetchableConsumer, EntityMappingType treatTargetType)
void	visitFetchables(org.hibernate.internal.util.IndexedConsumer<? super Fetchable> fetchableConsumer, EntityMappingType treatTargetType)
void	visitKeyFetchables(Consumer<? super Fetchable> fetchableConsumer, EntityMappingType treatTargetType)
void	visitKeyFetchables(org.hibernate.internal.util.IndexedConsumer<? super Fetchable> fetchableConsumer, EntityMappingType treatTargetType)
protected abstract void	visitMutabilityOrderedTables(AbstractEntityPersister.MutabilityOrderedTableConsumer consumer)	Visit details about each table for this entity, using "mutability ordering".
void	visitSubParts(Consumer<ModelPart> consumer, EntityMappingType treatTargetType)
void	visitSubTypeAttributeMappings(Consumer<? super AttributeMapping> action)	Walk this type's attributes as well as its subtypes
void	visitSuperTypeAttributeMappings(Consumer<? super AttributeMapping> action)	Walk this type's attributes as well as its super-type's

Methods inherited from class EntityMetamodel

getBytecodeEnhancementMetadata, getBytecodeEnhancementMetadataPojo, getCascadeStyles, getDirtyCheckablePropertyTypes, getEntityType, getGenerators, getIdentifierProperty, getMutablePropertiesIndexes, getName, getNaturalIdentifierProperties, getNonlazyPropertyUpdateability, getOptimisticLockStyle, getProperties, getPropertyCheckability, getPropertyIndex, getPropertyIndexOrNull, getPropertyInsertability, getPropertyLaziness, getPropertyNames, getPropertyNullability, getPropertyOnDeleteActions, getPropertySpan, getPropertyTypes, getPropertyUpdateability, getPropertyVersionability, getRootName, getSessionFactory, getSubclassEntityNames, getSubclassId, getSuperclass, getVersionProperty, getVersionPropertyIndex, hasCascadeDelete, hasCascadePersist, hasCascades, hasCollections, hasImmutableNaturalId, hasInsertGeneratedValues, hasLazyProperties, hasMutableProperties, hasNaturalIdentifier, hasNonIdentifierPropertyNamedId, hasOwnedCollections, hasPreInsertGeneratedValues, hasPreUpdateGeneratedValues, hasSubclasses, hasToOnes, hasUpdateGeneratedValues, isAbstract, isDynamicInsert, isDynamicUpdate, isExplicitPolymorphism, isInherited, isLazy, isMutable, isNaturalIdentifierCached, isNaturalIdentifierInsertGenerated, isPolymorphic, isSelectBeforeUpdate, isVersioned, setLazy

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface AttributeSource

getPropertyIndex

Methods inherited from interface Bindable

forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachDisassembledJdbcValue, forEachJdbcType, forEachJdbcValue, forEachJdbcValue, forEachJdbcValue

Methods inherited from interface EntityMappingType

asEntityMappingType, createRootGraph, extractConcreteTypeStateValues, findContainingEntityMapping, findSubPart, getContributor, getDiscriminatorSQLValue, getDiscriminatorValue, getIdentifierMappingForJoin, getIdentifierTableDetails, getJavaType, getMappedTableDetails, getPartMappingType, getRootEntityDescriptor, getRootPathName, getSoftDeleteTableDetails, getSubclassEntityNames, getSubclassId, hasSubclasses, isAbstract, isExplicitPolymorphism, isTypeOrSuperType, pruneForSubclasses, visitConstraintOrderedTables

Methods inherited from interface EntityMutationTarget

getAttributeMutationTableName, getIdentityInsertDelegate, getMutationDelegate

Methods inherited from interface EntityPersister

addToCacheKey, breakDownJdbcValues, canExtractIdOutOfEntity, delete, getBytecodeEnhancementMetadata, getConstraintOrderedTableKeyColumnClosure, getEntityMappingType, getFilterAliasGenerator, getFilterAliasGenerator, getGeneratedProperties, getGenerators, getIdentifier, getImportedName, getKeyColumns, getNaturalIdentifierProperties, getPropertyCheckability, getPropertyInsertability, getPropertyLaziness, getPropertyNames, getPropertyNullability, getPropertyOnDeleteActions, getPropertySpaces, getPropertySpan, getPropertyTypes, getPropertyUpdateability, getPropertyVersionability, getSubclassTableName, getSubclassTableSpan, getSynchronizationSpaces, getSynchronizedQuerySpaces, getTableName, getTableName, getTableSpan, getTypeDiscriminatorMetadata, getValue, getValues, getVersionJavaType, getVersionPropertyIndex, hasCascadeDelete, hasCascadePersist, hasCascades, hasCollections, hasDuplicateTables, hasImmutableNaturalId, hasLazyProperties, hasMutableProperties, hasNaturalIdentifier, hasOwnedCollections, hasToOnes, insert, insert, isBatchLoadable, isDynamicInsert, isDynamicUpdate, isInherited, isLazy, isMutable, isNaturalIdentifierInsertGenerated, isPolymorphic, isVersioned, merge, processInsertGeneratedProperties, processUpdateGeneratedProperties, setValue, setValues, update, visitQuerySpaces

Methods inherited from interface EntityValuedModelPart

forEachSubPart

Methods inherited from interface FetchableContainer

getNumberOfKeyFetchables, getSelectableIndex, visitFetchables, visitKeyFetchables

Methods inherited from interface FilterRestrictable

applyFilterRestrictions

Methods inherited from interface JdbcMappingContainer

getSingleJdbcMapping

Methods inherited from interface Loadable

isAffectedByEnabledFilters, isAffectedByInfluencers, isAffectedByInfluencers, isNotAffectedByInfluencers

Methods inherited from interface ManagedMappingType

anyRequiresAggregateColumnWriter, isAffectedByEnabledFilters

Methods inherited from interface ModelPart

areEqual, asAttributeMapping, asBasicValuedModelPart, breakDownJdbcValues, decompose, decompose, forEachSelectable, isEntityIdentifierMapping, isVirtual

Methods inherited from interface ModelPartContainer

findByPath, findByPath, forEachSubPart

Methods inherited from interface MutationTarget

getRolePath

Methods inherited from interface Restrictable

applyBaseRestrictions

Field Details

ENTITY_ID

@Deprecated(since="6.2")
public static final String ENTITY_ID

Deprecated.

this feature of HQL is now deprecated

The property name of the "special" identifier property in HQL

See Also:

• Constant Field Values

ENTITY_CLASS

public static final String ENTITY_CLASS

See Also:

• Constant Field Values

VERSION_COLUMN_ALIAS

public static final String VERSION_COLUMN_ALIAS

See Also:

• Constant Field Values

ROWID_ALIAS

public static final String ROWID_ALIAS

See Also:

• Constant Field Values

batchSize

protected final int batchSize

rowIdName

protected final String rowIdName

insertGeneratedProperties

protected List<? extends ModelPart> insertGeneratedProperties

updateGeneratedProperties

protected List<? extends ModelPart> updateGeneratedProperties

declaredAttributeMappings

protected AttributeMappingsMap declaredAttributeMappings

staticFetchableList

protected AttributeMappingsList staticFetchableList

accessOptimizer

protected ReflectionOptimizer.AccessOptimizer accessOptimizer

fullDiscriminatorSQLValues

protected final String[] fullDiscriminatorSQLValues

insertExpectations

@Deprecated
protected Expectation[] insertExpectations

Deprecated.

updateExpectations

@Deprecated
protected Expectation[] updateExpectations

Deprecated.

deleteExpectations

@Deprecated
protected Expectation[] deleteExpectations

Deprecated.

insertCallable

@Deprecated
protected boolean[] insertCallable

Deprecated.

updateCallable

@Deprecated
protected boolean[] updateCallable

Deprecated.

deleteCallable

@Deprecated
protected boolean[] deleteCallable

Deprecated.

customSQLInsert

@Deprecated
protected String[] customSQLInsert

Deprecated.

customSQLUpdate

@Deprecated
protected String[] customSQLUpdate

Deprecated.

customSQLDelete

@Deprecated
protected String[] customSQLDelete

Deprecated.

Constructor Details

AbstractEntityPersister

public AbstractEntityPersister(PersistentClass persistentClass,
 EntityDataAccess cacheAccessStrategy,
 NaturalIdDataAccess naturalIdRegionAccessStrategy,
 RuntimeModelCreationContext creationContext)
                        throws HibernateException

Throws:

HibernateException

Method Details

buildSingleIdEntityLoader

protected SingleIdEntityLoader<?> buildSingleIdEntityLoader()

For Hibernate Reactive

getEntityNameByTableNameMap

public static Map<String,String> getEntityNameByTableNameMap(PersistentClass persistentClass,
 SqlStringGenerationContext stringGenerationContext)

buildMultiIdLoader

protected MultiIdEntityLoader<?> buildMultiIdLoader()

Used by Hibernate Reactive

getSubclassTableNames

protected abstract String[] getSubclassTableNames()

getSubclassTableKeyColumns

protected abstract String[] getSubclassTableKeyColumns(int j)

isClassOrSuperclassTable

protected abstract boolean isClassOrSuperclassTable(int j)

isClassOrSuperclassJoin

protected boolean isClassOrSuperclassJoin(int j)

isPropertyOfTable

public abstract boolean isPropertyOfTable(int property,
 int j)

getPropertyTableNumbers

protected abstract int[] getPropertyTableNumbers()

getDiscriminatorColumnName

public String getDiscriminatorColumnName()

Specified by:

getDiscriminatorColumnName in interface EntityPersister

Returns:

the column name for the discriminator as specified in the mapping.

getDiscriminatorColumnReaders

public String getDiscriminatorColumnReaders()

getDiscriminatorColumnReaderTemplate

public String getDiscriminatorColumnReaderTemplate()

getDiscriminatorFormulaTemplate

public String getDiscriminatorFormulaTemplate()

isInverseTable

public boolean isInverseTable(int j)

Specified by:

isInverseTable in interface EntityPersister

isNullableTable

public boolean isNullableTable(int j)

Specified by:

isNullableTable in interface EntityPersister

isNullableSubclassTable

protected boolean isNullableSubclassTable(int j)

isSubclassEntityName

public boolean isSubclassEntityName(String entityName)

Description copied from interface: EntityPersister

Determine whether the given name represents a subclass entity (or this entity itself) of the entity mapped by this persister.

Specified by:

isSubclassEntityName in interface EntityPersister

Parameters:

entityName - The entity name to be checked.

Returns:

True if the given entity name represents either the entity mapped by this persister or one of its subclass entities; false otherwise.

isSharedColumn

public boolean isSharedColumn(String columnExpression)

Specified by:

isSharedColumn in interface EntityPersister

getRootTableKeyColumnNames

public String[] getRootTableKeyColumnNames()

Description copied from interface: EntityPersister

The names of the primary key columns in the root table.

Specified by:

getRootTableKeyColumnNames in interface EntityPersister

Returns:

The primary key column names.

getInsertCoordinator

public InsertCoordinator getInsertCoordinator()

Description copied from interface: EntityPersister

Get the insert coordinator instance.

Specified by:

getInsertCoordinator in interface EntityPersister

getUpdateCoordinator

public UpdateCoordinator getUpdateCoordinator()

Description copied from interface: EntityPersister

Get the update coordinator instance.

Specified by:

getUpdateCoordinator in interface EntityPersister

getDeleteCoordinator

public DeleteCoordinator getDeleteCoordinator()

Description copied from interface: EntityPersister

Get the delete coordinator instance.

Specified by:

getDeleteCoordinator in interface EntityPersister

getMergeCoordinator

public UpdateCoordinator getMergeCoordinator()

Description copied from interface: EntityPersister

Get the merge coordinator instance.

Specified by:

getMergeCoordinator in interface EntityPersister

getVersionSelectString

public String getVersionSelectString()

getInsertGeneratedValuesProcessor

@Internal
public org.hibernate.metamodel.mapping.internal.GeneratedValuesProcessor getInsertGeneratedValuesProcessor()

getUpdateGeneratedValuesProcessor

@Internal
public org.hibernate.metamodel.mapping.internal.GeneratedValuesProcessor getUpdateGeneratedValuesProcessor()

hasRowId

public boolean hasRowId()

Description copied from interface: EntityPersister

Does the result set contain rowids?

Specified by:

hasRowId in interface EntityPersister

getTableNames

public String[] getTableNames()

Specified by:

getTableNames in interface EntityPersister

buildCacheEntryHelper

protected AbstractEntityPersister.CacheEntryHelper buildCacheEntryHelper(SessionFactoryOptions options)

canUseReferenceCacheEntries

public boolean canUseReferenceCacheEntries()

Specified by:

canUseReferenceCacheEntries in interface EntityPersister

useShallowQueryCacheLayout

public boolean useShallowQueryCacheLayout()

Specified by:

useShallowQueryCacheLayout in interface EntityPersister

storeDiscriminatorInShallowQueryCacheLayout

public boolean storeDiscriminatorInShallowQueryCacheLayout()

Specified by:

storeDiscriminatorInShallowQueryCacheLayout in interface EntityPersister

hasFilterForLoadByKey

public boolean hasFilterForLoadByKey()

Specified by:

hasFilterForLoadByKey in interface EntityPersister

uniqueKeyEntries

public Iterable<UniqueKeyEntry> uniqueKeyEntries()

Specified by:

uniqueKeyEntries in interface EntityPersister

Returns:

Metadata for each unique key defined

getLazyLoadPlanByFetchGroup

protected Map<String, org.hibernate.loader.ast.internal.SingleIdArrayLoadPlan> getLazyLoadPlanByFetchGroup()

getSqlAliasStem

public String getSqlAliasStem()

Description copied from interface: TableGroupProducer

Get the "stem" used as the base for generating SQL table aliases for table references that are part of the TableGroup being generated

Note that this is a metadata-ive value. It is only ever used internal to the producer producing its TableGroup.

Specified by:

getSqlAliasStem in interface EntityMappingType

Specified by:

getSqlAliasStem in interface EntityPersister

Specified by:

getSqlAliasStem in interface TableGroupProducer

See Also:

• SqlAliasBaseManager.createSqlAliasBase(String)

containsTableReference

public boolean containsTableReference(String tableExpression)

Specified by:

containsTableReference in interface TableGroupProducer

getPartName

public String getPartName()

Description copied from interface: ModelPart

The local part name, which is generally the unqualified role name

Specified by:

getPartName in interface EntityMappingType

Specified by:

getPartName in interface ModelPart

createDomainResult

public <T> DomainResult<T> createDomainResult(NavigablePath navigablePath,
 TableGroup tableGroup,
 String resultVariable,
 DomainResultCreationState creationState)

Description copied from interface: ModelPart

Create a DomainResult for a specific reference to this ModelPart.

Specified by:

createDomainResult in interface EntityValuedModelPart

Specified by:

createDomainResult in interface ModelPart

applySqlSelections

public void applySqlSelections(NavigablePath navigablePath,
 TableGroup tableGroup,
 DomainResultCreationState creationState)

Description copied from interface: ModelPart

Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.

Specified by:

applySqlSelections in interface EntityValuedModelPart

Specified by:

applySqlSelections in interface ModelPart

applySqlSelections

public void applySqlSelections(NavigablePath navigablePath,
 TableGroup tableGroup,
 DomainResultCreationState creationState,
 BiConsumer<SqlSelection, JdbcMapping> selectionConsumer)

Description copied from interface: ModelPart

Apply SQL selections for a specific reference to this ModelPart outside the domain query's root select clause.

Specified by:

applySqlSelections in interface EntityValuedModelPart

Specified by:

applySqlSelections in interface ModelPart

getNaturalIdMapping

public NaturalIdMapping getNaturalIdMapping()

Description copied from interface: EntityMappingType

The mapping for the natural-id of the entity, if one is defined

Specified by:

getNaturalIdMapping in interface EntityMappingType

createPrimaryTableReference

public TableReference createPrimaryTableReference(SqlAliasBase sqlAliasBase,
 SqlAstCreationState sqlAstCreationState)

Specified by:

createPrimaryTableReference in interface EntityMappingType

createTableReferenceJoin

public TableReferenceJoin createTableReferenceJoin(String joinTableExpression,
 SqlAliasBase sqlAliasBase,
 TableReference lhs,
 SqlAstCreationState creationState)

Specified by:

createTableReferenceJoin in interface EntityMappingType

generateTableReferenceJoin

protected TableReferenceJoin generateTableReferenceJoin(TableReference lhs,
 String joinTableExpression,
 SqlAliasBase sqlAliasBase,
 boolean innerJoin,
 String[] targetColumns,
 SqlAstCreationState creationState)

generateJoinPredicate

protected Predicate generateJoinPredicate(TableReference rootTableReference,
 TableReference joinedTableReference,
 String[] pkColumnNames,
 String[] fkColumnNames,
 SqlAstCreationState creationState)

initializeLazyProperty

public Object initializeLazyProperty(String fieldName,
 Object entity,
 SharedSessionContractImplementor session)

Description copied from interface: LazyPropertyInitializer

Initialize the property, and return its new value.

Specified by:

initializeLazyProperty in interface LazyPropertyInitializer

Parameters:

fieldName - The name of the field being initialized

entity - The entity on which the initialization is occurring

session - The session from which the initialization originated.

Returns:

?

getCollectionKey

public static @Nullable Object getCollectionKey(CollectionPersister persister,
 Object owner,
 EntityEntry ownerEntry,
 SharedSessionContractImplementor session)

initializeLazyPropertiesFromDatastore

protected Object initializeLazyPropertiesFromDatastore(Object entity,
 Object id,
 EntityEntry entry,
 String fieldName,
 SharedSessionContractImplementor session)

isNonLazyPropertyName

protected boolean isNonLazyPropertyName(String fieldName)

initializeLazyPropertiesFromCache

protected Object initializeLazyPropertiesFromCache(String fieldName,
 Object entity,
 SharedSessionContractImplementor session,
 EntityEntry entry,
 CacheEntry cacheEntry)

initializeLazyProperty

protected boolean initializeLazyProperty(String fieldName,
 Object entity,
 EntityEntry entry,
 int index,
 Object propValue)

Called by Hibernate Reactive

initializeLazyProperty

@Deprecated(since="7.2",
            forRemoval=true)
protected boolean initializeLazyProperty(String fieldName,
 Object entity,
 EntityEntry entry,
 LazyAttributeDescriptor fetchGroupAttributeDescriptor,
 Object propValue)

Deprecated, for removal: This API element is subject to removal in a future version.

Used by Hibernate Reactive

initializeLazyProperty

protected void initializeLazyProperty(Object entity,
 EntityEntry entry,
 Object propValue,
 int index,
 Type type)

getNavigableRole

public NavigableRole getNavigableRole()

Description copied from interface: MutationTarget

The model role of this target

Specified by:

getNavigableRole in interface ModelPart

Specified by:

getNavigableRole in interface MutationTarget<EntityTableMapping>

See Also:

• ModelPart.getPartName()

getQuerySpaces

public Serializable[] getQuerySpaces()

Description copied from interface: EntityPersister

Returns an array of objects that identify spaces in which properties of this entity are persisted, for instances of this class and its subclasses.

Much like EntityPersister.getPropertySpaces(), except that here we include subclass entity spaces.

Specified by:

getQuerySpaces in interface EntityPersister

Returns:

The query spaces.

getBatchSize

public int getBatchSize()

Description copied from interface: EntityPersister

The batch size for batch loading.

Specified by:

getBatchSize in interface EntityPersister

Specified by:

getBatchSize in interface Loadable

See Also:

• LoadQueryInfluencers.effectiveBatchSize(EntityPersister)

getIdentifierColumnNames

public String[] getIdentifierColumnNames()

Description copied from interface: EntityPersister

Get the names of columns used to persist the identifier

Specified by:

getIdentifierColumnNames in interface EntityPersister

getIdentifierColumnReaders

public String[] getIdentifierColumnReaders()

getIdentifierColumnReaderTemplates

public String[] getIdentifierColumnReaderTemplates()

getIdentifierColumnSpan

public int getIdentifierColumnSpan()

getIdentifierAliases

public String[] getIdentifierAliases()

getVersionColumnName

public String getVersionColumnName()

Description copied from interface: EntityPersister

For versioned entities, get the name of the column (again, expected on the root table) used to store the version values.

Specified by:

getVersionColumnName in interface EntityPersister

Returns:

The version column name.

getVersionedTableName

public String getVersionedTableName()

isCacheInvalidationRequired

public boolean isCacheInvalidationRequired()

We can't immediately add to the cache if we have formulas which must be evaluated, or if we have the possibility of two concurrent updates to the same item being merged on the database. This second case can happen if:

1. the item is not versioned, and either
2. we have dynamic update enabled, or
3. the state of the item spans multiple tables.

Therefore, we're careful, and just invalidate the cache in these cases (the item will be readded when it's read again fresh from the database).

Specified by:

isCacheInvalidationRequired in interface EntityPersister

isLazyPropertiesCacheable

public boolean isLazyPropertiesCacheable()

Description copied from interface: EntityPersister

Should lazy properties of this entity be cached?

Specified by:

isLazyPropertiesCacheable in interface EntityPersister

selectFragment

public String selectFragment(String alias,
 String suffix)

Description copied from interface: EntityPersister

All columns to select, when loading.

Specified by:

selectFragment in interface EntityPersister

getIdentifierAliases

public String[] getIdentifierAliases(String suffix)

Description copied from interface: EntityPersister

Get the result set aliases used for the identifier columns, given a suffix

Specified by:

getIdentifierAliases in interface EntityPersister

getPropertyAliases

public String[] getPropertyAliases(String suffix,
 int i)

Description copied from interface: EntityPersister

Get the result set aliases used for the property columns, given a suffix (properties of this class, only).

Specified by:

getPropertyAliases in interface EntityPersister

getDiscriminatorAlias

public String getDiscriminatorAlias(String suffix)

Description copied from interface: EntityPersister

Get the result set aliases used for the identifier columns, given a suffix

Specified by:

getDiscriminatorAlias in interface EntityPersister

getDatabaseSnapshot

public Object[] getDatabaseSnapshot(Object id,
 SharedSessionContractImplementor session)
                             throws HibernateException

Description copied from interface: EntityPersister

Get the current database state of the object, in a "hydrated" form, without resolving identifiers.

Specified by:

getDatabaseSnapshot in interface EntityPersister

Returns:

null if there is no row in the database

Throws:

HibernateException

getIdByUniqueKey

public Object getIdByUniqueKey(Object key,
 String uniquePropertyName,
 SharedSessionContractImplementor session)

Specified by:

getIdByUniqueKey in interface EntityPersister

generateSelectVersionString

public String generateSelectVersionString()

Generate the SQL that selects the version number by id

createGeneratedValuesProcessor

protected org.hibernate.metamodel.mapping.internal.GeneratedValuesProcessor createGeneratedValuesProcessor(EventType timing,
 List<AttributeMapping> generatedAttributes)

forceVersionIncrement

public Object forceVersionIncrement(Object id,
 Object currentVersion,
 SharedSessionContractImplementor session)

Specified by:

forceVersionIncrement in interface EntityPersister

forceVersionIncrement

public Object forceVersionIncrement(Object id,
 Object currentVersion,
 boolean batching,
 SharedSessionContractImplementor session)
                             throws HibernateException

Specified by:

forceVersionIncrement in interface EntityPersister

Throws:

HibernateException

getCurrentVersion

public Object getCurrentVersion(Object id,
 SharedSessionContractImplementor session)
                         throws HibernateException

Retrieve the version number

Specified by:

getCurrentVersion in interface EntityPersister

Throws:

HibernateException

getJdbcMapping

public JdbcMapping getJdbcMapping(int index)

Specified by:

getJdbcMapping in interface JdbcMappingContainer

generateLocker

protected LockingStrategy generateLocker(LockMode lockMode,
 Locking.Scope lockScope)

getLocker

protected LockingStrategy getLocker(LockMode lockMode,
 Locking.Scope lockScope)

lock

public void lock(Object id,
 Object version,
 Object object,
 LockMode lockMode,
 SharedSessionContractImplementor session)
          throws HibernateException

Description copied from interface: EntityPersister

Do a version check (optional operation)

Specified by:

lock in interface EntityPersister

Throws:

HibernateException

lock

public void lock(Object id,
 Object version,
 Object object,
 LockMode lockMode,
 EventSource session)

Description copied from interface: EntityPersister

Do a version check (optional operation)

Specified by:

lock in interface EntityPersister

lock

public void lock(Object id,
 Object version,
 Object object,
 LockOptions lockOptions,
 SharedSessionContractImplementor session)
          throws HibernateException

Description copied from interface: EntityPersister

Do a version check (optional operation)

Specified by:

lock in interface EntityPersister

Throws:

HibernateException

lock

public void lock(Object id,
 Object version,
 Object object,
 LockOptions lockOptions,
 EventSource session)

Description copied from interface: EntityPersister

Do a version check (optional operation)

Specified by:

lock in interface EntityPersister

getRootTableName

public String getRootTableName()

Description copied from interface: EntityPersister

Locks are always applied to the "root table".

Specified by:

getRootTableName in interface EntityPersister

Returns:

The root table name

getRootTableIdentifierColumnNames

public String[] getRootTableIdentifierColumnNames()

Description copied from interface: EntityPersister

Get the names of columns on the root table used to persist the identifier.

Specified by:

getRootTableIdentifierColumnNames in interface EntityPersister

Returns:

The root table identifier column names.

toColumns

public String[] toColumns(String propertyName)
                   throws QueryException

Given a property path, return the corresponding column name(s). Warning: When there are duplicated property names in the subclasses then this method may return the wrong results. To ensure correct results, this method should only be used when this is the concrete EntityPersister (since the concrete EntityPersister cannot have duplicated property names).

Specified by:

toColumns in interface EntityPersister

Throws:

QueryException

getPropertyColumnNames

public String[] getPropertyColumnNames(String propertyName)

Get the column names for the given property path Warning: When there are duplicated property names in the subclasses then this method may return the wrong results. To ensure correct results, this method should only be used when this is the concrete EntityPersister (since the concrete EntityPersister cannot have duplicated property names).

Specified by:

getPropertyColumnNames in interface EntityPersister

getDiscriminatorDomainType

public DiscriminatorType<?> getDiscriminatorDomainType()

Description copied from interface: EntityPersister

The type of the discriminator, or null if the entity does not have a discriminator.

Specified by:

getDiscriminatorDomainType in interface EntityPersister

Returns:

a DiscriminatorType or null

See Also:

• EntityPersister.getDiscriminatorType()

generateTableAlias

public static String generateTableAlias(String rootAlias,
 int tableNumber)

getPropertyColumnNames

public String[] getPropertyColumnNames(int i)

hasFormulaProperties

public boolean hasFormulaProperties()

getFetchMode

public FetchMode getFetchMode(int i)

getSubclassPropertyType

public Type getSubclassPropertyType(int i)

countSubclassProperties

public int countSubclassProperties()

Specified by:

countSubclassProperties in interface EntityPersister

getSubclassPropertyColumnNames

public String[] getSubclassPropertyColumnNames(int i)

Specified by:

getSubclassPropertyColumnNames in interface EntityPersister

getSubclassPropertyFormulaTemplateClosure

public String[][] getSubclassPropertyFormulaTemplateClosure()

getSubclassPropertyTypeClosure

protected Type[] getSubclassPropertyTypeClosure()

getSubclassPropertyColumnNameClosure

protected String[][] getSubclassPropertyColumnNameClosure()

getSubclassPropertyColumnReaderClosure

public String[][] getSubclassPropertyColumnReaderClosure()

getSubclassPropertyColumnReaderTemplateClosure

public String[][] getSubclassPropertyColumnReaderTemplateClosure()

getSubclassPropertyNameClosure

protected String[] getSubclassPropertyNameClosure()

resolveAttributeIndexes

public int[] resolveAttributeIndexes(String[] attributeNames)

Description copied from interface: EntityPersister

Converts an array of attribute names to a set of indexes, according to the entity metamodel

Specified by:

resolveAttributeIndexes in interface EntityPersister

Parameters:

attributeNames - Array of names to be resolved

Returns:

A set of unique indexes of the attribute names found in the metamodel

resolveDirtyAttributeIndexes

public int[] resolveDirtyAttributeIndexes(Object[] currentState,
 Object[] previousState,
 String[] attributeNames,
 SessionImplementor session)

Description copied from interface: EntityPersister

Like EntityPersister.resolveAttributeIndexes(String[]) but also always returns mutable attributes

Specified by:

resolveDirtyAttributeIndexes in interface EntityPersister

Parameters:

attributeNames - Array of names to be resolved

Returns:

A set of unique indexes of the attribute names found in the metamodel

loadByUniqueKey

public Object loadByUniqueKey(String propertyName,
 Object uniqueKey,
 SharedSessionContractImplementor session)
                       throws HibernateException

Description copied from interface: EntityMappingType

Load an instance of the persistent class, by a unique key other than the primary key.

Specified by:

loadByUniqueKey in interface EntityMappingType

Specified by:

loadByUniqueKey in interface EntityPersister

Throws:

HibernateException

loadByUniqueKey

public Object loadByUniqueKey(String propertyName,
 Object uniqueKey,
 Boolean readOnly,
 SharedSessionContractImplementor session)
                       throws HibernateException

Throws:

HibernateException

getUniqueKeyLoader

protected SingleUniqueKeyEntityLoader<?> getUniqueKeyLoader(String attributeName,
 SharedSessionContractImplementor session)

initPropertyPaths

protected void initPropertyPaths(Metadata mapping)
                          throws MappingException

Throws:

MappingException

getIdentitySelectString

public String getIdentitySelectString()

Description copied from interface: EntityPersister

Get the database-specific SQL command to retrieve the last generated IDENTITY value.

Specified by:

getIdentitySelectString in interface EntityPersister

Returns:

The SQL command string

getSelectByUniqueKeyString

public String getSelectByUniqueKeyString(String propertyName)

Description copied from interface: EntityPersister

Get a SQL select string that performs a select based on a unique key determined by the given property name.

Specified by:

getSelectByUniqueKeyString in interface EntityPersister

Parameters:

propertyName - The name of the property which maps to the column(s) to use in the select statement restriction.

Returns:

The SQL select string

getSelectByUniqueKeyString

public String getSelectByUniqueKeyString(String[] propertyNames)

Description copied from interface: EntityPersister

Get a SQL select string that performs a select based on a unique key determined by the given property names.

Specified by:

getSelectByUniqueKeyString in interface EntityPersister

Parameters:

propertyNames - The names of the properties which maps to the column(s) to use in the select statement restriction.

Returns:

The SQL select string

getSelectByUniqueKeyString

public String getSelectByUniqueKeyString(String[] propertyNames,
 String[] columnNames)

Specified by:

getSelectByUniqueKeyString in interface EntityPersister

getInsertDelegate

public GeneratedValuesMutationDelegate getInsertDelegate()

Specified by:

getInsertDelegate in interface EntityMutationTarget

getUpdateDelegate

public GeneratedValuesMutationDelegate getUpdateDelegate()

Specified by:

getUpdateDelegate in interface EntityMutationTarget

getTableMappings

public EntityTableMapping[] getTableMappings()

Specified by:

getTableMappings in interface EntityMutationTarget

getTableMapping

protected EntityTableMapping getTableMapping(int i)

forEachTableDetails

public void forEachTableDetails(Consumer<TableDetails> consumer)

Description copied from interface: EntityMappingType

Visit details for each table associated with the entity.

Specified by:

forEachTableDetails in interface EntityMappingType

physicalTableNameForMutation

public String physicalTableNameForMutation(SelectableMapping selectableMapping)

Unfortunately we cannot directly use `SelectableMapping#getContainingTableExpression()` as that blows up for attributes declared on super-type for union-subclass mappings

Specified by:

physicalTableNameForMutation in interface EntityMutationTarget

getTargetPart

public EntityMappingType getTargetPart()

Description copied from interface: MutationTarget

The ModelPart describing the mutation target

Specified by:

getTargetPart in interface EntityMutationTarget

Specified by:

getTargetPart in interface MutationTarget<EntityTableMapping>

forEachMutableTable

public void forEachMutableTable(Consumer<EntityTableMapping> consumer)

Description copied from interface: MutationTarget

Visit each table.

Specified by:

forEachMutableTable in interface MutationTarget<EntityTableMapping>

forEachMutableTableReverse

public void forEachMutableTableReverse(Consumer<EntityTableMapping> consumer)

Description copied from interface: MutationTarget

Same as MutationTarget.forEachMutableTable(Consumer) except that here the tables are visited in reverse order

Specified by:

forEachMutableTableReverse in interface MutationTarget<EntityTableMapping>

getIdentifierTableName

public String getIdentifierTableName()

Description copied from interface: MutationTarget

The name of the table defining the identifier for this target

Specified by:

getIdentifierTableName in interface MutationTarget<EntityTableMapping>

getIdentifierTableMapping

public EntityTableMapping getIdentifierTableMapping()

Description copied from interface: MutationTarget

The descriptor for the table containing the identifier for the target

Specified by:

getIdentifierTableMapping in interface EntityMutationTarget

Specified by:

getIdentifierTableMapping in interface MutationTarget<EntityTableMapping>

getIdentifierDescriptor

public ModelPart getIdentifierDescriptor()

Description copied from interface: EntityMutationTarget

The ModelPart describing the identifier/key for this target

Specified by:

getIdentifierDescriptor in interface EntityMutationTarget

logStaticSQL

protected void logStaticSQL()

getSubclassByDiscriminatorValue

public abstract Map<Object,String> getSubclassByDiscriminatorValue()

getConstraintOrderedTableNameClosure

public abstract String[] getConstraintOrderedTableNameClosure()

needsDiscriminator

public abstract boolean needsDiscriminator()

isDiscriminatorFormula

protected boolean isDiscriminatorFormula()

createRootTableGroup

public TableGroup createRootTableGroup(boolean canUseInnerJoins,
 NavigablePath navigablePath,
 String explicitSourceAlias,
 SqlAliasBase explicitSqlAliasBase,
 Supplier<Consumer<Predicate>> additionalPredicateCollectorAccess,
 SqlAstCreationState creationState)

Description copied from interface: RootTableGroupProducer

Create a root TableGroup as defined by this producer

Specified by:

createRootTableGroup in interface EntityMappingType

Specified by:

createRootTableGroup in interface RootTableGroupProducer

Parameters:

canUseInnerJoins - Whether inner joins can be used when creating table-references within this group

navigablePath - The overall NavigablePath for the root

explicitSourceAlias - The alias, if one, explicitly provided by the application for this root

explicitSqlAliasBase - A specific SqlAliasBase to use. May be null indicating one should be created using the SqlAliasBaseGenerator from creationState

additionalPredicateCollectorAccess - Collector for additional predicates associated with this producer

creationState - The creation state

applyDiscriminator

public void applyDiscriminator(Consumer<Predicate> predicateConsumer,
 String alias,
 TableGroup tableGroup,
 SqlAstCreationState creationState)

Description copied from interface: Discriminable

Apply the discriminator as a predicate via the predicateConsumer

Specified by:

applyDiscriminator in interface Discriminable

Specified by:

applyDiscriminator in interface EntityMappingType

getPrunedDiscriminatorPredicate

protected String getPrunedDiscriminatorPredicate(Map<String, EntityNameUse> entityNameUses,
 MappingMetamodelImplementor mappingMetamodel,
 String alias)

applyFilterRestrictions

public void applyFilterRestrictions(Consumer<Predicate> predicateConsumer,
 TableGroup tableGroup,
 boolean useQualifier,
 Map<String,Filter> enabledFilters,
 boolean onlyApplyLoadByKeyFilters,
 SqlAstCreationState creationState)

Description copied from interface: FilterRestrictable

Applies just the Filter values enabled for the associated entity

Specified by:

applyFilterRestrictions in interface EntityMappingType

Specified by:

applyFilterRestrictions in interface FilterRestrictable

applyBaseRestrictions

public void applyBaseRestrictions(Consumer<Predicate> predicateConsumer,
 TableGroup tableGroup,
 boolean useQualifier,
 Map<String,Filter> enabledFilters,
 boolean onlyApplyLoadByKeyFilters,
 Set<String> treatAsDeclarations,
 SqlAstCreationState creationState)

Description copied from interface: Restrictable

Applies the base set of restrictions.

Specified by:

applyBaseRestrictions in interface EntityMappingType

Specified by:

applyBaseRestrictions in interface Restrictable

hasWhereRestrictions

public boolean hasWhereRestrictions()

Description copied from interface: WhereRestrictable

Does this restrictable have a where restriction?

Specified by:

hasWhereRestrictions in interface EntityMappingType

Specified by:

hasWhereRestrictions in interface WhereRestrictable

applyWhereRestrictions

public void applyWhereRestrictions(Consumer<Predicate> predicateConsumer,
 TableGroup tableGroup,
 boolean useQualifier,
 SqlAstCreationState creationState)

Description copied from interface: WhereRestrictable

Apply the SQLRestriction restrictions

Specified by:

applyWhereRestrictions in interface EntityMappingType

Specified by:

applyWhereRestrictions in interface WhereRestrictable

shouldInnerJoinSubclassTable

protected boolean shouldInnerJoinSubclassTable(int subclassTableNumber,
 Set<String> treatAsDeclarations)

isSubclassTableIndicatedByTreatAsDeclarations

protected boolean isSubclassTableIndicatedByTreatAsDeclarations(int subclassTableNumber,
 Set<String> treatAsDeclarations)

postConstruct

protected void postConstruct(Metadata mapping)
                      throws MappingException

Post-construct is a callback for AbstractEntityPersister subclasses to call after they are all done with their constructor processing. It allows AbstractEntityPersister to extend its construction after subclass-specific details have all been taken care of.

Parameters:

mapping - The mapping

Throws:

MappingException - Indicates a problem accessing the Mapping

prepareLoaders

public void prepareLoaders()

Description copied from interface: EntityPersister

Prepare loaders associated with the persister. Distinct "phase" in building the persister after InFlightEntityMappingType.prepareMappingModel(MappingModelCreationProcess) and EntityPersister.postInstantiate() have occurred.

The distinct phase is used to ensure that all TableDetails are available across the entire model

Specified by:

prepareLoaders in interface EntityPersister

createInsertDelegate

protected GeneratedValuesMutationDelegate createInsertDelegate()

createUpdateDelegate

protected GeneratedValuesMutationDelegate createUpdateDelegate()

buildTableMappings

protected EntityTableMapping[] buildTableMappings()

Builds the EntityTableMapping descriptors for the tables mapped by this entity.

See Also:

• visitMutabilityOrderedTables(AbstractEntityPersister.MutabilityOrderedTableConsumer)

visitMutabilityOrderedTables

protected abstract void visitMutabilityOrderedTables(AbstractEntityPersister.MutabilityOrderedTableConsumer consumer)

Visit details about each table for this entity, using "mutability ordering". When inserting rows, the order we go through the tables to avoid foreign key problems among the entity's group of tables.

Used while building the table mapping descriptors for each table.

See Also:

• forEachMutableTable(Consumer)
• forEachMutableTableReverse(Consumer)

isIdentifierTable

protected abstract boolean isIdentifierTable(String tableExpression)

buildInsertCoordinator

protected InsertCoordinator buildInsertCoordinator()

buildUpdateCoordinator

protected UpdateCoordinator buildUpdateCoordinator()

buildMergeCoordinator

protected UpdateCoordinator buildMergeCoordinator()

buildDeleteCoordinator

protected DeleteCoordinator buildDeleteCoordinator()

addDiscriminatorToInsertGroup

public void addDiscriminatorToInsertGroup(MutationGroupBuilder insertGroupBuilder)

Specified by:

addDiscriminatorToInsertGroup in interface EntityMutationTarget

addSoftDeleteToInsertGroup

public void addSoftDeleteToInsertGroup(MutationGroupBuilder insertGroupBuilder)

Specified by:

addSoftDeleteToInsertGroup in interface EntityMutationTarget

substituteBrackets

protected String substituteBrackets(String sql)

postInstantiate

public final void postInstantiate()
                           throws MappingException

Description copied from interface: EntityPersister

Finish the initialization of this object.

The method InFlightEntityMappingType.prepareMappingModel(MappingModelCreationProcess) must have been called for every entity persister before this method is invoked.

Called only once per SessionFactory lifecycle, after all entity persisters have been instantiated.

Specified by:

postInstantiate in interface EntityPersister

Throws:

MappingException - Indicates an issue in the metadata.

load

public Object load(Object id,
 Object optionalObject,
 LockMode lockMode,
 SharedSessionContractImplementor session)

Load an instance using either the forUpdateLoader or the outer joining loader, depending upon the value of the lock parameter

Specified by:

load in interface EntityPersister

load

public Object load(Object id,
 Object optionalObject,
 LockOptions lockOptions,
 SharedSessionContractImplementor session)
            throws HibernateException

Load an instance using either the forUpdateLoader or the outer joining loader, depending upon the value of the lock parameter

Specified by:

load in interface EntityPersister

Throws:

HibernateException

load

public Object load(Object id,
 Object optionalObject,
 LockOptions lockOptions,
 SharedSessionContractImplementor session,
 Boolean readOnly)
            throws HibernateException

Specified by:

load in interface EntityPersister

Throws:

HibernateException

determineLoaderToUse

protected SingleIdEntityLoader<?> determineLoaderToUse(SharedSessionContractImplementor session,
 LockOptions lockOptions)

getSingleIdLoader

public SingleIdEntityLoader<?> getSingleIdLoader()

initializeEnhancedEntityUsedAsProxy

public Object initializeEnhancedEntityUsedAsProxy(Object entity,
 String nameOfAttributeBeingAccessed,
 SharedSessionContractImplementor session)

Description copied from interface: EntityPersister

Called from EnhancementAsProxyLazinessInterceptor to trigger load of the entity's non-lazy state as well as the named attribute we are accessing if it is still uninitialized after fetching non-lazy state.

Specified by:

initializeEnhancedEntityUsedAsProxy in interface EntityPersister

multiLoad

public List<?> multiLoad(Object[] ids,
 EventSource session,
 MultiIdLoadOptions loadOptions)

Description copied from interface: EntityPersister

Performs a load of multiple entities (of this type) by identifier simultaneously.

Specified by:

multiLoad in interface EntityPersister

Parameters:

ids - The identifiers to load

session - The originating Session

loadOptions - The options for loading

Returns:

The loaded, matching entities

multiLoad

public List<?> multiLoad(Object[] ids,
 SharedSessionContractImplementor session,
 MultiIdLoadOptions loadOptions)

Description copied from interface: EntityPersister

Performs a load of multiple entities (of this type) by identifier simultaneously.

Specified by:

multiLoad in interface EntityPersister

Parameters:

ids - The identifiers to load

session - The originating Session

loadOptions - The options for loading

Returns:

The loaded, matching entities

registerAffectingFetchProfile

public void registerAffectingFetchProfile(String fetchProfileName)

Specified by:

registerAffectingFetchProfile in interface org.hibernate.engine.profile.internal.FetchProfileAffectee

isAffectedByEntityGraph

public boolean isAffectedByEntityGraph(LoadQueryInfluencers loadQueryInfluencers)

Description copied from interface: Loadable

Whether the effective entity-graph applies to this loadable

Specified by:

isAffectedByEntityGraph in interface EntityMappingType

Specified by:

isAffectedByEntityGraph in interface Loadable

isAffectedByEnabledFetchProfiles

public boolean isAffectedByEnabledFetchProfiles(LoadQueryInfluencers loadQueryInfluencers)

Description copied from interface: Loadable

Whether any of the LoadQueryInfluencers.getEnabledFetchProfileNames() apply to this loadable

Specified by:

isAffectedByEnabledFetchProfiles in interface EntityMappingType

Specified by:

isAffectedByEnabledFetchProfiles in interface Loadable

isAffectedByEnabledFilters

public boolean isAffectedByEnabledFilters(LoadQueryInfluencers loadQueryInfluencers,
 boolean onlyApplyForLoadByKeyFilters)

Description copied from interface: Loadable

Whether any of the "influencers" affect this loadable.

Specified by:

isAffectedByEnabledFilters in interface EntityMappingType

Specified by:

isAffectedByEnabledFilters in interface Loadable

findDirty

public int[] findDirty(Object[] currentState,
 Object[] previousState,
 Object entity,
 SharedSessionContractImplementor session)
                throws HibernateException

Locate the property-indices of all properties considered to be dirty.

Specified by:

findDirty in interface EntityPersister

Parameters:

currentState - The current state of the entity (the state to be checked).

previousState - The previous state of the entity (the state to be checked against).

entity - The entity for which we are checking state dirtiness.

session - The session in which the check is occurring.

Returns:

null or the indices of the dirty properties

Throws:

HibernateException

findModified

public int[] findModified(Object[] old,
 Object[] current,
 Object entity,
 SharedSessionContractImplementor session)
                   throws HibernateException

Locate the property-indices of all properties considered to be dirty.

Specified by:

findModified in interface EntityPersister

Parameters:

old - The old state of the entity.

current - The current state of the entity.

entity - The entity for which we are checking state modification.

session - The session in which the check is occurring.

Returns:

null or the indices of the modified properties

Throws:

HibernateException

getPropertyUpdateability

public boolean[] getPropertyUpdateability(Object entity)

Which properties appear in the SQL update? (Initialized, updateable ones!)

getFactory

public SessionFactoryImplementor getFactory()

Description copied from interface: EntityPersister

Return the SessionFactory to which this persister belongs.

Specified by:

getFactory in interface EntityPersister

Returns:

The owning SessionFactory.

getEntityMetamodel

public EntityMetamodel getEntityMetamodel()

Description copied from interface: EntityPersister

Retrieve the underlying entity metamodel instance.

Specified by:

getEntityMetamodel in interface EntityPersister

Returns:

The metamodel

canReadFromCache

public boolean canReadFromCache()

Specified by:

canReadFromCache in interface EntityPersister

canWriteToCache

public boolean canWriteToCache()

Specified by:

canWriteToCache in interface EntityPersister

hasCache

public boolean hasCache()

Description copied from interface: EntityPersister

Does this class have a cache.

Specified by:

hasCache in interface EntityPersister

getCacheAccessStrategy

public EntityDataAccess getCacheAccessStrategy()

Description copied from interface: EntityPersister

Get the cache (optional operation)

Specified by:

getCacheAccessStrategy in interface EntityPersister

getCacheEntryStructure

public CacheEntryStructure getCacheEntryStructure()

Description copied from interface: EntityPersister

Get the cache structure

Specified by:

getCacheEntryStructure in interface EntityPersister

buildCacheEntry

public CacheEntry buildCacheEntry(Object entity,
 Object[] state,
 Object version,
 SharedSessionContractImplementor session)

Specified by:

buildCacheEntry in interface EntityPersister

hasNaturalIdCache

public boolean hasNaturalIdCache()

Description copied from interface: EntityPersister

Does this class have a natural id cache

Specified by:

hasNaturalIdCache in interface EntityPersister

getNaturalIdCacheAccessStrategy

public NaturalIdDataAccess getNaturalIdCacheAccessStrategy()

Description copied from interface: EntityPersister

Get the NaturalId cache (optional operation)

Specified by:

getNaturalIdCacheAccessStrategy in interface EntityPersister

getEntityName

public final String getEntityName()

Description copied from interface: EntityPersister

The entity name which this persister maps.

Specified by:

getEntityName in interface EntityMappingType

Specified by:

getEntityName in interface EntityPersister

Returns:

The name of the entity which this persister maps.

getJpaEntityName

public @Nullable String getJpaEntityName()

Description copied from interface: EntityPersister

The JPA entity name, if one, associated with the entity.

Specified by:

getJpaEntityName in interface EntityPersister

hasIdentifierProperty

public boolean hasIdentifierProperty()

Description copied from interface: EntityPersister

Determine whether the entity has a particular property holding the identifier value.

Specified by:

hasIdentifierProperty in interface EntityPersister

Returns:

True if the entity has a specific property holding identifier value.

getVersionType

public BasicType<?> getVersionType()

Description copied from interface: EntityPersister

If EntityPersister.isVersioned(), then what is the type of the property holding the locking value.

Specified by:

getVersionType in interface EntityPersister

Returns:

The type of the version property; or null, if not versioned.

isIdentifierAssignedByInsert

public boolean isIdentifierAssignedByInsert()

Description copied from interface: EntityPersister

Are identifiers of this entity assigned known before the insert execution? Or, are they generated (in the database) by the insert execution.

Specified by:

isIdentifierAssignedByInsert in interface EntityPersister

Returns:

True if identifiers for this entity are generated by the insert execution.

afterReassociate

public void afterReassociate(Object entity,
 SharedSessionContractImplementor session)

Description copied from interface: EntityPersister

Called just after the entity has been reassociated with the session

Specified by:

afterReassociate in interface EntityPersister

isTransient

public Boolean isTransient(Object entity,
 SharedSessionContractImplementor session)
                    throws HibernateException

Description copied from interface: EntityPersister

Is this a new transient instance?

Specified by:

isTransient in interface EntityPersister

Throws:

HibernateException

hasProxy

public boolean hasProxy()

Description copied from interface: EntityPersister

Determine whether this entity supports dynamic proxies.

Specified by:

hasProxy in interface EntityPersister

Returns:

True if the entity has dynamic proxy support; false otherwise.

getIdentifierGenerator

@Deprecated
public IdentifierGenerator getIdentifierGenerator()
                                           throws HibernateException

Deprecated.

Description copied from interface: EntityPersister

Determine which identifier generation strategy is used for this entity.

Specified by:

getIdentifierGenerator in interface EntityPersister

Returns:

The identifier generation strategy.

Throws:

HibernateException

getGenerator

public Generator getGenerator()

Specified by:

getGenerator in interface EntityPersister

getVersionGenerator

public BeforeExecutionGenerator getVersionGenerator()

Specified by:

getVersionGenerator in interface EntityPersister

Overrides:

getVersionGenerator in class EntityMetamodel

getRootEntityName

public String getRootEntityName()

Description copied from interface: EntityPersister

Returns an object that identifies the space in which identifiers of this entity hierarchy are unique. Might be a table name, a JNDI URL, etc.

Specified by:

getRootEntityName in interface EntityPersister

Returns:

The root entity name.

getMappedSuperclass

public String getMappedSuperclass()

Description copied from interface: EntityMappingType

Get the name of the entity that is the "super class" for this entity

Specified by:

getMappedSuperclass in interface EntityMappingType

See Also:

• EntityMappingType.getSuperMappingType()

isConcreteProxy

public boolean isConcreteProxy()

Description copied from interface: EntityMappingType

Returns true if this entity type's hierarchy is configured to return concrete-typed proxies.

Specified by:

isConcreteProxy in interface EntityMappingType

See Also:

• ConcreteProxy

resolveConcreteProxyTypeForId

public EntityMappingType resolveConcreteProxyTypeForId(Object id,
 SharedSessionContractImplementor session)

Description copied from interface: EntityMappingType

If this entity is configured to return concrete-typed proxies, this method queries the entity table(s) do determine the concrete entity type associated with the provided id and returns its persister. Otherwise, this method simply returns this entity persister.

Specified by:

resolveConcreteProxyTypeForId in interface EntityMappingType

See Also:

• EntityMappingType.isConcreteProxy()

getPropertyType

@Deprecated
public Type getPropertyType(String propertyName)
                     throws MappingException

Deprecated.

by the supertypes

Get the type of a particular property by name. Warning: When there are duplicated property names in the subclasses then this method may return the wrong results. To ensure correct results, this method should only be used when this is the concrete EntityPersister (since the concrete EntityPersister cannot have duplicated property names).

Specified by:

getPropertyType in interface EntityPersister

Parameters:

propertyName - The name of the property for which to retrieve the type.

Returns:

The type.

Throws:

MappingException - Typically indicates an unknown property name.

isSelectBeforeUpdateRequired

public boolean isSelectBeforeUpdateRequired()

Description copied from interface: EntityPersister

Is select snapshot before update enabled?

Specified by:

isSelectBeforeUpdateRequired in interface EntityPersister

optimisticLockStyle

public final OptimisticLockStyle optimisticLockStyle()

Description copied from interface: EntityMappingType

The type of optimistic locking, if any, defined for this entity mapping

Specified by:

optimisticLockStyle in interface EntityMappingType

createProxy

public Object createProxy(Object id,
 SharedSessionContractImplementor session)
                   throws HibernateException

Description copied from interface: EntityPersister

Create a new proxy instance

Specified by:

createProxy in interface EntityPersister

Throws:

HibernateException

toString

public String toString()

Overrides:

toString in class EntityMetamodel

isInstrumented

public boolean isInstrumented()

Description copied from class: EntityMetamodel

Whether this class can be lazy (ie intercepted)

Specified by:

isInstrumented in interface EntityPersister

Overrides:

isInstrumented in class EntityMetamodel

hasInsertGeneratedProperties

public boolean hasInsertGeneratedProperties()

Description copied from interface: EntityPersister

Does this entity define any properties as being database generated on insert?

Specified by:

hasInsertGeneratedProperties in interface EntityPersister

Returns:

True if this entity contains at least one property defined as generated (including version property, but not identifier).

hasUpdateGeneratedProperties

public boolean hasUpdateGeneratedProperties()

Description copied from interface: EntityPersister

Does this entity define any properties as being database generated on update?

Specified by:

hasUpdateGeneratedProperties in interface EntityPersister

Returns:

True if this entity contains at least one property defined as generated (including version property, but not identifier).

hasPreInsertGeneratedProperties

public boolean hasPreInsertGeneratedProperties()

Specified by:

hasPreInsertGeneratedProperties in interface EntityPersister

hasPreUpdateGeneratedProperties

public boolean hasPreUpdateGeneratedProperties()

Specified by:

hasPreUpdateGeneratedProperties in interface EntityPersister

isVersionPropertyGenerated

public boolean isVersionPropertyGenerated()

Description copied from interface: EntityPersister

Does this entity contain a version property that is defined to be database generated?

Specified by:

isVersionPropertyGenerated in interface EntityPersister

Returns:

true if this entity contains a version property and that property has been marked as generated.

isVersionGeneratedOnExecution

public boolean isVersionGeneratedOnExecution()

isVersionGeneratedBeforeExecution

public boolean isVersionGeneratedBeforeExecution()

afterInitialize

public void afterInitialize(Object entity,
 SharedSessionContractImplementor session)

Description copied from interface: EntityPersister

Called just after the entities properties have been initialized

Specified by:

afterInitialize in interface EntityPersister

getNonLazyPropertyUpdateability

public boolean[] getNonLazyPropertyUpdateability()

Specified by:

getNonLazyPropertyUpdateability in interface EntityPersister

getPropertyCascadeStyles

public CascadeStyle[] getPropertyCascadeStyles()

Description copied from interface: EntityPersister

Get the cascade styles of the properties (optional operation)

Specified by:

getPropertyCascadeStyles in interface EntityPersister

getMappedClass

public final Class<?> getMappedClass()

Description copied from interface: EntityPersister

The persistent class, or null

Specified by:

getMappedClass in interface EntityPersister

getConcreteProxyClass

public Class<?> getConcreteProxyClass()

Description copied from interface: EntityPersister

Get the proxy interface that instances of this concrete class will be cast to (optional operation).

Specified by:

getConcreteProxyClass in interface EntityPersister

setPropertyValues

public void setPropertyValues(Object object,
 Object[] values)

Description copied from interface: EntityPersister

Set the given values to the mapped properties of the given object.

Specified by:

setPropertyValues in interface EntityPersister

setPropertyValue

public void setPropertyValue(Object object,
 int i,
 Object value)

Description copied from interface: EntityPersister

Set the value of a particular property of the given instance.

Specified by:

setPropertyValue in interface EntityPersister

getPropertyValues

public Object[] getPropertyValues(Object object)

Specified by:

getPropertyValues in interface EntityPersister

getPropertyValue

public Object getPropertyValue(Object object,
 int i)

Specified by:

getPropertyValue in interface EntityPersister

getPropertyValue

public Object getPropertyValue(Object object,
 String path)

Description copied from interface: EntityPersister

Get the value of a particular property

Specified by:

getPropertyValue in interface EntityPersister

getIdentifier

public Object getIdentifier(Object entity,
 SharedSessionContractImplementor session)

Description copied from interface: EntityPersister

Get the identifier of an instance from the object's identifier property. Throw an exception if it has no identifier property.

Specified by:

getIdentifier in interface EntityPersister

getIdentifier

public Object getIdentifier(Object entity,
 MergeContext mergeContext)

Description copied from interface: EntityPersister

Get the identifier of an instance from the object's identifier property. Throw an exception if it has no identifier property. It's supposed to be use during the merging process

Specified by:

getIdentifier in interface EntityPersister

setIdentifier

public void setIdentifier(Object entity,
 Object id,
 SharedSessionContractImplementor session)

Description copied from interface: EntityPersister

Inject the identifier value into the given entity.

Specified by:

setIdentifier in interface EntityPersister

getVersion

public Object getVersion(Object object)

Description copied from interface: EntityPersister

Get the version number (or timestamp) from the object's version property. Return null if it is not versioned.

Specified by:

getVersion in interface EntityPersister

instantiate

public Object instantiate(Object id,
 SharedSessionContractImplementor session)

Description copied from interface: EntityPersister

Create a class instance initialized with the given identifier

Specified by:

instantiate in interface EntityPersister

Parameters:

id - The identifier value to use (may be null to represent no value)

session - The session from which the request originated.

Returns:

The instantiated entity.

linkToSession

protected void linkToSession(Object entity,
 SharedSessionContractImplementor session)

isInstance

public boolean isInstance(Object object)

Description copied from interface: EntityPersister

Is the given object an instance of this entity?

Specified by:

isInstance in interface EntityPersister

hasUninitializedLazyProperties

public boolean hasUninitializedLazyProperties(Object object)

Description copied from interface: EntityPersister

Does the given instance have any uninitialized lazy properties?

Specified by:

hasUninitializedLazyProperties in interface EntityPersister

resetIdentifier

public void resetIdentifier(Object entity,
 Object currentId,
 Object currentVersion,
 SharedSessionContractImplementor session)

Description copied from interface: EntityPersister

Set the identifier and version of the given instance back to its "unsaved" value, that is, the value it had before it was made persistent.

Specified by:

resetIdentifier in interface EntityPersister

See Also:

• AvailableSettings.USE_IDENTIFIER_ROLLBACK
• SessionFactoryOptions.isIdentifierRollbackEnabled()

getSubclassEntityPersister

public EntityPersister getSubclassEntityPersister(Object instance,
 SessionFactoryImplementor factory)

Description copied from interface: EntityPersister

Obtain the EntityPersister for the concrete class of the given entity instance which participates in a mapped inheritance hierarchy with this persister. The given instance must be an instance of a subclass of the persistent class managed by this persister.

A request has already identified the entity name of this persister as the mapping for the given instance. However, we still need to account for possible subclassing and potentially reroute to the more appropriate persister.

For example, a request names Animal as the entity name which gets resolved to this persister. But the actual instance is really an instance of Cat which is a subclass of Animal. So, here the Animal persister is being asked to return the persister specific to Cat.

It's also possible that the instance is actually an Animal instance in the above example in which case we would return this from this method.

Specified by:

getSubclassEntityPersister in interface EntityPersister

Parameters:

instance - The entity instance

factory - Reference to the SessionFactory

Returns:

The appropriate persister

hasMultipleTables

public boolean hasMultipleTables()

Specified by:

hasMultipleTables in interface EntityPersister

getPropertyValuesToInsert

public Object[] getPropertyValuesToInsert(Object entity,
 Map<Object,Object> mergeMap,
 SharedSessionContractImplementor session)
                                   throws HibernateException

Description copied from interface: EntityPersister

Return the values of the insertable properties of the object (including backrefs)

Specified by:

getPropertyValuesToInsert in interface EntityPersister

Throws:

HibernateException

shouldGetAllProperties

protected boolean shouldGetAllProperties(Object entity)

processInsertGeneratedProperties

public void processInsertGeneratedProperties(Object id,
 Object entity,
 Object[] state,
 GeneratedValues generatedValues,
 SharedSessionContractImplementor session)

Description copied from interface: EntityPersister

Retrieve the values of any insert generated properties through the provided GeneratedValues or, when that's not available, by selecting them back from the database, injecting these generated values into the given entity as well as writing this state to the PersistenceContext.

Note, that because we update the PersistenceContext here, callers need to take care that they have already written the initial snapshot to the PersistenceContext before calling this method.

Specified by:

processInsertGeneratedProperties in interface EntityPersister

initInsertGeneratedProperties

protected List<? extends ModelPart> initInsertGeneratedProperties(List<AttributeMapping> generatedAttributes)

getInsertGeneratedProperties

public List<? extends ModelPart> getInsertGeneratedProperties()

Specified by:

getInsertGeneratedProperties in interface EntityPersister

processUpdateGeneratedProperties

public void processUpdateGeneratedProperties(Object id,
 Object entity,
 Object[] state,
 GeneratedValues generatedValues,
 SharedSessionContractImplementor session)

Description copied from interface: EntityPersister

Retrieve the values of any update generated properties through the provided GeneratedValues or, when that's not available, by selecting them back from the database, injecting these generated values into the given entity as well as writing this state to the PersistenceContext.

Note, that because we update the PersistenceContext here, callers need to take care that they have already written the initial snapshot to the PersistenceContext before calling this method.

Specified by:

processUpdateGeneratedProperties in interface EntityPersister

initUpdateGeneratedProperties

protected List<? extends ModelPart> initUpdateGeneratedProperties(List<AttributeMapping> generatedAttributes)

getUpdateGeneratedProperties

public List<? extends ModelPart> getUpdateGeneratedProperties()

Specified by:

getUpdateGeneratedProperties in interface EntityPersister

getIdentifierPropertyName

public String getIdentifierPropertyName()

Description copied from interface: EntityPersister

Get the name of the identifier property (or return null) - need not return the name of an actual Java property

Specified by:

getIdentifierPropertyName in interface EntityPersister

getIdentifierType

public Type getIdentifierType()

Description copied from interface: EntityPersister

Get the identifier type

Specified by:

getIdentifierType in interface EntityPersister

hasSubselectLoadableCollections

public boolean hasSubselectLoadableCollections()

Description copied from interface: EntityPersister

Determine whether this entity contains references to persistent collections which are fetchable by subselect?

Specified by:

hasSubselectLoadableCollections in interface EntityPersister

Returns:

True if the entity contains collections fetchable by subselect; false otherwise.

hasCollectionNotReferencingPK

public boolean hasCollectionNotReferencingPK()

Description copied from interface: EntityPersister

Determine whether this entity contains references to persistent collections not referencing the primary key.

Specified by:

hasCollectionNotReferencingPK in interface EntityPersister

Returns:

True if the entity contains a collection not referencing the primary key; false otherwise.

verifyHasNaturalId

protected void verifyHasNaturalId()

getNaturalIdentifierSnapshot

public Object getNaturalIdentifierSnapshot(Object id,
 SharedSessionContractImplementor session)

Description copied from interface: EntityPersister

Retrieve the current state of the natural-id properties from the database.

Specified by:

getNaturalIdentifierSnapshot in interface EntityPersister

Parameters:

id - The identifier of the entity for which to retrieve the natural-id values.

session - The session from which the request originated.

Returns:

The natural-id snapshot.

getNaturalIdLoader

public NaturalIdLoader<?> getNaturalIdLoader()

Description copied from interface: EntityMappingType

Access to performing natural-id database selection. This is per-entity in the hierarchy

Specified by:

getNaturalIdLoader in interface EntityMappingType

Specified by:

getNaturalIdLoader in interface EntityPersister

getMultiNaturalIdLoader

public MultiNaturalIdLoader<?> getMultiNaturalIdLoader()

Description copied from interface: EntityMappingType

Access to performing multi-value natural-id database selection. This is per-entity in the hierarchy

Specified by:

getMultiNaturalIdLoader in interface EntityMappingType

Specified by:

getMultiNaturalIdLoader in interface EntityPersister

loadEntityIdByNaturalId

public Object loadEntityIdByNaturalId(Object[] naturalIdValues,
 LockOptions lockOptions,
 SharedSessionContractImplementor session)

Description copied from interface: EntityPersister

Load the id for the entity based on the natural id.

Specified by:

loadEntityIdByNaturalId in interface EntityPersister

getTableId

public static int getTableId(String tableName,
 String[] tables)

getRepresentationStrategy

public EntityRepresentationStrategy getRepresentationStrategy()

Description copied from interface: EntityMappingType

Describes how the entity is represented in the application's domain model.

Specified by:

getRepresentationStrategy in interface EntityMappingType

Specified by:

getRepresentationStrategy in interface EntityPersister

getInstrumentationMetadata

@Deprecated(forRemoval=true)
public BytecodeEnhancementMetadata getInstrumentationMetadata()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

getInstrumentationMetadata in interface EntityPersister

getTableNameForColumn

public String getTableNameForColumn(String columnName)

Specified by:

getTableNameForColumn in interface EntityPersister

determineTableNumberForColumn

protected int determineTableNumberForColumn(String columnName)

determineTableName

protected String determineTableName(Table table)

getEntityEntryFactory

public EntityEntryFactory getEntityEntryFactory()

Description copied from interface: EntityPersister

Get the EntityEntryFactory indicated for the entity mapped by this persister.

Specified by:

getEntityEntryFactory in interface EntityPersister

forEachAttributeMapping

public void forEachAttributeMapping(Consumer<? super AttributeMapping> action)

Description copied from interface: EntityMappingType

Visit each attribute mapping

Specified by:

forEachAttributeMapping in interface EntityMappingType

Specified by:

forEachAttributeMapping in interface ManagedMappingType

See Also:

• EntityMappingType.getAttributeMappings()

forEachAttributeMapping

public void forEachAttributeMapping(org.hibernate.internal.util.IndexedConsumer<? super AttributeMapping> consumer)

Description copied from interface: ManagedMappingType

Visit attributes defined on this class and any supers

Specified by:

forEachAttributeMapping in interface ManagedMappingType

prepareMappingModel

public void prepareMappingModel(org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

Specified by:

prepareMappingModel in interface org.hibernate.metamodel.mapping.internal.InFlightEntityMappingType

generateNaturalIdMapping

protected NaturalIdMapping generateNaturalIdMapping(org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess,
 PersistentClass bootEntityDescriptor)

interpretSqmMultiTableStrategy

protected static SqmMultiTableMutationStrategy interpretSqmMultiTableStrategy(AbstractEntityPersister entityMappingDescriptor,
 org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

interpretSqmMultiTableInsertStrategy

protected static SqmMultiTableInsertStrategy interpretSqmMultiTableInsertStrategy(AbstractEntityPersister entityMappingDescriptor,
 org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

getSqmMultiTableMutationStrategy

public SqmMultiTableMutationStrategy getSqmMultiTableMutationStrategy()

Description copied from interface: EntityPersister

The strategy to use for SQM mutation statements where the target entity has multiple tables. Returns null to indicate that the entity does not have multiple tables.

Specified by:

getSqmMultiTableMutationStrategy in interface EntityMappingType

Specified by:

getSqmMultiTableMutationStrategy in interface EntityPersister

getSqmMultiTableInsertStrategy

public SqmMultiTableInsertStrategy getSqmMultiTableInsertStrategy()

Specified by:

getSqmMultiTableInsertStrategy in interface EntityMappingType

Specified by:

getSqmMultiTableInsertStrategy in interface EntityPersister

getStateArrayInitialPosition

protected int getStateArrayInitialPosition(org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

isPhysicalDiscriminator

protected boolean isPhysicalDiscriminator()

generateDiscriminatorMapping

protected EntityDiscriminatorMapping generateDiscriminatorMapping(PersistentClass bootEntityDescriptor)

getDiscriminatorType

public abstract BasicType<?> getDiscriminatorType()

Description copied from interface: EntityPersister

Get the discriminator type

Specified by:

getDiscriminatorType in interface EntityPersister

generateVersionMapping

protected EntityVersionMapping generateVersionMapping(Supplier<?> templateInstanceCreator,
 PersistentClass bootEntityDescriptor,
 org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

shouldProcessSuperMapping

protected boolean shouldProcessSuperMapping()

linkWithSuperType

public void linkWithSuperType(org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

Specified by:

linkWithSuperType in interface org.hibernate.metamodel.mapping.internal.InFlightEntityMappingType

linkWithSubType

public void linkWithSubType(EntityMappingType sub,
 org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

Specified by:

linkWithSubType in interface org.hibernate.metamodel.mapping.internal.InFlightEntityMappingType

getNumberOfAttributeMappings

public int getNumberOfAttributeMappings()

Description copied from interface: EntityMappingType

The total number of attributes for this entity, including those declared on supertype mappings

Specified by:

getNumberOfAttributeMappings in interface EntityMappingType

Specified by:

getNumberOfAttributeMappings in interface ManagedMappingType

getAttributeMapping

public AttributeMapping getAttributeMapping(int position)

Description copied from interface: EntityMappingType

Retrieve an attribute mapping by position, relative to all attributes

Specified by:

getAttributeMapping in interface EntityMappingType

Specified by:

getAttributeMapping in interface EntityPersister

Specified by:

getAttributeMapping in interface ManagedMappingType

getNumberOfDeclaredAttributeMappings

public int getNumberOfDeclaredAttributeMappings()

Description copied from interface: EntityMappingType

Get the number of attributes defined on this entity mapping - do not access attributes defined on the super

Specified by:

getNumberOfDeclaredAttributeMappings in interface EntityMappingType

getDeclaredAttributeMappings

public AttributeMappingsMap getDeclaredAttributeMappings()

Description copied from interface: EntityMappingType

Get access to the attributes defined on this class - do not access attributes defined on the super

Specified by:

getDeclaredAttributeMappings in interface EntityMappingType

visitDeclaredAttributeMappings

public void visitDeclaredAttributeMappings(Consumer<? super AttributeMapping> action)

Description copied from interface: EntityMappingType

Visit attributes defined on this class - do not visit attributes defined on the super

Specified by:

visitDeclaredAttributeMappings in interface EntityMappingType

getSuperMappingType

public EntityMappingType getSuperMappingType()

Description copied from interface: EntityMappingType

The mapping for the entity which is the supertype for this entity mapping.

Specified by:

getSuperMappingType in interface EntityMappingType

Returns:

The supertype mapping, or null if there is no supertype

getSubMappingTypes

public Collection<EntityMappingType> getSubMappingTypes()

Description copied from interface: EntityMappingType

Retrieve mappings for all subtypes

Specified by:

getSubMappingTypes in interface EntityMappingType

isTypeOrSuperType

public boolean isTypeOrSuperType(EntityMappingType targetType)

Description copied from interface: EntityMappingType

Whether the passed entity mapping is the same as or is a supertype of this entity mapping

Specified by:

isTypeOrSuperType in interface EntityMappingType

generateIdentifierMapping

protected EntityIdentifierMapping generateIdentifierMapping(Supplier<?> templateInstanceCreator,
 PersistentClass bootEntityDescriptor,
 org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

generateNonEncapsulatedCompositeIdentifierMapping

protected EntityIdentifierMapping generateNonEncapsulatedCompositeIdentifierMapping(org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess,
 PersistentClass bootEntityDescriptor)

generateVersionMapping

protected static EntityVersionMapping generateVersionMapping(AbstractEntityPersister entityPersister,
 Supplier<?> templateInstanceCreator,
 PersistentClass bootModelRootEntityDescriptor,
 org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

Parameters:

entityPersister - The AbstractEntityPersister being constructed - still initializing

bootModelRootEntityDescriptor - The boot-time entity descriptor for the "root entity" in the hierarchy

creationProcess - The SF creation process - access to useful things

generateNonIdAttributeMapping

protected AttributeMapping generateNonIdAttributeMapping(NonIdentifierAttribute tupleAttrDefinition,
 Property bootProperty,
 int stateArrayPosition,
 int fetchableIndex,
 org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

buildEmbeddedAttributeMapping

protected org.hibernate.metamodel.mapping.internal.EmbeddedAttributeMapping buildEmbeddedAttributeMapping(String attrName,
 int stateArrayPosition,
 int fetchableIndex,
 Property bootProperty,
 DependantValue dependantValue,
 int dependantColumnIndex,
 ManagedMappingType declaringType,
 CompositeType attrType,
 String tableExpression,
 String[] rootTableKeyColumnNames,
 PropertyAccess propertyAccess,
 CascadeStyle cascadeStyle,
 org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

For Hibernate Reactive

buildSingularAssociationAttributeMapping

protected AttributeMapping buildSingularAssociationAttributeMapping(String attrName,
 NavigableRole navigableRole,
 int stateArrayPosition,
 int fetchableIndex,
 Property bootProperty,
 ManagedMappingType declaringType,
 EntityPersister declaringEntityPersister,
 EntityType attrType,
 PropertyAccess propertyAccess,
 CascadeStyle cascadeStyle,
 org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

For Hibernate Reactive

buildPluralAttributeMapping

protected AttributeMapping buildPluralAttributeMapping(String attrName,
 int stateArrayPosition,
 int fetchableIndex,
 Property bootProperty,
 ManagedMappingType declaringType,
 PropertyAccess propertyAccess,
 CascadeStyle cascadeStyle,
 FetchMode fetchMode,
 org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess creationProcess)

For Hibernate Reactive

getMappedJavaType

public JavaType<?> getMappedJavaType()

Description copied from interface: MappingType

The descriptor descriptor for the mapped Java type

Specified by:

getMappedJavaType in interface EntityMappingType

Specified by:

getMappedJavaType in interface MappingType

getEntityPersister

public EntityPersister getEntityPersister()

Description copied from interface: EntityMappingType

Safety-net.

Specified by:

getEntityPersister in interface EntityMappingType

getIdentifierMapping

public EntityIdentifierMapping getIdentifierMapping()

Description copied from interface: EntityMappingType

Mapping details for the entity's identifier. This is shared across all entity mappings within an inheritance hierarchy.

Specified by:

getIdentifierMapping in interface EntityMappingType

getVersionMapping

public EntityVersionMapping getVersionMapping()

Description copied from interface: EntityMappingType

Mapping details for the entity's version when using the version strategy. This is shared across all entity mappings within an inheritance hierarchy.

Specified by:

getVersionMapping in interface EntityMappingType

Returns:

The version mapping, or null if the entity is (1) defined with a strategy other than OptimisticLockStyle.VERSION or (2) defined without optimistic locking

See Also:

• EntityMappingType.optimisticLockStyle()

getRowIdMapping

public EntityRowIdMapping getRowIdMapping()

Description copied from interface: EntityMappingType

The mapping for the row-id of the entity, if one is defined.

Specified by:

getRowIdMapping in interface EntityMappingType

getDiscriminatorMapping

public EntityDiscriminatorMapping getDiscriminatorMapping()

Description copied from interface: EntityMappingType

Mapping details for the entity's discriminator. This is shared across all entity mappings within an inheritance hierarchy.

Specified by:

getDiscriminatorMapping in interface Discriminable

Specified by:

getDiscriminatorMapping in interface EntityMappingType

getSoftDeleteMapping

public SoftDeleteMapping getSoftDeleteMapping()

Description copied from interface: EntityMappingType

Mapping for soft-delete support, or null if soft-delete not defined

Specified by:

getSoftDeleteMapping in interface EntityMappingType

Specified by:

getSoftDeleteMapping in interface SoftDeletableModelPart

getAttributeMappings

public AttributeMappingsList getAttributeMappings()

Description copied from interface: EntityMappingType

The attributes mapping for this entity, including those declared on supertype mappings

Specified by:

getAttributeMappings in interface EntityMappingType

Specified by:

getAttributeMappings in interface ManagedMappingType

findDeclaredAttributeMapping

public AttributeMapping findDeclaredAttributeMapping(String name)

Description copied from interface: EntityMappingType

Find an attribute-mapping, declared on this entity mapping (not super or subs), by name

Specified by:

findDeclaredAttributeMapping in interface EntityMappingType

findAttributeMapping

public AttributeMapping findAttributeMapping(String name)

Description copied from interface: ManagedMappingType

Find an attribute by name.

Specified by:

findAttributeMapping in interface ManagedMappingType

Returns:

The named attribute, or null if no match was found

findSubPart

public ModelPart findSubPart(String name,
 EntityMappingType treatTargetType)

Specified by:

findSubPart in interface EntityValuedModelPart

Specified by:

findSubPart in interface ModelPartContainer

findSubTypesSubPart

public ModelPart findSubTypesSubPart(String name,
 EntityMappingType treatTargetType)

Specified by:

findSubTypesSubPart in interface EntityMappingType

visitSubParts

public void visitSubParts(Consumer<ModelPart> consumer,
 EntityMappingType treatTargetType)

Specified by:

visitSubParts in interface EntityValuedModelPart

Specified by:

visitSubParts in interface ModelPartContainer

visitKeyFetchables

public void visitKeyFetchables(Consumer<? super Fetchable> fetchableConsumer,
 EntityMappingType treatTargetType)

Specified by:

visitKeyFetchables in interface FetchableContainer

visitKeyFetchables

public void visitKeyFetchables(org.hibernate.internal.util.IndexedConsumer<? super Fetchable> fetchableConsumer,
 EntityMappingType treatTargetType)

Specified by:

visitKeyFetchables in interface FetchableContainer

getNumberOfFetchables

public int getNumberOfFetchables()

Description copied from interface: FetchableContainer

The number of fetchables in the container

Specified by:

getNumberOfFetchables in interface EntityMappingType

Specified by:

getNumberOfFetchables in interface FetchableContainer

getNumberOfFetchableKeys

public int getNumberOfFetchableKeys()

Description copied from interface: FetchableContainer

The number of fetchables in the container

Specified by:

getNumberOfFetchableKeys in interface FetchableContainer

getKeyFetchable

public Fetchable getKeyFetchable(int position)

Specified by:

getKeyFetchable in interface FetchableContainer

getFetchable

public AttributeMapping getFetchable(int position)

Specified by:

getFetchable in interface EntityMappingType

Specified by:

getFetchable in interface FetchableContainer

visitFetchables

public void visitFetchables(Consumer<? super Fetchable> fetchableConsumer,
 EntityMappingType treatTargetType)

Specified by:

visitFetchables in interface FetchableContainer

visitFetchables

public void visitFetchables(org.hibernate.internal.util.IndexedConsumer<? super Fetchable> fetchableConsumer,
 EntityMappingType treatTargetType)

Specified by:

visitFetchables in interface FetchableContainer

getStaticFetchableList

protected AttributeMappingsList getStaticFetchableList()

visitAttributeMappings

public void visitAttributeMappings(Consumer<? super AttributeMapping> action)

Description copied from interface: EntityMappingType

Visit the mappings, but limited to just attributes defined in the targetType or its super-type(s) if any.

Specified by:

visitAttributeMappings in interface EntityMappingType

visitSuperTypeAttributeMappings

public void visitSuperTypeAttributeMappings(Consumer<? super AttributeMapping> action)

Description copied from interface: EntityMappingType

Walk this type's attributes as well as its super-type's

Specified by:

visitSuperTypeAttributeMappings in interface EntityMappingType

forEachSelectable

public int forEachSelectable(int offset,
 SelectableConsumer selectableConsumer)

Description copied from interface: ModelPart

Visits each selectable mapping with the selectable index offset by the given value. Returns the amount of jdbc types that have been visited.

Specified by:

forEachSelectable in interface ModelPart

visitSubTypeAttributeMappings

public void visitSubTypeAttributeMappings(Consumer<? super AttributeMapping> action)

Description copied from interface: EntityMappingType

Walk this type's attributes as well as its subtypes

Specified by:

visitSubTypeAttributeMappings in interface EntityMappingType

getJdbcTypeCount

public int getJdbcTypeCount()

Description copied from interface: Bindable

The number of JDBC mappings

Specified by:

getJdbcTypeCount in interface Bindable

Specified by:

getJdbcTypeCount in interface EntityMappingType

Specified by:

getJdbcTypeCount in interface EntityValuedModelPart

Specified by:

getJdbcTypeCount in interface JdbcMappingContainer

forEachJdbcType

public int forEachJdbcType(int offset,
 org.hibernate.internal.util.IndexedConsumer<JdbcMapping> action)

Description copied from interface: JdbcMappingContainer

Visit each JdbcMapping starting from the given offset

Specified by:

forEachJdbcType in interface EntityValuedModelPart

Specified by:

forEachJdbcType in interface JdbcMappingContainer

disassemble

public Object disassemble(Object value,
 SharedSessionContractImplementor session)

Description copied from interface: Bindable

Breaks down a value of J into its simple pieces. E.g., an embedded value gets broken down into an array of its attribute state; a basic value converts to itself; etc.

Generally speaking, this is the form in which entity state is kept relative to a Session via EntityEntry.

@Entity class Person {
    @Id Integer id;
    @Embedded Name name;
    int age;
}

@Embeddable class Name {
    String familiarName;
    String familyName;
}

At the top level, we would want to disassemble a Person value, so we'd ask the Bindable for the Person entity to disassemble. Given a Person value:

Person( id=1, name=Name( 'Steve', 'Ebersole' ), 28 )

this disassemble would result in a multidimensional array:

[ ["Steve", "Ebersole"], 28 ]

Note that the identifier is not part of this disassembled state. Note also how the embedded value results in a sub-array.

Specified by:

disassemble in interface Bindable

Specified by:

disassemble in interface EntityValuedModelPart

See Also:

forEachDisassembledJdbcValue

public <X,Y> int forEachDisassembledJdbcValue(Object value,
 int offset,
 X x,
 Y y,
 Bindable.JdbcValuesBiConsumer<X,Y> valuesConsumer,
 SharedSessionContractImplementor session)

Description copied from interface: Bindable

Like Bindable.forEachDisassembledJdbcValue(Object, Object, Object, JdbcValuesBiConsumer, SharedSessionContractImplementor), but additionally receives an offset by which the selectionIndex is incremented when calling Bindable.JdbcValuesBiConsumer.consume(int, Object, Object, Object, JdbcMapping).

Specified by:

forEachDisassembledJdbcValue in interface Bindable

Specified by:

forEachDisassembledJdbcValue in interface EntityValuedModelPart

forEachJdbcValue

public <X,Y> int forEachJdbcValue(Object value,
 int offset,
 X x,
 Y y,
 Bindable.JdbcValuesBiConsumer<X,Y> consumer,
 SharedSessionContractImplementor session)

Description copied from interface: Bindable

Visit each constituent JDBC value extracted from the entity instance itself. Short-hand form of calling Bindable.disassemble(Object, SharedSessionContractImplementor) and piping its result to Bindable.forEachDisassembledJdbcValue(Object, int, JdbcValuesConsumer, SharedSessionContractImplementor)

Specified by:

forEachJdbcValue in interface Bindable

Specified by:

forEachJdbcValue in interface EntityValuedModelPart

hasPartitionedSelectionMapping

public boolean hasPartitionedSelectionMapping()

Specified by:

hasPartitionedSelectionMapping in interface ManagedMappingType

Specified by:

hasPartitionedSelectionMapping in interface ModelPart

isTableCascadeDeleteEnabled

public abstract boolean isTableCascadeDeleteEnabled(int j)

getSubclassColumnAliasClosure

@Deprecated
protected String[] getSubclassColumnAliasClosure()

Deprecated.

Hibernate no longer uses aliases to read from result sets

getSubclassFormulaAliasClosure

@Deprecated
protected String[] getSubclassFormulaAliasClosure()

Deprecated.

Hibernate no longer uses aliases to read from result sets

getSubclassPropertyColumnAliases

@Deprecated
public String[] getSubclassPropertyColumnAliases(String propertyName,
 String suffix)

Deprecated.

Hibernate no longer uses aliases to read from result sets

Description copied from interface: EntityPersister

Return the column alias names used to persist/query the named property of the class or a subclass (optional operation).

Specified by:

getSubclassPropertyColumnAliases in interface EntityPersister

initSubclassPropertyAliasesMap

@Deprecated
protected void initSubclassPropertyAliasesMap(PersistentClass model)
                                       throws MappingException

Deprecated.

Hibernate no longer uses aliases to read from result sets

Must be called by subclasses, at the end of their constructors

Throws:

MappingException

getDiscriminatorAlias

public String getDiscriminatorAlias()

getSqlWhereStringTableExpression

protected String getSqlWhereStringTableExpression()

managesColumns

public boolean managesColumns(String[] columnNames)

Specified by:

managesColumns in interface EntityPersister