com.avaje.ebeaninternal.api

Interface SpiUpdatePlan

All Known Implementing Classes:

UpdatePlan

public interface SpiUpdatePlan

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

This is a cachable plan with the purpose of being being able to skip some phases of the update bean processing.

The plans are cached by the BeanDescriptors.

Author:

rbygrave

Method Summary

Methods

Modifier and Type	Method and Description
void	bindSet(DmlHandler bind, Object bean) Bind given the request and bean.
Integer	getKey() Return the hash key for this plan.
ConcurrencyMode	getMode() Return the concurrency mode for this plan.
Set<String>	getProperties() Return the properties that where changed and should be included in the update statement.
Bindable	getSet() Return the set of bindable update properties.
String	getSql() Return the update SQL 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.

Method Detail

isEmptySetClause

boolean isEmptySetClause()

Return true if the set clause has no columns.

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

bindSet

void bindSet(DmlHandler bind,
           Object bean)
             throws SQLException

Bind given the request and bean. The bean could be the oldValues bean when binding a update or delete where clause with ALL concurrency mode.

Throws:

SQLException

getTimeCreated

long getTimeCreated()

Return the time this plan was created.

getTimeLastUsed

Long getTimeLastUsed()

Return the time this plan was last used.

getKey

Integer getKey()

Return the hash key for this plan.

getMode

ConcurrencyMode getMode()

Return the concurrency mode for this plan.

getSql

String getSql()

Return the update SQL statement.

getSet

Bindable getSet()

Return the set of bindable update properties.

getProperties

Set<String> getProperties()

Return the properties that where changed and should be included in the update statement.