com.avaje.ebeaninternal.server.persist.dml

Class UpdatePlan

java.lang.Object

com.avaje.ebeaninternal.server.persist.dml.UpdatePlan

All Implemented Interfaces:

SpiUpdatePlan

public class UpdatePlan
extends Object
implements SpiUpdatePlan

Cachable plan for executing bean updates for a given set of changed properties.

Author:

rbygrave

Field Summary

Fields

Modifier and Type	Field and Description
static UpdatePlan	EMPTY_SET_CLAUSE Special plan used when there is nothing in the set clause and the update should in fact be skipped.

Constructor Summary

Constructors

Constructor and Description
UpdatePlan(ConcurrencyMode mode, String sql, Bindable set) Create a non cachable UpdatePlan.
UpdatePlan(Integer key, ConcurrencyMode mode, String sql, Bindable set, Set<String> properties) Create a cachable UpdatePlan with a given key.

Method Summary

Methods

Modifier and Type	Method and Description
void	bindSet(DmlHandler bind, Object bean) Run the prepared statement binding for the 'update set' properties.
Integer	getKey() Return the hash key.
ConcurrencyMode	getMode() Return the concurrency mode for this plan.
Set<String>	getProperties() Return the set of changed properties.
Bindable	getSet() Return the Bindable properties for the update set.
String	getSql() Return the DML statement.
long	getTimeCreated() Return the time this plan was created.
Long	getTimeLastUsed() Return the time this plan was last used.
boolean	isEmptySetClause() Return true if the set clause has no columns.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_SET_CLAUSE

public static final UpdatePlan EMPTY_SET_CLAUSE

Special plan used when there is nothing in the set clause and the update should in fact be skipped. Occurs when the updated properties have updatable=false in their deployment.

Constructor Detail

UpdatePlan

public UpdatePlan(ConcurrencyMode mode,
          String sql,
          Bindable set)

Create a non cachable UpdatePlan.

UpdatePlan

public UpdatePlan(Integer key,
          ConcurrencyMode mode,
          String sql,
          Bindable set,
          Set<String> properties)

Create a cachable UpdatePlan with a given key.

Method Detail

isEmptySetClause

public boolean isEmptySetClause()

Description copied from interface: SpiUpdatePlan

Return true if the set clause has no columns.

Can occur when the only columns updated have a updatable=false in their deployment.

Specified by:

isEmptySetClause in interface SpiUpdatePlan

bindSet

public void bindSet(DmlHandler bind,
           Object bean)
             throws SQLException

Run the prepared statement binding for the 'update set' properties.

Specified by:

bindSet in interface SpiUpdatePlan

Throws:

SQLException

getTimeCreated

public long getTimeCreated()

Return the time this plan was created.

Specified by:

getTimeCreated in interface SpiUpdatePlan

getTimeLastUsed

public Long getTimeLastUsed()

Return the time this plan was last used.

Specified by:

getTimeLastUsed in interface SpiUpdatePlan

getKey

public Integer getKey()

Return the hash key.

Specified by:

getKey in interface SpiUpdatePlan

getMode

public ConcurrencyMode getMode()

Return the concurrency mode for this plan.

Specified by:

getMode in interface SpiUpdatePlan

getSql

public String getSql()

Return the DML statement.

Specified by:

getSql in interface SpiUpdatePlan

getSet

public Bindable getSet()

Return the Bindable properties for the update set.

Specified by:

getSet in interface SpiUpdatePlan

getProperties

public Set<String> getProperties()

Return the set of changed properties.

This can return null when all properties in the set are being bound in the update statement.

Specified by:

getProperties in interface SpiUpdatePlan