org.sormula.operation

Class DeleteOperation<R>

java.lang.Object

org.sormula.operation.SqlOperation<R>

org.sormula.operation.ModifyOperation<R>

org.sormula.operation.DeleteOperation<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 DeleteOperation<R>
extends ModifyOperation<R>

SQL delete operation for row of type R.

Since:

1.0

Author:

Jeff Miller

Constructor Summary

Constructors

Constructor and Description
DeleteOperation(Table<R> table) Constructs standard sql delete for primary key as: DELETE FROM table WHERE primary key clause
DeleteOperation(Table<R> table, java.lang.String whereConditionName) Constructs for standard sql delete statement as: DELETE FROM table WHERE ...

Method Summary

Modifier and Type	Method and Description
int	delete(java.lang.Object... parameters) Deletes rows based upon parameters.
int	delete(R row) Deletes a row.
int	deleteAll(java.util.Collection<R> rows) Deletes all rows in collection.
protected void	initBaseSql() Sets base sql with SqlOperation.setBaseSql(String).
void	notifyCacheModified(R row) Notifies cache that row has been deleted from database.
protected boolean	notifyCacheModify(R row) Tests if row is managed by cache.
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 void	writeColumns(R row) Does nothing since delete statements have no columns.

Methods inherited from class org.sormula.operation.ModifyOperation

close, execute, getModifyCounts, getRows, getRowsAffected, isBatch, modify, modify, modifyAll, postExecute, postExecuteCascade, preExecute, preExecuteCascade, setBatch, 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, prepareStatement, setBaseSql, setCached, setCascade, setCascadeDepth, setCustomSql, setIncludeIdentityColumns, setNamedParameterMap, setNextParameter, setParameter, setQueryTimeout, setReadOnly, setRequiredCascades, setTimingId, setTimings, setWhere, setWhereTranslator, writeParameter, writeParameters, writeWhere

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteOperation

public DeleteOperation(Table<R> table)
                throws OperationException

Constructs standard sql delete for primary key as:
DELETE FROM table WHERE primary key clause

Parameters:

table - delete from this table

Throws:

OperationException - if error

DeleteOperation

public DeleteOperation(Table<R> table,
                       java.lang.String whereConditionName)
                throws OperationException

Constructs for standard sql delete statement as:
DELETE FROM table WHERE ...

Parameters:

table - delete from this table

whereConditionName - name of where condition to use ("primaryKey" to delete by primary key; empty string to delete all rows in table)

Throws:

OperationException - if error

Method Detail

delete

public int delete(R row)
           throws OperationException

Deletes 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

deleteAll

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

Deletes 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

delete

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

Deletes 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

writeColumns

protected void writeColumns(R row)
                     throws OperationException

Does nothing since delete statements have no columns.

Overrides:

writeColumns in class SqlOperation<R>

Parameters:

row - get column values from this row

Throws:

OperationException - if error

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

notifyCacheModify

protected boolean notifyCacheModify(R row)
                             throws OperationException

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

Specified by:

notifyCacheModify in class ModifyOperation<R>

Parameters:

row - test this row

Returns:

true if cache will delete the row from database when appropriate; false if this operation should delete row from 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 deleted from database. Delegates to Cache.deleted(Object).

Specified by:

notifyCacheModified in class ModifyOperation<R>

Parameters:

row - row that was deleted

Throws:

OperationException - if cache reports an error

Since:

3.0