CascadeOperation (sormula)

java.lang.Object
- org.sormula.operation.cascade.CascadeOperation<S,T>

Type Parameters:

S - row class of table that is source of cascade

T - row class of table that is target of cascade

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

ModifyCascadeOperation, SelectCascadeOperation
```
public abstract class CascadeOperation<S,T>
extends java.lang.Object
implements java.lang.AutoCloseable
```
Base class for all cascade operations.

Author:

Jeff Miller

Constructor Summary

Constructors
Constructor and Description
`CascadeOperation(SqlOperation<S> sourceOperation, RowField<S,?> targetField, Table<T> targetTable, java.lang.Class<?> cascadeSqlOperationClass)` Constructs from source operation and targets of the cascade.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cascade(S sourceRow)` Performs cascade operation.
`abstract void`	`close()` Cleans up by closing any JDBC resources.
`protected SqlOperation<?>`	`createOperation()` Creates new instance of sql operation from `cascadeSqlOperationClass` supplied in the constructor.
`protected void`	`deriveSqlOperationAttributes()` Sets the sql operation attributes that are the same as source attributes for all levels.
`int`	`getDepth()` Gets the depth of the cascade graph relative to the root cascade operation.
`java.lang.String`	`getForeignKeyReferenceFieldName()` Gets the name of the foreign key reference field in the target (child) rows.
`java.lang.String[]`	`getForeignKeyValueFieldNames()` Gets the field key value field names in target (child) rows.
`int`	`getKeyFieldCount()` Gets number of key fields.
`java.util.Map<java.lang.String,java.lang.Object>`	`getNamedParameterMap()` Gets the map of named parameters.
`java.lang.String[]`	`getRequiredCascades()` Returns source operation `SqlOperation.getRequiredCascades()`.
`SqlOperation<S>`	`getSourceOperation()` Gets operation that triggered this cascade.
`S`	`getSourceRow()` Source row of cascade set by `cascade(Object)`.
`Table<S>`	`getSourceTable()` Gets `Table` that originates (is source of) cascade.
`RowField<S,?>`	`getTargetField()` Gets target field as `RowField`.
`protected java.util.List<RowField<T,java.lang.Object>>`	`getTargetForeignKeyValueFieldList()`
`Table<T>`	`getTargetTable()`
`boolean`	`isPost()`
`void`	`prepare()` Prepares operation by initializing JDBC statements.
`protected void`	`prepareForeignKeyReferenceField()` Prepares accessor that will set foreign key reference on cascaded target rows as defined by `Cascade.foreignKeyReferenceField()`.
`protected void`	`prepareForeignKeyValueFields()` Prepares accessors that will set foreign key(s) on cascaded target rows as defined by `Cascade.foreignKeyValueFields()`.
`void`	`setForeignKeyFieldNames(java.lang.String[] foreignKeyFieldNames)` Sets the name of fields that contain the foreign key values in target (child) rows.
`protected void`	`setForeignKeyReference(java.util.Collection<T> rows)` Sets the foreign key reference in target (child) rows as source (parent) row.
`protected void`	`setForeignKeyReference(T row)` Sets the foreign key reference in target (child) row as source (parent) row.
`void`	`setForeignKeyReferenceFieldName(java.lang.String foreignKeyReferenceFieldName)` Sets the field name that contains a reference to the foreign key object in target (child) rows.
`protected void`	`setForeignKeyValues(java.util.Collection<T> rows)` Sets the foreign key(s) in target (child) rows from primary key(s) in source (parent) row.
`protected void`	`setForeignKeyValues(T row)` Sets the foreign key(s) in target (child) row from primary key(s) in source (parent) row.
`void`	`setPost(boolean post)` Sets when to perform the cascade.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CascadeOperation
```
public CascadeOperation(SqlOperation<S> sourceOperation,
                        RowField<S,?> targetField,
                        Table<T> targetTable,
                        java.lang.Class<?> cascadeSqlOperationClass)
```
    Constructs from source operation and targets of the cascade.
    
    Parameters:
    
    sourceOperation - operation where cascade originates
    
    targetField - in source row to be affected by cascade operation
    
    targetTable - sormula table that will be cascaded
    
    cascadeSqlOperationClass - class of cascade operation (used to create new instance) is to be performed before source row operation
    
    Since:
    
    4.1
- Method Detail
  - setPost
```
public void setPost(boolean post)
```
    Sets when to perform the cascade.
    
    Parameters:
    
    post - true if cascade is to be performed after select/execute; false if cascade is to be performed before select/execute
    
    Since:
    
    3.0
  - isPost
```
public boolean isPost()
```
    Returns:
    
    true if cascade is to be performed after select/execute; false if cascade is to be performed before select/execute
  - getDepth
```
public int getDepth()
```
    Gets the depth of the cascade graph relative to the root cascade operation. Root cascade operation is depth 0.
    
    Returns:
    
    depth of this cascade
    
    Since:
    
    4.1
  - getForeignKeyValueFieldNames
```
public java.lang.String[] getForeignKeyValueFieldNames()
```
    Gets the field key value field names in target (child) rows.
    
    Returns:
    
    target (child) row foreign key fields; null means don't update foreign key values
    
    Since:
    
    3.1
  - setForeignKeyFieldNames
```
public void setForeignKeyFieldNames(java.lang.String[] foreignKeyFieldNames)
```
    Sets the name of fields that contain the foreign key values in target (child) rows. If length of array parameter is zero, then null is used so that null means that no foreign key fields are defined.
    
    Parameters:
    
    foreignKeyFieldNames - field names from cascade annotation foreignKeyValueFields
    
    Since:
    
    3.0
    
    See Also:
    
    Cascade.foreignKeyValueFields(), OneToManyCascade.foreignKeyValueFields(), OneToOneCascade.foreignKeyValueFields()
  - getForeignKeyReferenceFieldName
```
public java.lang.String getForeignKeyReferenceFieldName()
```
    Gets the name of the foreign key reference field in the target (child) rows.
    
    Returns:
    
    name; null means don't set reference
    
    Since:
    
    3.0
  - setForeignKeyReferenceFieldName
```
public void setForeignKeyReferenceFieldName(java.lang.String foreignKeyReferenceFieldName)
```
    Sets the field name that contains a reference to the foreign key object in target (child) rows. If length of parameter is zero, then null is used so that null means that no foreign key reference field is defined.
    
    Parameters:
    
    foreignKeyReferenceFieldName - field name of foreign key reference from cascade annotation foreignKeyReferenceField
    
    Since:
    
    3.0
    
    See Also:
    
    Cascade.foreignKeyReferenceField(), OneToManyCascade.foreignKeyReferenceField(), OneToOneCascade.foreignKeyReferenceField()
  - getRequiredCascades
```
public java.lang.String[] getRequiredCascades()
```
    Returns source operation SqlOperation.getRequiredCascades().
    
    Returns:
    
    names of cascades that will be executed
    
    Since:
    
    3.0
  - getKeyFieldCount
```
public int getKeyFieldCount()
```
    Gets number of key fields. The number of key fields is the number of primary key fields in the source row which is also the same as the number of foreign key fields in target row.
    
    Returns:
    
    count of key fields used in foreign key mapping; zero if no foreign key mapping
    
    Since:
    
    3.0
  - getNamedParameterMap
```
public java.util.Map<java.lang.String,java.lang.Object> getNamedParameterMap()
```
    Gets the map of named parameters.
    
    Returns:
    
    map of name to value or null if no named parameters
    
    Since:
    
    3.1
    
    See Also:
    
    SqlOperation.getParameter(String), SqlOperation.setParameter(String, Object), SqlOperation.getNamedParameterMap()
  - cascade
```
public void cascade(S sourceRow)
             throws OperationException
```
    Performs cascade operation. Retains value of source row parameter. Subclasses should invoke super.cascade() and then implement their specific behavior.
    
    Parameters:
    
    sourceRow - row in parent table that was source the cascade
    
    Throws:
    
    OperationException - if error
  - prepare
```
public void prepare()
             throws OperationException
```
    Prepares operation by initializing JDBC statements. This method prepares foreign key mapping with prepareForeignKeyValueFields(). Subclasses should override to perform additional preparation.
    
    Throws:
    
    OperationException - if error
  - close
```
public abstract void close()
                    throws OperationException
```
    Cleans up by closing any JDBC resources.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    OperationException - if error
  - getSourceOperation
```
public SqlOperation<S> getSourceOperation()
```
    Gets operation that triggered this cascade.
    
    Returns:
    
    source operation
    
    Since:
    
    4.1
  - getSourceTable
```
public Table<S> getSourceTable()
```
    Gets Table that originates (is source of) cascade.
    
    Returns:
    
    parent (source) table of cascade
    
    Since:
    
    3.0
  - getTargetField
```
public RowField<S,?> getTargetField()
```
    Gets target field as RowField.
    
    Returns:
    
    field in source row to be affected by cascade operation
  - getTargetTable
```
public Table<T> getTargetTable()
```
    Returns:
    
    table to be used in cascade
  - getSourceRow
```
public S getSourceRow()
```
    Source row of cascade set by cascade(Object).
    
    Returns:
    
    row where cascade originates
    
    Since:
    
    3.0
  - createOperation
```
protected SqlOperation<?> createOperation()
                                   throws OperationException
```
    Creates new instance of sql operation from cascadeSqlOperationClass supplied in the constructor.
    
    Returns:
    
    new instance of SqlOperation that will be used for cascade
    
    Throws:
    
    OperationException - if error
  - deriveSqlOperationAttributes
```
protected void deriveSqlOperationAttributes()
```
    Sets the sql operation attributes that are the same as source attributes for all levels. Cascade depth is also set as 1 + source depth.
    
    Since:
    
    4.1
  - prepareForeignKeyValueFields
```
protected void prepareForeignKeyValueFields()
                                     throws OperationException
```
    Prepares accessors that will set foreign key(s) on cascaded target rows as defined by Cascade.foreignKeyValueFields().
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    3.0
  - prepareForeignKeyReferenceField
```
protected void prepareForeignKeyReferenceField()
                                        throws OperationException
```
    Prepares accessor that will set foreign key reference on cascaded target rows as defined by Cascade.foreignKeyReferenceField().
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    3.0
  - setForeignKeyValues
```
protected void setForeignKeyValues(T row)
                            throws OperationException
```
    Sets the foreign key(s) in target (child) row from primary key(s) in source (parent) row.
    
    Parameters:
    
    row - target (child) row to affect
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    3.0
  - setForeignKeyValues
```
protected void setForeignKeyValues(java.util.Collection<T> rows)
                            throws OperationException
```
    Sets the foreign key(s) in target (child) rows from primary key(s) in source (parent) row.
    
    Parameters:
    
    rows - target (child) rows to affect
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    3.0
  - setForeignKeyReference
```
protected void setForeignKeyReference(T row)
                               throws OperationException
```
    Sets the foreign key reference in target (child) row as source (parent) row.
    
    Parameters:
    
    row - target (child) row to affect
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    3.0
  - setForeignKeyReference
```
protected void setForeignKeyReference(java.util.Collection<T> rows)
                               throws OperationException
```
    Sets the foreign key reference in target (child) rows as source (parent) row.
    
    Parameters:
    
    rows - target (child) rows to affect
    
    Throws:
    
    OperationException - if error
    
    Since:
    
    3.0
  - getTargetForeignKeyValueFieldList
```
protected java.util.List<RowField<T,java.lang.Object>> getTargetForeignKeyValueFieldList()
```
    Returns:
    
    list of foreign key fields or null if none
    
    Since:
    
    3.1

Class CascadeOperation<S,T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CascadeOperation

Method Detail

setPost

isPost

getDepth

getForeignKeyValueFieldNames

setForeignKeyFieldNames

getForeignKeyReferenceFieldName

setForeignKeyReferenceFieldName

getRequiredCascades

getKeyFieldCount

getNamedParameterMap

cascade

prepare

close

getSourceOperation

getSourceTable

getTargetField

getTargetTable

getSourceRow

createOperation

deriveSqlOperationAttributes

prepareForeignKeyValueFields

prepareForeignKeyReferenceField

setForeignKeyValues

setForeignKeyValues

setForeignKeyReference

setForeignKeyReference

getTargetForeignKeyValueFieldList