org.sormula.operation

Class InsertOperation<R>

java.lang.Object

org.sormula.operation.SqlOperation<R>

org.sormula.operation.ModifyOperation<R>

org.sormula.operation.InsertOperation<R>

Type Parameters:

R - class type which contains members for columns of a row in a table

All Implemented Interfaces:

java.lang.AutoCloseable

public class InsertOperation<R>
extends ModifyOperation<R>

SQL insert operation for row of type R.

Since:

1.0

Author:

Jeff Miller

Constructor Summary

Constructors

Constructor and Description
InsertOperation(Table<R> table) Constructs for standard sql insert statement as: INSERT INTO table (c1, c2, c3, ...) VALUES (?, ?, ?, ...)
InsertOperation(Table<R> table, boolean identity) Constructs for optional identity column.

Method Summary

Modifier and Type	Method and Description
protected void	initBaseSql() Sets base sql with SqlOperation.setBaseSql(String).
int	insert(java.lang.Object... parameters) Inserts rows based upon parameters.
int	insert(R row) Inserts a row.
int	insertAll(java.util.Collection<R> rows) Inserts all rows in collection.
boolean	isAutoGeneratedKeys() If true, Statement.getGeneratedKeys() is used to read column defined as identity and then sets the generated key value in the row.
void	notifyCacheModified(R row) Notifies cache that row has been inserted into database.
protected boolean	notifyCacheModify(R row) Tests if row is managed by cache.
protected void	postExecute(R row) Updates identity column with generated key if isAutoGeneratedKeys() is true.
protected java.util.List<CascadeOperation<R,?>>	prepareCascades(java.lang.reflect.Field field) Creates and prepares cascade operations based upon cascade annotations for a field.
protected java.sql.PreparedStatement	prepareStatement() Creates the prepared statement.
protected void	processIdentityColumn(R row) Reads the generated key using Statement.getGeneratedKeys().
void	setAutoGeneratedKeys(boolean autoGeneratedKeys) Sets when to get generated keys from database.
void	setBatch(boolean batch) Sets batch mode.

Methods inherited from class org.sormula.operation.ModifyOperation

close, execute, getModifyCounts, getRows, getRowsAffected, isBatch, modify, modify, modifyAll, postExecuteCascade, preExecute, preExecuteCascade, setParameters, setRow, setRows, setRows, setRows, setRowsAffected

Methods inherited from class org.sormula.operation.SqlOperation

cancel, cascade, closeCascades, closeStatement, createRowField, getBaseSql, getCascadeDepth, getConnection, getCustomSql, getNamedParameterMap, getNextParameter, getOperationTime, getParameter, getParameters, getPreparedSql, getPreparedStatement, getQueryTimeout, getRequiredCascades, getSql, getTable, getTargetTable, getTimingId, getWhereAnnotation, getWhereConditionName, getWhereTranslator, initOperationTime, isCached, isCascade, isCascading, isIncludeIdentityColumns, isPrimaryKey, isReadOnly, isRequiredCascade, isTimings, logTimings, prepare, prepareCascades, prepareCheck, setBaseSql, setCached, setCascade, setCascadeDepth, setCustomSql, setIncludeIdentityColumns, setNamedParameterMap, setNextParameter, setParameter, setQueryTimeout, setReadOnly, setRequiredCascades, setTimingId, setTimings, setWhere, setWhereTranslator, writeColumns, writeParameter, writeParameters, writeWhere

Methods inherited from class java.lang.Object

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

Constructor Detail

InsertOperation

public InsertOperation(Table<R> table)
                throws OperationException

Constructs for standard sql insert statement as:
INSERT INTO table (c1, c2, c3, ...) VALUES (?, ?, ?, ...)

Parameters:

table - insert into this table

Throws:

OperationException - if error

InsertOperation

public InsertOperation(Table<R> table,
                       boolean identity)
                throws OperationException

Constructs for optional identity column. For rows with identity columns, typically set identity parameter to true for auto generated keys, setAutoGeneratedKeys(boolean). To insert a row with an identity column defined but without generating keys, set identity parameter to false.

Parameters:

table - insert into this table

identity - true to use autogenerated keys for identity columns; false to insert identity columns as without generating key

Throws:

OperationException - if error

Since:

3.0

Method Detail

isAutoGeneratedKeys

public boolean isAutoGeneratedKeys()

If true, Statement.getGeneratedKeys() is used to read column defined as identity and then sets the generated key value in the row. Default is false. Typically true for insert operations.

Returns:

true if identity column is generated by database

See Also:

processIdentityColumn(Object)

setAutoGeneratedKeys

public void setAutoGeneratedKeys(boolean autoGeneratedKeys)

Sets when to get generated keys from database.

Parameters:

autoGeneratedKeys - true if identity column is generated by database

setBatch

public void setBatch(boolean batch)

Sets batch mode. Set to true prior to ModifyOperation.execute() to insert/update/delete rows using JDBC batch mode. Batch mode does not support identity columns. Auto commit must be off for batch mode. ModifyOperation.preExecute(Object) is invoked prior to batch add and ModifyOperation.postExecute(Object) is invoked after batch execute.

Since version 4.1, cascades are performed for batch mode.

Batch modifications are not cached. So when batch is true and table is cached, then table cache is flushed prior to executing batch modifications to avoid inconsistencies in cache. Database.flush() may be required if batched rows affect foreign key relationships. Logs error if batch and isAutoGeneratedKeys() are both true.

Overrides:

setBatch in class ModifyOperation<R>

Parameters:

batch - true to use JDBC batching for ModifyOperation.execute()

Since:

4.3

See Also:

Statement.executeBatch()

insert

public int insert(R row)
           throws OperationException

Inserts a row. Set parameters, executes, closes. Alias for ModifyOperation.modify(Object).

Parameters:

row - row to use for parameters

Returns:

ModifyOperation.getRowsAffected()

Throws:

OperationException - if error

Since:

1.4

insertAll

public int insertAll(java.util.Collection<R> rows)
              throws OperationException

Inserts all rows in collection. Set parameters, executes, closes. Alias for ModifyOperation.modifyAll(Collection).

Parameters:

rows - collection of rows to use as parameters

Returns:

ModifyOperation.getRowsAffected()

Throws:

OperationException - if error

Since:

1.4

insert

public int insert(java.lang.Object... parameters)
           throws OperationException

Inserts rows based upon parameters. Set parameters, executes, closes. Alias for ModifyOperation.modify(Object...).

Parameters:

parameters - operation parameters as objects (see ModifyOperation.setParameters(Object...))

Returns:

count of rows affected

Throws:

OperationException - if error

Since:

1.4

prepareStatement

protected java.sql.PreparedStatement prepareStatement()
                                               throws java.sql.SQLException

Creates the prepared statement. Allows for subclasses to override.

Overrides:

prepareStatement in class SqlOperation<R>

Returns:

prepared statement to use for this operation

Throws:

java.sql.SQLException - if error

Since:

4.3

initBaseSql

protected void initBaseSql()

Sets base sql with SqlOperation.setBaseSql(String).

prepareCascades

protected java.util.List<CascadeOperation<R,?>> prepareCascades(java.lang.reflect.Field field)
                                                         throws OperationException

Creates and prepares cascade operations based upon cascade annotations for a field.

Specified by:

prepareCascades in class SqlOperation<R>

Parameters:

field - annotation is for this field of row class R

Returns:

list of cascade operations; empty list for none

Throws:

OperationException - if error

postExecute

protected void postExecute(R row)
                    throws OperationException

Updates identity column with generated key if isAutoGeneratedKeys() is true.

Overrides:

postExecute in class ModifyOperation<R>

Parameters:

row - row to affect

Throws:

OperationException - if error

processIdentityColumn

protected void processIdentityColumn(R row)
                              throws OperationException

Reads the generated key using Statement.getGeneratedKeys(). The generated key is set in row using the ColumnTranslator from the table for this operation as RowTranslator.getIdentityColumnTranslator().

Parameters:

row - row to affect

Throws:

OperationException - if error

notifyCacheModify

protected boolean notifyCacheModify(R row)
                             throws OperationException

Tests if row is managed by cache. Delegates to Cache.insert(Object).

Specified by:

notifyCacheModify in class ModifyOperation<R>

Parameters:

row - test this row

Returns:

true if cache will insert the row to database when appropriate; false if this operation should insert row into database

Throws:

OperationException - if cache reports an error

Since:

3.0

notifyCacheModified

public void notifyCacheModified(R row)
                         throws OperationException

Notifies cache that row has been inserted into database. Delegates to Cache.inserted(Object).

Specified by:

notifyCacheModified in class ModifyOperation<R>

Parameters:

row - row that was inserted

Throws:

OperationException - if cache reports an error

Since:

3.0