ModifyOperation (sormula)

java.lang.Object
- org.sormula.operation.SqlOperation<R>
- - org.sormula.operation.ModifyOperation<R>

Type Parameters:

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

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

DeleteOperation, InsertOperation, SaveOperation, UpdateOperation
```
public abstract class ModifyOperation<R>
extends SqlOperation<R>
```
Base class for operations that modify database.

Since:

1.0

Author:

Jeff Miller

Constructor Summary

Constructors
Constructor and Description

ModifyOperation(Table<R> table)
Constructs for a table.

Constructors
Constructor and Description
`ModifyOperation(Table<R> table)` Constructs for a table.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Cleans up after operation is no longer needed.
`void`	`execute()` Executes operation for all row parameters using current prepared statement.
`int[]`	`getModifyCounts()` Gets the number of rows that were modified.
`java.util.Collection<R>`	`getRows()` Gets the rows that will be modified.
`int`	`getRowsAffected()` Gets the number of rows affected from most recent invocation of `execute()`.
`boolean`	`isBatch()` Gets batch mode.
`int`	`modify(java.lang.Object... parameters)` Modifies row(s) with sql parameters as Objects.
`int`	`modify(R row)` Modifies one row.
`int`	`modifyAll(java.util.Collection<R> rows)` Modifies a collection of rows.
`protected abstract void`	`notifyCacheModified(R row)` Delegates to `Cache.inserted(Object)`, `Cache.updated(Object)`, `Cache.deleted(Object)` based upon the subclass operation.
`protected abstract boolean`	`notifyCacheModify(R row)` Delegates to `Cache.insert(Object)`, `Cache.update(Object)`, `Cache.delete(Object)` based upon the subclass operation.
`protected void`	`postExecute(R row)` Invoked after JDBC execute.
`protected void`	`postExecuteCascade(R row)` Invoked after JDBC execute.
`protected void`	`preExecute(R row)` Invoked prior to JDBC execute.
`protected void`	`preExecuteCascade(R row)` Invoked prior to JDBC execute.
`void`	`setBatch(boolean batch)` Sets batch mode.
`void`	`setParameters(java.lang.Object... parameters)` Allows modification of table data using objects instead from row objects.
`void`	`setRow(R row)` Sets parameters from a row object.
`void`	`setRows(java.util.Collection<R> rows)` Sets parameters from rows in a collection.
`void`	`setRows(java.util.Map<?,R> rows)` Sets parameters from rows in a map.
`void`	`setRows(R[] rows)` Sets parameters from rows in an array.
`protected void`	`setRowsAffected(int rowsAffected)`

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, prepareCascades, prepareCheck, prepareStatement, 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
  - ModifyOperation
```
public ModifyOperation(Table<R> table)
                throws OperationException
```
    Constructs for a table.
    
    Parameters:
    
    table - modify this table
    
    Throws:
    
    OperationException - if error
- Method Detail
  - setRow
```
public void setRow(R row)
```
    Sets parameters from a row object. For operations that affect one row. Use this as alternative to setParameters(Object...).
    
    Parameters:
    
    row - get parameter values from this row object
  - setRows
```
public void setRows(R[] rows)
```
    Sets parameters from rows in an array. For operations that use array of rows.
    
    Parameters:
    
    rows - row objects to modify
    
    Since:
    
    1.9 and 2.3
  - setRows
```
public void setRows(java.util.Collection<R> rows)
```
    Sets parameters from rows in a collection. For operations that use Collection of rows.
    
    Parameters:
    
    rows - row objects to modify
  - setRows
```
public void setRows(java.util.Map<?,R> rows)
```
    Sets parameters from rows in a map. For operations that use Map of rows.
    
    Parameters:
    
    rows - row objects to modify
  - getRows
```
public java.util.Collection<R> getRows()
```
    Gets the rows that will be modified. All of the setter methods for setting rows convert parameters to Collection so this method will get the row(s) regardless of setter method that was used.
    
    Returns:
    
    rows to be modified or null if setParameters(Object...) was used
    
    Since:
    
    3.0
  - setParameters
```
public void setParameters(java.lang.Object... parameters)
```
    Allows modification of table data using objects instead from row objects. This method is not recommended for updates or inserts but may be useful for delete when no row object is available. Use setRow(Object), setRows(Collection), or setRows(Map) instead. preExecute(Object) and postExecute(Object) will not be invoked if this method is used.
    
    Overrides:
    
    setParameters in class SqlOperation<R>
    
    Parameters:
    
    parameters - values to set in PreparedStatement for modify operation
  - isBatch
```
public boolean isBatch()
```
    Gets batch mode.
    
    Returns:
    
    true if rows are to be inserted/updated/deleted in batch mode
    
    Since:
    
    1.9 and 2.3
    
    See Also:
    
    Statement.executeBatch()
  - setBatch
```
public void setBatch(boolean batch)
```
    Sets batch mode. Set to true prior to 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. preExecute(Object) is invoked prior to batch add and 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.
    
    Parameters:
    
    batch - true to use JDBC batching for execute()
    
    Since:
    
    1.9 and 2.3
    
    See Also:
    
    Statement.executeBatch()
  - execute
```
public void execute()
             throws OperationException
```
    Executes operation for all row parameters using current prepared statement. getRowsAffected() will return the sum of all rows affected.
    
    Specified by:
    
    execute in class SqlOperation<R>
    
    Throws:
    
    OperationException - if error
    
    BatchException - for batch operations if EXECUTE_FAILED is returned
    
    BatchException - for batch operations if SUCCESS_NO_INFO is returned and cascading is needed
    
    ReadOnlyException - if row or table is read only
  - close
```
public void close()
           throws OperationException
```
    Cleans up after operation is no longer needed. The connection is not closed but all other objects created by this operations are closed. Prepared statement is closed and close method is invoked on all CascadeOperation objects. This method should be invoked when operation is no longer needed for proper JDBC clean up.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class SqlOperation<R>
    
    Throws:
    
    OperationException - if error
  - getRowsAffected
```
public int getRowsAffected()
```
    Gets the number of rows affected from most recent invocation of execute().
    
    Returns:
    
    count of rows affect by most recent execute()
  - getModifyCounts
```
public int[] getModifyCounts()
```
    Gets the number of rows that were modified. The size of the array will be the size of getRows() if not null or 1 if SqlOperation.getParameters() is not null. The value of each array element is determined by one of the following:
    - return of PreparedStatement.executeUpdate() for each row in getRows()
    - return of Statement.executeBatch() if isBatch() is true
    - return of PreparedStatement.executeUpdate() if SqlOperation.getParameters() is not null
    Returns:
    
    array of counts of rows that were modified; for batch operations some values may be Statement.SUCCESS_NO_INFO for some databases
    
    Since:
    
    4.1
  - modify
```
public int modify(R row)
           throws OperationException
```
    Modifies one row. Set parameters, executes, closes.
    Since this class implements AutoCloseable, you may see resource leak sing when you use this method. You can ignore it, add a suppress annotation, explicitly close, or close with a try-with-resources statement. Closing an operation more than once will not cause problems since the close methods are idempotent.
    
    Parameters:
    
    row - row to use for parameters
    
    Returns:
    
    getRowsAffected()
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    1.4
  - modifyAll
```
public int modifyAll(java.util.Collection<R> rows)
              throws OperationException
```
    Modifies a collection of rows. Set parameters, executes, closes.
    Since this class implements AutoCloseable, you may see resource leak warning when you use this method. You can ignore it, add a suppress annotation, explicitly close, or close with a try-with-resources statement. Closing an operation more than once will not cause problems since the close methods are idempotent.
    
    Parameters:
    
    rows - collection of rows to use as parameters
    
    Returns:
    
    getRowsAffected()
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    1.4
  - modify
```
public int modify(java.lang.Object... parameters)
           throws OperationException
```
    Modifies row(s) with sql parameters as Objects. Executes and then closes.
    Since this class implements AutoCloseable, you may see resource leak warning when you use this method. You can ignore it, add a suppress annotation, explicitly close, or close with a try-with-resources statement. Closing an operation more than once will not cause problems since the close methods are idempotent.
    
    Parameters:
    
    parameters - operation parameters as objects (see setParameters(Object...))
    
    Returns:
    
    count of rows affected
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    1.4
  - preExecute
```
protected void preExecute(R row)
                   throws OperationException
```
    Invoked prior to JDBC execute. Override to modify the row prior to JDBC execute. Default implementation does nothing. This method is not invoked when setParameters(Object...) is used since no row is available.
    
    Parameters:
    
    row - row for JDBC execute
    
    Throws:
    
    OperationException - if error
  - postExecute
```
protected void postExecute(R row)
                    throws OperationException
```
    Invoked after JDBC execute. Override to modify the row after JDBC execute has occurred. Default implementation does nothing. This method is not invoked when setParameters(Object...) is used since no row is available.
    
    Parameters:
    
    row - row for JDBC execute
    
    Throws:
    
    OperationException - if error
  - preExecuteCascade
```
protected void preExecuteCascade(R row)
                          throws OperationException
```
    Invoked prior to JDBC execute. Performs all modify cascade operations where post flag is false.
    
    Parameters:
    
    row - row for JDBC execute
    
    Throws:
    
    OperationException - if error
    
    See Also:
    
    InsertCascade.post(), UpdateCascade.post(), SaveCascade.post(), DeleteCascade.post()
  - postExecuteCascade
```
protected void postExecuteCascade(R row)
                           throws OperationException
```
    Invoked after JDBC execute. Performs all modify cascade operations where post flag is true.
    
    Parameters:
    
    row - row for JDBC execute
    
    Throws:
    
    OperationException - if error
    
    See Also:
    
    InsertCascade.post(), UpdateCascade.post(), SaveCascade.post(), DeleteCascade.post()
  - setRowsAffected
```
protected void setRowsAffected(int rowsAffected)
```
  - notifyCacheModify
```
protected abstract boolean notifyCacheModify(R row)
                                      throws OperationException
```
    Delegates to Cache.insert(Object), Cache.update(Object), Cache.delete(Object) based upon the subclass operation.
    
    Parameters:
    
    row - row to be modified
    
    Returns:
    
    true if cache is authority for row (cache will modify row in database); false if cache does not modify the database
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    3.0
  - notifyCacheModified
```
protected abstract void notifyCacheModified(R row)
                                     throws OperationException
```
    Delegates to Cache.inserted(Object), Cache.updated(Object), Cache.deleted(Object) based upon the subclass operation.
    
    Parameters:
    
    row - that was modified in database
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    3.0

Class ModifyOperation<R>

Constructor Summary

Method Summary

Methods inherited from class org.sormula.operation.SqlOperation

Methods inherited from class java.lang.Object

Constructor Detail

ModifyOperation

Method Detail

setRow

setRows

setRows

setRows

getRows

setParameters

isBatch

setBatch

execute

close

getRowsAffected

getModifyCounts

modify

modifyAll

modify

preExecute

postExecute

preExecuteCascade

postExecuteCascade

setRowsAffected

notifyCacheModify

notifyCacheModified