org.hibernate.engine.internal

Class AbstractEntityEntry

java.lang.Object

org.hibernate.engine.internal.AbstractEntityEntry

All Implemented Interfaces:

Serializable, EntityEntry

Direct Known Subclasses:

ImmutableEntityEntry, MutableEntityEntry

public abstract class AbstractEntityEntry
extends Object
implements Serializable, EntityEntry

A base implementation of EntityEntry

Author:

Gavin King, Emmanuel Bernard , Gunnar Morling, Sanne Grinovero

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractEntityEntry.BooleanState Represents a boolean flag stored within a number value, using one bit at a specified offset.
protected static class	AbstractEntityEntry.EnumState<E extends Enum<E>> Represents an enum value stored within a number value, using four bits starting at a specified offset.

Field Summary

Fields

Modifier and Type	Field and Description
protected EntityKey	cachedEntityKey
protected Serializable	id
protected Object[]	loadedState
protected EntityEntryExtraState	next
protected PersistenceContext	persistenceContext
protected EntityPersister	persister
protected Object	rowId
protected Object	version

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEntityEntry(SessionFactoryImplementor factory, String entityName, Serializable id, Status status, Status previousStatus, Object[] loadedState, Object[] deletedState, Object version, LockMode lockMode, boolean existsInDatabase, boolean isBeingReplicated, PersistenceContext persistenceContext) This for is used during custom deserialization handling
	AbstractEntityEntry(Status status, Object[] loadedState, Object rowId, Serializable id, Object version, LockMode lockMode, boolean existsInDatabase, EntityPersister persister, boolean disableVersionIncrement, PersistenceContext persistenceContext)
	AbstractEntityEntry(Status status, Object[] loadedState, Object rowId, Serializable id, Object version, LockMode lockMode, boolean existsInDatabase, EntityPersister persister, EntityMode entityMode, String tenantId, boolean disableVersionIncrement, PersistenceContext persistenceContext) Deprecated. the tenantId and entityMode parameters where removed: this constructor accepts but ignores them. Use the other constructor!

Method Summary

Modifier and Type	Method and Description
void	addExtraState(EntityEntryExtraState extraState)
void	forceLocked(Object entity, Object nextVersion)
protected boolean	getCompressedValue(AbstractEntityEntry.BooleanState state) Gets the current value of the given boolean flag.
protected <E extends Enum<E>> E	getCompressedValue(AbstractEntityEntry.EnumState<E> state) Gets the current value of the given enum property.
Object[]	getDeletedState()
EntityKey	getEntityKey() Get the EntityKey based on this EntityEntry.
String	getEntityName()
<T extends EntityEntryExtraState> T	getExtraState(Class<T> extraStateType)
Serializable	getId()
Object[]	getLoadedState()
Object	getLoadedValue(String propertyName)
LockMode	getLockMode()
PersistenceContext	getPersistenceContext()
EntityPersister	getPersister()
Object	getRowId()
Status	getStatus()
Object	getVersion()
boolean	isBeingReplicated()
boolean	isExistsInDatabase()
boolean	isModifiableEntity() Can the entity be modified? The entity is modifiable if all of the following are true: the entity class is mutable the entity is not read-only if the current status is Status.DELETED, then the entity was not read-only when it was deleted
boolean	isNullifiable(boolean earlyInsert, SessionImplementor session)
boolean	isReadOnly()
void	overwriteLoadedStateCollectionValue(String propertyName, PersistentCollection collection)
void	postDelete() After actually deleting a row, record the fact that the instance no longer exists in the database
void	postInsert(Object[] insertedState) After actually inserting a row, record the fact that the instance exists on the database (needed for identity-column key generation)
void	postUpdate(Object entity, Object[] updatedState, Object nextVersion) Handle updating the internal state of the entry after actually performing the database update.
boolean	requiresDirtyCheck(Object entity) Not sure this is the best method name, but the general idea here is to return true if the entity can possibly be dirty.
void	serialize(ObjectOutputStream oos) Custom serialization routine used during serialization of a Session/PersistenceContext for increased performance.
protected void	setCompressedValue(AbstractEntityEntry.BooleanState state, boolean value) Saves the value for the given boolean flag.
protected <E extends Enum<E>> void	setCompressedValue(AbstractEntityEntry.EnumState<E> state, E value) Saves the value for the given enum property.
void	setDeletedState(Object[] deletedState)
void	setLockMode(LockMode lockMode)
void	setReadOnly(boolean readOnly, Object entity)
void	setStatus(Status status)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

protected final Serializable id

loadedState

protected Object[] loadedState

version

protected Object version

persister

protected final EntityPersister persister

cachedEntityKey

protected transient EntityKey cachedEntityKey

rowId

protected final transient Object rowId

persistenceContext

protected final transient PersistenceContext persistenceContext

next

protected EntityEntryExtraState next

Constructor Detail

AbstractEntityEntry

@Deprecated
public AbstractEntityEntry(Status status,
                                       Object[] loadedState,
                                       Object rowId,
                                       Serializable id,
                                       Object version,
                                       LockMode lockMode,
                                       boolean existsInDatabase,
                                       EntityPersister persister,
                                       EntityMode entityMode,
                                       String tenantId,
                                       boolean disableVersionIncrement,
                                       PersistenceContext persistenceContext)

Deprecated. the tenantId and entityMode parameters where removed: this constructor accepts but ignores them. Use the other constructor!

AbstractEntityEntry

public AbstractEntityEntry(Status status,
                           Object[] loadedState,
                           Object rowId,
                           Serializable id,
                           Object version,
                           LockMode lockMode,
                           boolean existsInDatabase,
                           EntityPersister persister,
                           boolean disableVersionIncrement,
                           PersistenceContext persistenceContext)

AbstractEntityEntry

protected AbstractEntityEntry(SessionFactoryImplementor factory,
                              String entityName,
                              Serializable id,
                              Status status,
                              Status previousStatus,
                              Object[] loadedState,
                              Object[] deletedState,
                              Object version,
                              LockMode lockMode,
                              boolean existsInDatabase,
                              boolean isBeingReplicated,
                              PersistenceContext persistenceContext)

This for is used during custom deserialization handling

Method Detail

getLockMode

public LockMode getLockMode()

Specified by:

getLockMode in interface EntityEntry

setLockMode

public void setLockMode(LockMode lockMode)

Specified by:

setLockMode in interface EntityEntry

getStatus

public Status getStatus()

Specified by:

getStatus in interface EntityEntry

setStatus

public void setStatus(Status status)

Specified by:

setStatus in interface EntityEntry

getId

public Serializable getId()

Specified by:

getId in interface EntityEntry

getLoadedState

public Object[] getLoadedState()

Specified by:

getLoadedState in interface EntityEntry

getDeletedState

public Object[] getDeletedState()

Specified by:

getDeletedState in interface EntityEntry

setDeletedState

public void setDeletedState(Object[] deletedState)

Specified by:

setDeletedState in interface EntityEntry

isExistsInDatabase

public boolean isExistsInDatabase()

Specified by:

isExistsInDatabase in interface EntityEntry

getVersion

public Object getVersion()

Specified by:

getVersion in interface EntityEntry

getPersister

public EntityPersister getPersister()

Specified by:

getPersister in interface EntityEntry

getEntityKey

public EntityKey getEntityKey()

Description copied from interface: EntityEntry

Get the EntityKey based on this EntityEntry.

Specified by:

getEntityKey in interface EntityEntry

Returns:

the EntityKey

getEntityName

public String getEntityName()

Specified by:

getEntityName in interface EntityEntry

isBeingReplicated

public boolean isBeingReplicated()

Specified by:

isBeingReplicated in interface EntityEntry

getRowId

public Object getRowId()

Specified by:

getRowId in interface EntityEntry

postUpdate

public void postUpdate(Object entity,
                       Object[] updatedState,
                       Object nextVersion)

Description copied from interface: EntityEntry

Handle updating the internal state of the entry after actually performing the database update. Specifically we update the snapshot information and escalate the lock mode

Specified by:

postUpdate in interface EntityEntry

Parameters:

entity - The entity instance

updatedState - The state calculated after the update (becomes the new loaded state.

nextVersion - The new version.

postDelete

public void postDelete()

Description copied from interface: EntityEntry

After actually deleting a row, record the fact that the instance no longer exists in the database

Specified by:

postDelete in interface EntityEntry

postInsert

public void postInsert(Object[] insertedState)

Description copied from interface: EntityEntry

After actually inserting a row, record the fact that the instance exists on the database (needed for identity-column key generation)

Specified by:

postInsert in interface EntityEntry

isNullifiable

public boolean isNullifiable(boolean earlyInsert,
                             SessionImplementor session)

Specified by:

isNullifiable in interface EntityEntry

getLoadedValue

public Object getLoadedValue(String propertyName)

Specified by:

getLoadedValue in interface EntityEntry

overwriteLoadedStateCollectionValue

public void overwriteLoadedStateCollectionValue(String propertyName,
                                                PersistentCollection collection)

Specified by:

overwriteLoadedStateCollectionValue in interface EntityEntry

requiresDirtyCheck

public boolean requiresDirtyCheck(Object entity)

Description copied from interface: EntityEntry

Not sure this is the best method name, but the general idea here is to return true if the entity can possibly be dirty. This can only be the case if it is in a modifiable state (not read-only/deleted) and it either has mutable properties or field-interception is not telling us it is dirty. Clear as mud? :/ A name like canPossiblyBeDirty might be better

Specified by:

requiresDirtyCheck in interface EntityEntry

Parameters:

entity - The entity to test

Returns:

true indicates that the entity could possibly be dirty and that dirty check should happen; false indicates there is no way the entity can be dirty

isModifiableEntity

public boolean isModifiableEntity()

Description copied from interface: EntityEntry

Can the entity be modified? The entity is modifiable if all of the following are true:

• the entity class is mutable
• the entity is not read-only
• if the current status is Status.DELETED, then the entity was not read-only when it was deleted

Specified by:

isModifiableEntity in interface EntityEntry

Returns:

true, if the entity is modifiable; false, otherwise,

forceLocked

public void forceLocked(Object entity,
                        Object nextVersion)

Specified by:

forceLocked in interface EntityEntry

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface EntityEntry

setReadOnly

public void setReadOnly(boolean readOnly,
                        Object entity)

Specified by:

setReadOnly in interface EntityEntry

toString

public String toString()

Specified by:

toString in interface EntityEntry

Overrides:

toString in class Object

serialize

public void serialize(ObjectOutputStream oos)
               throws IOException

Description copied from interface: EntityEntry

Custom serialization routine used during serialization of a Session/PersistenceContext for increased performance.

Specified by:

serialize in interface EntityEntry

Parameters:

oos - The stream to which we should write the serial data.

Throws:

IOException - If a stream error occurs

addExtraState

public void addExtraState(EntityEntryExtraState extraState)

Specified by:

addExtraState in interface EntityEntry

getExtraState

public <T extends EntityEntryExtraState> T getExtraState(Class<T> extraStateType)

Specified by:

getExtraState in interface EntityEntry

getPersistenceContext

public PersistenceContext getPersistenceContext()

setCompressedValue

protected <E extends Enum<E>> void setCompressedValue(AbstractEntityEntry.EnumState<E> state,
                                                      E value)

Saves the value for the given enum property.

Parameters:

state - identifies the value to store

value - the value to store; The caller must make sure that it matches the given identifier

getCompressedValue

protected <E extends Enum<E>> E getCompressedValue(AbstractEntityEntry.EnumState<E> state)

Gets the current value of the given enum property.

Parameters:

state - identifies the value to store

Returns:

the current value of the specified property

setCompressedValue

protected void setCompressedValue(AbstractEntityEntry.BooleanState state,
                                  boolean value)

Saves the value for the given boolean flag.

Parameters:

state - identifies the value to store

value - the value to store

getCompressedValue

protected boolean getCompressedValue(AbstractEntityEntry.BooleanState state)

Gets the current value of the given boolean flag.

Parameters:

state - identifies the value to store

Returns:

the current value of the specified flag