Module io.ebean.core

Package io.ebeaninternal.server.querydefn

Class DefaultOrmUpdate<T>

java.lang.Object

io.ebeaninternal.server.querydefn.DefaultOrmUpdate<T>

All Implemented Interfaces:

Update<T>, SpiUpdate<T>, Serializable

public final class DefaultOrmUpdate<T>
extends Object
implements SpiUpdate<T>, Serializable

Default implementation of OrmUpdate.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.ebeaninternal.api.SpiUpdate

SpiUpdate.OrmUpdateType

Constructor Summary

Constructors

Constructor	Description
DefaultOrmUpdate(Class<?> beanType, Database server, String baseTable, String updateStatement)	Create with a specific server.

Method Summary

Modifier and Type	Method	Description
String	baseTable()	Return the name of the table being modified.
Class<?>	beanType()	Return the type of bean being updated.
BindParams	bindParams()	Return the bind parameters.
int	execute()
String	getGeneratedSql()
String	getName()
boolean	isNotifyCache()	Return true if the cache should be notified so that invalidates appropriate objects.
String	label()	Return the label (for metrics collection).
SpiUpdate.OrmUpdateType	ormUpdateType()	Return the type of this - insert, update or delete.
DefaultOrmUpdate<T>	set(int position, Object value)
DefaultOrmUpdate<T>	set(String name, Object value)
void	setGeneratedSql(String generatedSql)	Set the generated sql used.
Update<T>	setLabel(String label)
DefaultOrmUpdate<T>	setNotifyCache(boolean notifyCache)	Set this to false if you don't want eBean to automatically deduce the table modification information and process it.
DefaultOrmUpdate<T>	setNull(int position, int jdbcType)
DefaultOrmUpdate<T>	setNull(String name, int jdbcType)
DefaultOrmUpdate<T>	setNullParameter(int position, int jdbcType)
DefaultOrmUpdate<T>	setNullParameter(String name, int jdbcType)
DefaultOrmUpdate<T>	setParameter(int position, Object value)
DefaultOrmUpdate<T>	setParameter(String name, Object param)
DefaultOrmUpdate<T>	setTimeout(int secs)
int	timeout()	Return the timeout in seconds.
String	updateStatement()	Return the update statement.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultOrmUpdate

public DefaultOrmUpdate(Class<?> beanType,
 Database server,
 String baseTable,
 String updateStatement)

Create with a specific server. This means you can use the UpdateSql.execute() method.

Method Details

setTimeout

public DefaultOrmUpdate<T> setTimeout(int secs)

Specified by:

setTimeout in interface Update<T>

beanType

public Class<?> beanType()

Description copied from interface: SpiUpdate

Return the type of bean being updated.

Specified by:

beanType in interface SpiUpdate<T>

timeout

public int timeout()

Return the timeout in seconds.

Specified by:

timeout in interface SpiUpdate<T>

execute

public int execute()

Specified by:

execute in interface Update<T>

setNotifyCache

public DefaultOrmUpdate<T> setNotifyCache(boolean notifyCache)

Set this to false if you don't want eBean to automatically deduce the table modification information and process it.

Set this to false if you don't want any cache invalidation or text index management to occur. You may do this when say you update only one column and you know that it is not important for cached objects or text indexes.

Specified by:

setNotifyCache in interface Update<T>

isNotifyCache

public boolean isNotifyCache()

Return true if the cache should be notified so that invalidates appropriate objects.

Specified by:

isNotifyCache in interface SpiUpdate<T>

getName

public String getName()

Specified by:

getName in interface Update<T>

setLabel

public Update<T> setLabel(String label)

Specified by:

setLabel in interface Update<T>

label

public String label()

Description copied from interface: SpiUpdate

Return the label (for metrics collection).

Specified by:

label in interface SpiUpdate<T>

updateStatement

public String updateStatement()

Description copied from interface: SpiUpdate

Return the update statement. This could be either sql or an orm update with bean types and property names.

Specified by:

updateStatement in interface SpiUpdate<T>

set

public DefaultOrmUpdate<T> set(int position,
 Object value)

Specified by:

set in interface Update<T>

setParameter

public DefaultOrmUpdate<T> setParameter(int position,
 Object value)

Specified by:

setParameter in interface Update<T>

setNull

public DefaultOrmUpdate<T> setNull(int position,
 int jdbcType)

Specified by:

setNull in interface Update<T>

setNullParameter

public DefaultOrmUpdate<T> setNullParameter(int position,
 int jdbcType)

Specified by:

setNullParameter in interface Update<T>

set

public DefaultOrmUpdate<T> set(String name,
 Object value)

Specified by:

set in interface Update<T>

setParameter

public DefaultOrmUpdate<T> setParameter(String name,
 Object param)

Specified by:

setParameter in interface Update<T>

setNull

public DefaultOrmUpdate<T> setNull(String name,
 int jdbcType)

Specified by:

setNull in interface Update<T>

setNullParameter

public DefaultOrmUpdate<T> setNullParameter(String name,
 int jdbcType)

Specified by:

setNullParameter in interface Update<T>

bindParams

public BindParams bindParams()

Return the bind parameters.

Specified by:

bindParams in interface SpiUpdate<T>

getGeneratedSql

public String getGeneratedSql()

Specified by:

getGeneratedSql in interface Update<T>

setGeneratedSql

public void setGeneratedSql(String generatedSql)

Description copied from interface: SpiUpdate

Set the generated sql used.

Specified by:

setGeneratedSql in interface SpiUpdate<T>

baseTable

public String baseTable()

Description copied from interface: SpiUpdate

Return the name of the table being modified.

Specified by:

baseTable in interface SpiUpdate<T>

ormUpdateType

public SpiUpdate.OrmUpdateType ormUpdateType()

Description copied from interface: SpiUpdate

Return the type of this - insert, update or delete.

Specified by:

ormUpdateType in interface SpiUpdate<T>