com.avaje.ebeaninternal.server.core

Class PersistRequestBean<T>

java.lang.Object

com.avaje.ebeaninternal.server.core.BeanRequest

com.avaje.ebeaninternal.server.core.PersistRequest

com.avaje.ebeaninternal.server.core.PersistRequestBean<T>

All Implemented Interfaces:

BeanPersistRequest<T>, BatchPostExecute

public class PersistRequestBean<T>
extends PersistRequest
implements BeanPersistRequest<T>

PersistRequest for insert update or delete of a bean.

Nested Class Summary

Nested classes/interfaces inherited from class com.avaje.ebeaninternal.server.core.PersistRequest

PersistRequest.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected T	bean The bean being persisted.
protected BeanDescriptor<T>	beanDescriptor
protected Integer	beanHash Hash value used to handle cascade delete both ways in a relationship.
protected Integer	beanIdentityHash
protected BeanManager<T>	beanManager
protected BeanPersistListener<T>	beanPersistListener
protected Set<String>	changedProps
protected ConcurrencyMode	concurrencyMode The concurrency mode used for update or delete.
protected BeanPersistController	controller For per post insert update delete control.
protected Object	idValue The unique id used for logging summary.
protected EntityBeanIntercept	intercept The associated intercept.
protected boolean	isDirty
protected Set<String>	loadedProps
protected boolean	notifyCache
protected T	oldValues Old values used for concurrency checking.
protected Object	parentBean The parent bean for unidirectional save.

Constructor Summary

Constructors

Constructor and Description
PersistRequestBean(SpiEbeanServer server, T bean, Object parentBean, BeanManager<T> mgr, SpiTransaction t, PersistExecute persistExecute)
PersistRequestBean(SpiEbeanServer server, T bean, Object parentBean, BeanManager<T> mgr, SpiTransaction t, PersistExecute persistExecute, Set<String> updateProps, ConcurrencyMode concurrencyMode) Used for forced update of a bean.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToPersistMap(BeanPersistIdMap beanPersistMap)
void	checkRowCount(int rowCount) Check for optimistic concurrency exception.
BeanDelta	createDeltaBean()
GenerateDmlRequest	createGenerateDmlRequest(boolean emptyStringAsNull) Create a GenerateDmlRequest used to generate the DML.
ConcurrencyMode	determineConcurrencyMode() Determine the concurrency mode depending on fully/partially populated bean.
int	executeNow() Execute the request right now.
int	executeOrQueue() Execute a the request or queue/batch it for later execution.
T	getBean() Return the bean associated with this request.
BeanPersistController	getBeanController() Return the controller if there is one associated with this type of bean.
BeanDescriptor<T>	getBeanDescriptor() Return the BeanDescriptor for the associated bean.
Object	getBeanId() Return the Id value for the bean.
BeanManager<T>	getBeanManager()
ConcurrencyMode	getConcurrencyMode() Return the concurrency mode used for this persist.
List<DerivedRelationshipData>	getDerivedRelationships()
EntityBeanIntercept	getEntityBeanIntercept() Return the intercept if there is one.
String	getFullName() Returns a description of the request.
Set<String>	getLoadedProperties() For an update or delete of a partially populated bean this is the set of loaded properties and otherwise returns null.
T	getOldValues() Get the old values bean.
Object	getParentBean() Return the parent bean for cascading save with unidirectional relationship.
Set<String>	getUpdatedProperties() Return the updated properties.
boolean	hasChanged(BeanProperty prop) Test if the property value has changed and if so include it in the update.
boolean	isDeleteMissingChildren() Return true if a stateless update should also delete any missing details beans.
boolean	isDirty() Used to skip updates if we know the bean is not dirty.
boolean	isDynamicUpdateSql() Return true if the update DML/SQL must be dynamically generated.
boolean	isLoadedProperty(BeanProperty prop) Return true if this property is loaded (full bean or included in partial bean).
boolean	isNotify(TransactionEvent txnEvent)
boolean	isNotifyCache()
boolean	isNotifyPersistListener()
boolean	isParent(Object o)
boolean	isRegisteredBean() Return true if this bean has been already been persisted (inserted/updated or deleted) in this transaction.
boolean	isRegisteredForDeleteBean()
boolean	isStatelessUpdate() Return true if this is a stateless update.
boolean	isUpdateNullProperties() Return true if null properties should be updated (treated as loaded) for stateless updates.
void	notifyCache() Notify/Update the local L2 cache after the transaction has successfully committed.
boolean	notifyLocalPersistListener()
void	postDelete()
void	postExecute() Post processing.
void	registerDeleteBean()
void	setBoundId(Object idValue) Set the Id value that was bound.
void	setGeneratedKey(Object idValue) Set the generated key back to the bean.
void	setLoadedProps(Set<String> additionalProps) Set loaded properties when generated values has added properties such as created and updated timestamps.
void	setStatelessUpdate(boolean statelessUpdate, boolean deleteMissingChildren, boolean updateNullProperties) Set to true if this is a stateless update.
void	setType(PersistRequest.Type type) Set the type of this request.
void	unRegisterBean()
void	unregisterDeleteBean()

Methods inherited from class com.avaje.ebeaninternal.server.core.PersistRequest

executeStatement, getPstmtBatch, getType, initTransIfRequired, isLogSql, isLogSummary, isPersistCascade

Methods inherited from class com.avaje.ebeaninternal.server.core.BeanRequest

commitTransIfRequired, createImplicitTransIfRequired, getConnection, getEbeanServer, getServer, getTransaction, rollbackTransIfRequired

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.avaje.ebean.event.BeanPersistRequest

getEbeanServer, getTransaction

Field Detail

beanManager

protected final BeanManager<T> beanManager

beanDescriptor

protected final BeanDescriptor<T> beanDescriptor

beanPersistListener

protected final BeanPersistListener<T> beanPersistListener

controller

protected final BeanPersistController controller

For per post insert update delete control.

intercept

protected final EntityBeanIntercept intercept

The associated intercept.

parentBean

protected final Object parentBean

The parent bean for unidirectional save.

isDirty

protected final boolean isDirty

bean

protected final T bean

The bean being persisted.

oldValues

protected T oldValues

Old values used for concurrency checking.

concurrencyMode

protected ConcurrencyMode concurrencyMode

The concurrency mode used for update or delete.

loadedProps

protected final Set<String> loadedProps

idValue

protected Object idValue

The unique id used for logging summary.

beanHash

protected Integer beanHash

Hash value used to handle cascade delete both ways in a relationship.

beanIdentityHash

protected Integer beanIdentityHash

changedProps

protected final Set<String> changedProps

notifyCache

protected boolean notifyCache

Constructor Detail

PersistRequestBean

public PersistRequestBean(SpiEbeanServer server,
                  T bean,
                  Object parentBean,
                  BeanManager<T> mgr,
                  SpiTransaction t,
                  PersistExecute persistExecute,
                  Set<String> updateProps,
                  ConcurrencyMode concurrencyMode)

Used for forced update of a bean.

PersistRequestBean

public PersistRequestBean(SpiEbeanServer server,
                  T bean,
                  Object parentBean,
                  BeanManager<T> mgr,
                  SpiTransaction t,
                  PersistExecute persistExecute)

Method Detail

isNotify

public boolean isNotify(TransactionEvent txnEvent)

isNotifyCache

public boolean isNotifyCache()

isNotifyPersistListener

public boolean isNotifyPersistListener()

notifyCache

public void notifyCache()

Notify/Update the local L2 cache after the transaction has successfully committed.

addToPersistMap

public void addToPersistMap(BeanPersistIdMap beanPersistMap)

notifyLocalPersistListener

public boolean notifyLocalPersistListener()

isParent

public boolean isParent(Object o)

isRegisteredBean

public boolean isRegisteredBean()

Return true if this bean has been already been persisted (inserted/updated or deleted) in this transaction.

unRegisterBean

public void unRegisterBean()

registerDeleteBean

public void registerDeleteBean()

unregisterDeleteBean

public void unregisterDeleteBean()

isRegisteredForDeleteBean

public boolean isRegisteredForDeleteBean()

setType

public void setType(PersistRequest.Type type)

Set the type of this request. One of INSERT, UPDATE, DELETE, UPDATESQL or CALLABLESQL.

Overrides:

setType in class PersistRequest

getBeanManager

public BeanManager<T> getBeanManager()

getBeanDescriptor

public BeanDescriptor<T> getBeanDescriptor()

Return the BeanDescriptor for the associated bean.

isStatelessUpdate

public boolean isStatelessUpdate()

Return true if this is a stateless update.

isDeleteMissingChildren

public boolean isDeleteMissingChildren()

Return true if a stateless update should also delete any missing details beans.

isUpdateNullProperties

public boolean isUpdateNullProperties()

Return true if null properties should be updated (treated as loaded) for stateless updates.

setStatelessUpdate

public void setStatelessUpdate(boolean statelessUpdate,
                      boolean deleteMissingChildren,
                      boolean updateNullProperties)

Set to true if this is a stateless update.

By Stateless it means that the bean was not previously fetched (and so does not have it's previous state) so we are doing an update on a bean that was probably created from JSON or XML.

isDirty

public boolean isDirty()

Used to skip updates if we know the bean is not dirty. This is the case for EntityBeans that have not been modified.

getConcurrencyMode

public ConcurrencyMode getConcurrencyMode()

Return the concurrency mode used for this persist.

setLoadedProps

public void setLoadedProps(Set<String> additionalProps)

Set loaded properties when generated values has added properties such as created and updated timestamps.

getLoadedProperties

public Set<String> getLoadedProperties()

Description copied from interface: BeanPersistRequest

For an update or delete of a partially populated bean this is the set of loaded properties and otherwise returns null.

Specified by:

getLoadedProperties in interface BeanPersistRequest<T>

getFullName

public String getFullName()

Returns a description of the request. This is typically the bean class name or the base table for MapBeans.

Used to determine common persist requests for queueing and statement batching.

getBean

public T getBean()

Return the bean associated with this request.

Specified by:

getBean in interface BeanPersistRequest<T>

getBeanId

public Object getBeanId()

Return the Id value for the bean.

createDeltaBean

public BeanDelta createDeltaBean()

getOldValues

public T getOldValues()

Get the old values bean. This is used to perform optimistic concurrency checking on updates and deletes.

Specified by:

getOldValues in interface BeanPersistRequest<T>

getParentBean

public Object getParentBean()

Return the parent bean for cascading save with unidirectional relationship.

getBeanController

public BeanPersistController getBeanController()

Return the controller if there is one associated with this type of bean. This returns null if there is no controller associated.

getEntityBeanIntercept

public EntityBeanIntercept getEntityBeanIntercept()

Return the intercept if there is one.

isLoadedProperty

public boolean isLoadedProperty(BeanProperty prop)

Return true if this property is loaded (full bean or included in partial bean).

executeNow

public int executeNow()

Description copied from class: PersistRequest

Execute the request right now.

Specified by:

executeNow in class PersistRequest

executeOrQueue

public int executeOrQueue()

Description copied from class: PersistRequest

Execute a the request or queue/batch it for later execution.

Specified by:

executeOrQueue in class PersistRequest

setGeneratedKey

public void setGeneratedKey(Object idValue)

Set the generated key back to the bean. Only used for inserts with getGeneratedKeys.

Specified by:

setGeneratedKey in interface BatchPostExecute

setBoundId

public void setBoundId(Object idValue)

Set the Id value that was bound. Used for the purposes of logging summary information on this request.

checkRowCount

public final void checkRowCount(int rowCount)
                         throws SQLException

Check for optimistic concurrency exception.

Specified by:

checkRowCount in interface BatchPostExecute

Throws:

SQLException

postDelete

public void postDelete()

postExecute

public void postExecute()
                 throws SQLException

Post processing.

Specified by:

postExecute in interface BatchPostExecute

Throws:

SQLException

determineConcurrencyMode

public ConcurrencyMode determineConcurrencyMode()

Determine the concurrency mode depending on fully/partially populated bean.

Specifically with version concurrency we want to check that the version property was one of the loaded properties.

isDynamicUpdateSql

public boolean isDynamicUpdateSql()

Return true if the update DML/SQL must be dynamically generated.

This is the case for updates/deletes of partially populated beans.

createGenerateDmlRequest

public GenerateDmlRequest createGenerateDmlRequest(boolean emptyStringAsNull)

Create a GenerateDmlRequest used to generate the DML.

Will used changed properties or loaded properties depending on the BeanDescriptor.isUpdateChangesOnly() value.

getUpdatedProperties

public Set<String> getUpdatedProperties()

Return the updated properties. If this returns null then all the properties on the bean where updated.

Specified by:

getUpdatedProperties in interface BeanPersistRequest<T>

hasChanged

public boolean hasChanged(BeanProperty prop)

Test if the property value has changed and if so include it in the update.

getDerivedRelationships

public List<DerivedRelationshipData> getDerivedRelationships()