com.avaje.ebeaninternal.server.persist.dml

Class DmlHandler

java.lang.Object

com.avaje.ebeaninternal.server.persist.dml.DmlHandler

All Implemented Interfaces:

PersistHandler, BindableRequest

Direct Known Subclasses:

DeleteHandler, InsertHandler, UpdateHandler

public abstract class DmlHandler
extends Object
implements PersistHandler, BindableRequest

Base class for Handler implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected StringBuilder	bindLog
protected DataBind	dataBind The PreparedStatement used for the dml.
protected boolean	emptyStringToNull
protected Set<String>	loadedProps
protected boolean	logLevelSql
protected PersistRequestBean<?>	persistRequest The originating request.
protected String	sql
protected SpiTransaction	transaction
protected ArrayList<com.avaje.ebeaninternal.server.persist.dml.DmlHandler.UpdateGenValue>	updateGenValues

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DmlHandler(PersistRequestBean<?> persistRequest, boolean emptyStringToNull)

Method Summary

Methods

Modifier and Type	Method and Description
void	addBatch() Add this for batch execution.
abstract void	bind() Get the sql and bind the statement.
Object	bind(Object value, BeanProperty prop, String propName, boolean bindNull) Bind the value to the preparedStatement.
Object	bind(String propName, Object value, int sqlType) Bind a raw value.
Object	bindNoLog(Object value, BeanProperty prop, String propName, boolean bindNull) Bind the value to the preparedStatement without logging.
Object	bindNoLog(Object value, int sqlType, String logPlaceHolder) Bind a raw value with a placeHolder to put into the transaction log.
protected void	checkRowCount(int rowCount) Check the rowCount.
void	close() Close the underlying statement.
abstract void	execute() Execute now for non-batch execution.
String	getBindLog() Return the bind log.
PersistRequestBean<?>	getPersistRequest() Return the original PersistRequest.
protected PreparedStatement	getPstmt(SpiTransaction t, String sql, boolean genKeys) Check with useGeneratedKeys to get appropriate PreparedStatement.
protected PreparedStatement	getPstmt(SpiTransaction t, String sql, PersistRequestBean<?> request, boolean genKeys) Return a prepared statement taking into account batch requirements.
boolean	isIncluded(BeanProperty prop) Return true if the property is included in this request.
boolean	isIncludedWhere(BeanProperty prop) Return true if the property is included in the WHERE clause for this request.
protected void	logSql(String sql) Log the sql to the transaction log.
void	registerAdditionalProperty(String propertyName) For generated properties set on insert register as additional loaded properties if required.
void	registerUpdateGenValue(BeanProperty prop, Object bean, Object value) Register a generated value on a update.
protected void	setAdditionalProperties() Set any additional (generated) properties to the set of loaded properties if required.
void	setIdValue(Object idValue) Set the Id value that was bound.
void	setUpdateGenValues() Set any update generated values to the bean.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.avaje.ebeaninternal.server.persist.dmlbind.BindableRequest

registerDerivedRelationship

Field Detail

persistRequest

protected final PersistRequestBean<?> persistRequest

The originating request.

bindLog

protected final StringBuilder bindLog

loadedProps

protected final Set<String> loadedProps

transaction

protected final SpiTransaction transaction

emptyStringToNull

protected final boolean emptyStringToNull

logLevelSql

protected final boolean logLevelSql

dataBind

protected DataBind dataBind

The PreparedStatement used for the dml.

sql

protected String sql

updateGenValues

protected ArrayList<com.avaje.ebeaninternal.server.persist.dml.DmlHandler.UpdateGenValue> updateGenValues

Constructor Detail

DmlHandler

protected DmlHandler(PersistRequestBean<?> persistRequest,
          boolean emptyStringToNull)

Method Detail

getPersistRequest

public PersistRequestBean<?> getPersistRequest()

Description copied from interface: BindableRequest

Return the original PersistRequest.

Specified by:

getPersistRequest in interface BindableRequest

bind

public abstract void bind()
                   throws SQLException

Get the sql and bind the statement.

Specified by:

bind in interface PersistHandler

Throws:

SQLException

execute

public abstract void execute()
                      throws SQLException

Execute now for non-batch execution.

Specified by:

execute in interface PersistHandler

Throws:

SQLException

checkRowCount

protected void checkRowCount(int rowCount)
                      throws SQLException,
                             javax.persistence.OptimisticLockException

Check the rowCount.

Throws:

SQLException

javax.persistence.OptimisticLockException

addBatch

public void addBatch()
              throws SQLException

Add this for batch execution.

Specified by:

addBatch in interface PersistHandler

Throws:

SQLException

close

public void close()

Close the underlying statement.

Specified by:

close in interface PersistHandler

getBindLog

public String getBindLog()

Return the bind log.

Specified by:

getBindLog in interface PersistHandler

setIdValue

public void setIdValue(Object idValue)

Set the Id value that was bound. This value is used for logging summary level information.

Specified by:

setIdValue in interface BindableRequest

logSql

protected void logSql(String sql)

Log the sql to the transaction log.

isIncluded

public boolean isIncluded(BeanProperty prop)

Description copied from interface: BindableRequest

Return true if the property is included in this request.

Specified by:

isIncluded in interface BindableRequest

isIncludedWhere

public boolean isIncludedWhere(BeanProperty prop)

Description copied from interface: BindableRequest

Return true if the property is included in the WHERE clause for this request.

Specified by:

isIncludedWhere in interface BindableRequest

bind

public Object bind(String propName,
          Object value,
          int sqlType)
            throws SQLException

Bind a raw value. Used to bind the discriminator column.

Specified by:

bind in interface BindableRequest

Throws:

SQLException

bindNoLog

public Object bindNoLog(Object value,
               int sqlType,
               String logPlaceHolder)
                 throws SQLException

Description copied from interface: BindableRequest

Bind a raw value with a placeHolder to put into the transaction log.

Specified by:

bindNoLog in interface BindableRequest

Throws:

SQLException

bind

public Object bind(Object value,
          BeanProperty prop,
          String propName,
          boolean bindNull)
            throws SQLException

Bind the value to the preparedStatement.

Specified by:

bind in interface BindableRequest

Parameters:

value - the value of a property

bindNull - if true bind null values, if false use IS NULL.

Throws:

SQLException

bindNoLog

public Object bindNoLog(Object value,
               BeanProperty prop,
               String propName,
               boolean bindNull)
                 throws SQLException

Bind the value to the preparedStatement without logging.

Specified by:

bindNoLog in interface BindableRequest

Throws:

SQLException

registerAdditionalProperty

public final void registerAdditionalProperty(String propertyName)

For generated properties set on insert register as additional loaded properties if required.

Specified by:

registerAdditionalProperty in interface BindableRequest

setAdditionalProperties

protected void setAdditionalProperties()

Set any additional (generated) properties to the set of loaded properties if required.

registerUpdateGenValue

public void registerUpdateGenValue(BeanProperty prop,
                          Object bean,
                          Object value)

Register a generated value on a update. This can not be set to the bean until after the where clause has been bound for concurrency checking.

GeneratedProperty values are likely going to be used for optimistic concurrency checking. This includes 'counter' and 'update timestamp' generation.

Specified by:

registerUpdateGenValue in interface BindableRequest

setUpdateGenValues

public void setUpdateGenValues()

Set any update generated values to the bean. Must be called after where clause has been bound.

getPstmt

protected PreparedStatement getPstmt(SpiTransaction t,
                         String sql,
                         boolean genKeys)
                              throws SQLException

Check with useGeneratedKeys to get appropriate PreparedStatement.

Throws:

SQLException

getPstmt

protected PreparedStatement getPstmt(SpiTransaction t,
                         String sql,
                         PersistRequestBean<?> request,
                         boolean genKeys)
                              throws SQLException

Return a prepared statement taking into account batch requirements.

Throws:

SQLException