Package org.hibernate.sql.results.graph.entity

Class AbstractEntityInitializer

java.lang.Object

org.hibernate.sql.results.graph.AbstractFetchParentAccess

org.hibernate.sql.results.graph.entity.AbstractEntityInitializer

All Implemented Interfaces:

EntityInitializer, FetchParentAccess, Initializer

Direct Known Subclasses:

EntityJoinedFetchInitializer, EntityResultInitializer

public abstract class AbstractEntityInitializer
extends AbstractFetchParentAccess
implements EntityInitializer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractEntityInitializer.State

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	entityInstanceForNotify
protected AbstractEntityInitializer.State	state

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntityInitializer(EntityResultGraphNode resultDescriptor, NavigablePath navigablePath, LockMode lockMode, Fetch identifierFetch, Fetch discriminatorFetch, DomainResult<Object> rowIdResult, AssemblerCreationState creationState)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractEntityInitializer(EntityResultGraphNode, NavigablePath, LockMode, Fetch, Fetch, DomainResult, FetchParentAccess, AssemblerCreationState) instead.
protected	AbstractEntityInitializer(EntityResultGraphNode resultDescriptor, NavigablePath navigablePath, LockMode lockMode, Fetch identifierFetch, Fetch discriminatorFetch, DomainResult<Object> rowIdResult, FetchParentAccess parentAccess, AssemblerCreationState creationState)

Method Summary

Modifier and Type	Method	Description
protected boolean	consistentInstance(Object toInitialize, RowProcessingState rowProcessingState)
void	endLoading(ExecutionContext executionContext)	Lifecycle method called at the very end of the result values processing
protected Object[]	extractConcreteTypeStateValues(RowProcessingState rowProcessingState)
void	finishUpRow(RowProcessingState rowProcessingState)	Lifecycle method called at the end of the current row processing.
protected DomainResultAssembler<?>[][]	getAssemblers()
EntityPersister	getConcreteDescriptor()
EntityPersister	getEntityDescriptor()	Get the descriptor for the type of entity being initialized
protected Object	getEntityFromExecutionContext(RowProcessingState rowProcessingState)
Object	getEntityInstance()	Get the entity instance for the currently processing "row".
protected Object	getEntityInstanceForNotify()
EntityKey	getEntityKey()
FetchParentAccess	getFetchParentAccess()
protected DomainResultAssembler<?>	getIdentifierAssembler()
ModelPart	getInitializedPart()
Object	getKeyValue()
protected LockMode	getLockMode()
NavigablePath	getNavigablePath()
@Nullable EntityMappingType	getOwnedModelPartDeclaringType()
@Nullable FetchParentAccess	getOwningParent()
Object	getParentKey()
protected Object[]	getResolvedEntityState()
protected DomainResultAssembler<Object>	getRowIdAssembler()
protected abstract String	getSimpleConcreteImplName()	Simple class name of this initializer for logging
protected DomainResultAssembler<?>	getVersionAssembler()
void	initializeInstance(RowProcessingState rowProcessingState)	Step 3 - Initialize the state of the instance resolved in Initializer.resolveInstance(org.hibernate.sql.results.jdbc.spi.RowProcessingState) from the current row values.
protected void	initializeSubInstancesFromParent(RowProcessingState rowProcessingState)
protected Object	instantiateEntity(Object entityIdentifier, SharedSessionContractImplementor session)
boolean	isEntityInitialized()
boolean	isPartOfKey()
void	markShallowCached()
protected void	preLoad(RowProcessingState rowProcessingState)
protected void	registerLoadingEntity(RowProcessingState rowProcessingState, Object instance)
protected void	registerNaturalIdResolution(PersistenceContext persistenceContext, Object entityIdentifier)
protected void	registerPossibleUniqueKeyEntries(Object toInitialize, SharedSessionContractImplementor session)
protected void	registerReloadedEntity(RowProcessingState rowProcessingState)
protected void	registerReloadedEntity(RowProcessingState rowProcessingState, EntityHolder holder)
void	registerResolutionListener(Consumer<Object> listener)	Register a listener to be notified when the parent is "resolved"
protected Object	resolveEntityInstance(Object entityIdentifier, RowProcessingState rowProcessingState)
protected void	resolveEntityInstance(RowProcessingState rowProcessingState, EntityHolder holder, Object entityIdentifier)
protected Object	resolveInstance(Object entityIdentifier, EntityHolder holder, RowProcessingState rowProcessingState)	Used by Hibernate Reactive
void	resolveInstance(RowProcessingState rowProcessingState)	Step 2 - Using the key resolved in Initializer.resolveKey(org.hibernate.sql.results.jdbc.spi.RowProcessingState), resolve the instance (of the thing initialized) to use for the current row.
void	resolveKey(RowProcessingState rowProcessingState)	Step 1 - Resolve the key value for this initializer for the current row.
protected void	setEntityInstance(Object entityInstance)
protected void	setEntityInstanceForNotify(Object entityInstanceForNotify)
protected void	setResolvedEntityState(Object[] resolvedEntityState)
protected boolean	skipInitialization(Object toInitialize, RowProcessingState rowProcessingState)
void	startLoading(RowProcessingState rowProcessingState)
protected void	takeSnapshot(RowProcessingState rowProcessingState, SharedSessionContractImplementor session, PersistenceContext persistenceContext, EntityEntry entityEntry)
protected void	updateCaches(Object toInitialize, RowProcessingState rowProcessingState, SharedSessionContractImplementor session, PersistenceContext persistenceContext, Object entityIdentifier, Object version)

Methods inherited from class org.hibernate.sql.results.graph.AbstractFetchParentAccess

clearResolutionListeners, isParentShallowCached, notifyResolutionListeners

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.sql.results.graph.entity.EntityInitializer

asEntityInitializer, findFirstEntityDescriptorAccess, findFirstEntityInitializer, getInitializedInstance, isEntityInitializer

Methods inherited from interface org.hibernate.sql.results.graph.FetchParentAccess

shouldSkipInitializer

Methods inherited from interface org.hibernate.sql.results.graph.Initializer

asCollectionInitializer, asEmbeddableInitializer, initializeInstanceFromParent, isCollectionInitializer, isEmbeddableInitializer, isResultInitializer

Field Detail

entityInstanceForNotify

protected Object entityInstanceForNotify

state

protected AbstractEntityInitializer.State state

Constructor Detail

AbstractEntityInitializer

@Deprecated(forRemoval=true)
protected AbstractEntityInitializer(EntityResultGraphNode resultDescriptor,
                                    NavigablePath navigablePath,
                                    LockMode lockMode,
                                    Fetch identifierFetch,
                                    Fetch discriminatorFetch,
                                    DomainResult<Object> rowIdResult,
                                    AssemblerCreationState creationState)

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

Use AbstractEntityInitializer(EntityResultGraphNode, NavigablePath, LockMode, Fetch, Fetch, DomainResult, FetchParentAccess, AssemblerCreationState) instead.

AbstractEntityInitializer

protected AbstractEntityInitializer(EntityResultGraphNode resultDescriptor,
                                    NavigablePath navigablePath,
                                    LockMode lockMode,
                                    Fetch identifierFetch,
                                    Fetch discriminatorFetch,
                                    DomainResult<Object> rowIdResult,
                                    FetchParentAccess parentAccess,
                                    AssemblerCreationState creationState)

Method Detail

getInitializedPart

public ModelPart getInitializedPart()

Specified by:

getInitializedPart in interface Initializer

getSimpleConcreteImplName

protected abstract String getSimpleConcreteImplName()

Simple class name of this initializer for logging

getNavigablePath

public NavigablePath getNavigablePath()

Specified by:

getNavigablePath in interface FetchParentAccess

Specified by:

getNavigablePath in interface Initializer

getIdentifierAssembler

protected DomainResultAssembler<?> getIdentifierAssembler()

getEntityDescriptor

public EntityPersister getEntityDescriptor()

Description copied from interface: EntityInitializer

Get the descriptor for the type of entity being initialized

Specified by:

getEntityDescriptor in interface EntityInitializer

getEntityInstance

public Object getEntityInstance()

Description copied from interface: EntityInitializer

Get the entity instance for the currently processing "row".

Specified by:

getEntityInstance in interface EntityInitializer

setEntityInstance

protected void setEntityInstance(Object entityInstance)

getKeyValue

public Object getKeyValue()

getEntityKey

public EntityKey getEntityKey()

Specified by:

getEntityKey in interface EntityInitializer

getParentKey

public Object getParentKey()

Specified by:

getParentKey in interface FetchParentAccess

getFetchParentAccess

public FetchParentAccess getFetchParentAccess()

Specified by:

getFetchParentAccess in interface FetchParentAccess

getOwningParent

public @Nullable FetchParentAccess getOwningParent()

Specified by:

getOwningParent in interface FetchParentAccess

getOwnedModelPartDeclaringType

public @Nullable EntityMappingType getOwnedModelPartDeclaringType()

Specified by:

getOwnedModelPartDeclaringType in interface FetchParentAccess

registerResolutionListener

public void registerResolutionListener(Consumer<Object> listener)

Description copied from interface: FetchParentAccess

Register a listener to be notified when the parent is "resolved"

Specified by:

registerResolutionListener in interface FetchParentAccess

Overrides:

registerResolutionListener in class AbstractFetchParentAccess

startLoading

public void startLoading(RowProcessingState rowProcessingState)

Specified by:

startLoading in interface Initializer

markShallowCached

public void markShallowCached()

Specified by:

markShallowCached in interface Initializer

Overrides:

markShallowCached in class AbstractFetchParentAccess

resolveKey

public void resolveKey(RowProcessingState rowProcessingState)

Description copied from interface: Initializer

Step 1 - Resolve the key value for this initializer for the current row. After this point, the initializer knows the entity/collection/component key for the current row

Specified by:

resolveKey in interface Initializer

resolveInstance

public void resolveInstance(RowProcessingState rowProcessingState)

Description copied from interface: Initializer

Step 2 - Using the key resolved in Initializer.resolveKey(org.hibernate.sql.results.jdbc.spi.RowProcessingState), resolve the instance (of the thing initialized) to use for the current row. After this point, the initializer knows the entity/collection/component instance for the current row based on the resolved key

Specified by:

resolveInstance in interface Initializer

resolveEntityInstance

protected void resolveEntityInstance(RowProcessingState rowProcessingState,
                                     EntityHolder holder,
                                     Object entityIdentifier)

getEntityFromExecutionContext

protected Object getEntityFromExecutionContext(RowProcessingState rowProcessingState)

resolveInstance

protected Object resolveInstance(Object entityIdentifier,
                                 EntityHolder holder,
                                 RowProcessingState rowProcessingState)

Used by Hibernate Reactive

resolveEntityInstance

protected Object resolveEntityInstance(Object entityIdentifier,
                                       RowProcessingState rowProcessingState)

instantiateEntity

protected Object instantiateEntity(Object entityIdentifier,
                                   SharedSessionContractImplementor session)

registerLoadingEntity

protected void registerLoadingEntity(RowProcessingState rowProcessingState,
                                     Object instance)

registerReloadedEntity

protected void registerReloadedEntity(RowProcessingState rowProcessingState)

registerReloadedEntity

protected void registerReloadedEntity(RowProcessingState rowProcessingState,
                                      EntityHolder holder)

initializeInstance

public void initializeInstance(RowProcessingState rowProcessingState)

Description copied from interface: Initializer

Step 3 - Initialize the state of the instance resolved in Initializer.resolveInstance(org.hibernate.sql.results.jdbc.spi.RowProcessingState) from the current row values. All resolved state for the current row is injected into the resolved instance

Specified by:

initializeInstance in interface Initializer

consistentInstance

protected boolean consistentInstance(Object toInitialize,
                                     RowProcessingState rowProcessingState)

updateCaches

protected void updateCaches(Object toInitialize,
                            RowProcessingState rowProcessingState,
                            SharedSessionContractImplementor session,
                            PersistenceContext persistenceContext,
                            Object entityIdentifier,
                            Object version)

registerNaturalIdResolution

protected void registerNaturalIdResolution(PersistenceContext persistenceContext,
                                           Object entityIdentifier)

takeSnapshot

protected void takeSnapshot(RowProcessingState rowProcessingState,
                            SharedSessionContractImplementor session,
                            PersistenceContext persistenceContext,
                            EntityEntry entityEntry)

registerPossibleUniqueKeyEntries

protected void registerPossibleUniqueKeyEntries(Object toInitialize,
                                                SharedSessionContractImplementor session)

extractConcreteTypeStateValues

protected Object[] extractConcreteTypeStateValues(RowProcessingState rowProcessingState)

skipInitialization

protected boolean skipInitialization(Object toInitialize,
                                     RowProcessingState rowProcessingState)

preLoad

protected void preLoad(RowProcessingState rowProcessingState)

isPartOfKey

public boolean isPartOfKey()

Specified by:

isPartOfKey in interface Initializer

isEntityInitialized

public boolean isEntityInitialized()

Specified by:

isEntityInitialized in interface EntityInitializer

Returns:

true if the current entity associated to this EntityInitializer has been initialized

getConcreteDescriptor

public EntityPersister getConcreteDescriptor()

Specified by:

getConcreteDescriptor in interface EntityInitializer

initializeSubInstancesFromParent

protected void initializeSubInstancesFromParent(RowProcessingState rowProcessingState)

finishUpRow

public void finishUpRow(RowProcessingState rowProcessingState)

Description copied from interface: Initializer

Lifecycle method called at the end of the current row processing. Provides ability to complete processing from the current row and prepare for the next row.

Specified by:

finishUpRow in interface Initializer

endLoading

public void endLoading(ExecutionContext executionContext)

Description copied from interface: Initializer

Lifecycle method called at the very end of the result values processing

Specified by:

endLoading in interface Initializer

Overrides:

endLoading in class AbstractFetchParentAccess

setEntityInstanceForNotify

protected void setEntityInstanceForNotify(Object entityInstanceForNotify)

getEntityInstanceForNotify

protected Object getEntityInstanceForNotify()

setResolvedEntityState

protected void setResolvedEntityState(Object[] resolvedEntityState)

getResolvedEntityState

protected Object[] getResolvedEntityState()

getVersionAssembler

protected DomainResultAssembler<?> getVersionAssembler()

getRowIdAssembler

protected DomainResultAssembler<Object> getRowIdAssembler()

getLockMode

protected LockMode getLockMode()

getAssemblers

protected DomainResultAssembler<?>[][] getAssemblers()