org.sormula.operation.cascade

Class SelectCascadeOperation<S,T>

java.lang.Object

org.sormula.operation.cascade.CascadeOperation<S,T>

org.sormula.operation.cascade.SelectCascadeOperation<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

public class SelectCascadeOperation<S,T>
extends CascadeOperation<S,T>

Cascade that selects rows from target table into target field when source operation initiates a cascade.

Author:

Jeff Miller

Constructor Summary

Constructors

Constructor and Description
SelectCascadeOperation(ScalarSelectOperation<S> sourceOperation, RowField<S,?> targetField, Table<T> targetTable, SelectCascade selectCascadeAnnotation) Constructor used by ScalarSelectOperation.

Method Summary

Modifier and Type	Method and Description
void	cascade(S sourceRow) Performs cascade operation.
void	close() Cleans up by closing any JDBC resources.
protected void	deriveSqlOperationAttributes() Sets the sql operation attributes that are the same as source attributes for all levels.
java.util.Map<java.lang.Class<?>,java.util.function.BiPredicate<?,java.lang.Boolean>>	getFilterPredicateMap() Gets a map of all filters used by this operation and lower level cascades.
boolean	isSourcePrimaryKeyFields()
boolean	isSourceTargetFieldNames()
boolean	isWhereForeignKeyValueFields()
boolean	isWhereSourceFieldNames()
void	prepare() Prepares operation by initializing JDBC statements.
protected void	prepareParameterFields() Uses reflection to get fields for each of the source class variables that will be read from source and set as parameters on cascade operation.
protected void	prepareWhere() Configures the WhereTranslator to use for cascade.
protected void	setParameters(S sourceRow) cascade(S) invokes this method to set parameters in cascade operation based upon parameter fields that were created by prepareParameterFields().
protected T[]	toTargetArray(java.util.Collection<T> c)

Methods inherited from class org.sormula.operation.cascade.CascadeOperation

createOperation, getDepth, getForeignKeyReferenceFieldName, getForeignKeyValueFieldNames, getKeyFieldCount, getNamedParameterMap, getRequiredCascades, getSourceOperation, getSourceRow, getSourceTable, getTargetField, getTargetForeignKeyValueFieldList, getTargetTable, isPost, prepareForeignKeyReferenceField, prepareForeignKeyValueFields, setForeignKeyFieldNames, setForeignKeyReference, setForeignKeyReference, setForeignKeyReferenceFieldName, setForeignKeyValues, setForeignKeyValues, setPost

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectCascadeOperation

public SelectCascadeOperation(ScalarSelectOperation<S> sourceOperation,
                              RowField<S,?> targetField,
                              Table<T> targetTable,
                              SelectCascade selectCascadeAnnotation)

Constructor used by ScalarSelectOperation.

Parameters:

sourceOperation - cascade originates on row from this table

targetField - cascade select operation modifies this field

targetTable - cascade select operation is performed on this table

selectCascadeAnnotation - cascade operation

Since:

4.1

Method Detail

getFilterPredicateMap

public java.util.Map<java.lang.Class<?>,java.util.function.BiPredicate<?,java.lang.Boolean>> getFilterPredicateMap()

Gets a map of all filters used by this operation and lower level cascades. Typically a filter corresponds to one row type.

Key is class type to filter. Value is predicate to invoke for filtering. Filter parameters are row class and boolean that indicates true/false if cascade has been performed on row class.

Returns:

map of class to filter

Since:

4.0

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.

Overrides:

cascade in class CascadeOperation<S,T>

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 CascadeOperation.prepareForeignKeyValueFields(). Subclasses should override to perform additional preparation.

Overrides:

prepare in class CascadeOperation<S,T>

Throws:

OperationException - if error

deriveSqlOperationAttributes

protected void deriveSqlOperationAttributes()

Description copied from class: CascadeOperation

Sets the sql operation attributes that are the same as source attributes for all levels. Cascade depth is also set as 1 + source depth.

Overrides:

deriveSqlOperationAttributes in class CascadeOperation<S,T>

isSourcePrimaryKeyFields

public boolean isSourcePrimaryKeyFields()

Returns:

true if SelectCascade.sourceParameterFieldNames() is "#primaryKeyFields"

Since:

3.1

isSourceTargetFieldNames

public boolean isSourceTargetFieldNames()

Returns:

true if SelectCascade.sourceParameterFieldNames() is "#targetFieldNames"

Since:

3.1

isWhereSourceFieldNames

public boolean isWhereSourceFieldNames()

Returns:

true if SelectCascade.targetWhereName() is "#sourceFieldNames"

Since:

3.1

isWhereForeignKeyValueFields

public boolean isWhereForeignKeyValueFields()

Returns:

true if SelectCascade.targetWhereName() is "#foreignKeyValueFields"

Since:

3.1

prepareParameterFields

protected void prepareParameterFields()
                               throws OperationException

Uses reflection to get fields for each of the source class variables that will be read from source and set as parameters on cascade operation. Parameter values are set when setParameters(S) is invoked by cascade(S).

Throws:

OperationException - if error

setParameters

protected void setParameters(S sourceRow)
                      throws OperationException

cascade(S) invokes this method to set parameters in cascade operation based upon parameter fields that were created by prepareParameterFields(). Override for custom parameter initialization.

Parameters:

sourceRow - cascade source row

Throws:

OperationException - if error

prepareWhere

protected void prepareWhere()
                     throws OperationException

Configures the WhereTranslator to use for cascade.

Throws:

OperationException - if error

Since:

3.1

close

public void close()
           throws OperationException

Cleans up by closing any JDBC resources.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class CascadeOperation<S,T>

Throws:

OperationException - if error

toTargetArray

protected T[] toTargetArray(java.util.Collection<T> c)
                     throws OperationException

Throws:

OperationException