org.sormula.annotation.cascade

Annotation Type SelectCascade

@Retention(value=RUNTIME)
 @Target(value={FIELD,ANNOTATION_TYPE})
public @interface SelectCascade

Used within a OneToOneCascade, OneToManyCascade, or Cascade annotation to define a cascade select operation.

Since:

1.0

Author:

Jeff Miller

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	lazy Marks a select cascade to be performed some later time after source row is selected.
java.lang.Class<? extends ScalarSelectOperation>	operation Specifics operation to perform as a select cascade.
boolean	post Specifies when the cascade is to occur.
boolean	setForeignKeyReference Indicates that foreign key reference should be set on target (child) rows during cascade.
boolean	setForeignKeyValues Indicates that foreign key values should be set on target (child) rows during cascade.
java.lang.String[]	sourceParameterFieldNames Specifies fields from source row to be used as parameters in cascade operation for target row.
java.lang.String	targetKeyMethodName Method name in target class that returns row key value for adding to map results.
java.lang.String	targetOrderByName Specifies the order condition to use in cascade.
java.lang.String	targetWhereName Specifies the where condition to use in cascade.

Element Detail

operation

public abstract java.lang.Class<? extends ScalarSelectOperation> operation

Specifics operation to perform as a select cascade. Typical operations would be ScalarSelectOperation, ArrayListSelectOperation, HashMapSelectOperation or some subclass of those.

The default value of ArrayListSelectOperation works correctly for source fields that are scalar or List. If the source field is not scalar or List, then some other select operation must be used.

Returns:

operation to use for cascade

Default:

org.sormula.operation.ArrayListSelectOperation.class

sourceParameterFieldNames

public abstract java.lang.String[] sourceParameterFieldNames

Specifies fields from source row to be used as parameters in cascade operation for target row. Names must be in same order as defined in where condition on target row with targetWhereName() or in same order as primary key fields of target row if primary key is used as where condition.

"#primaryKeyFields" means source parameter fields are source primary key fields

"#targetFieldNames" means source parameter field names are the same names as defined by targetWhereName().

Any name that begins with dollar($) symbol indicates a named parameter. For example, $somename value is obtained with SqlOperation.getParameter(String) with a key of "somename". Named parameters set at the top level operation of a cascading relationship are available at all levels of the cascade.

Returns:

field names of fields to be used as parameters; "#primaryKeyFields" to get source values from source primary keys; "#targetFieldNames" to get source values from source fields named in targetWhereName().

Default:

"#targetFieldNames"

targetWhereName

public abstract java.lang.String targetWhereName

Specifies the where condition to use in cascade. Name is one of names specified on target class by Where.name() or "primaryKey" for primary key. An empty string indicates no where condition (select all). Typically is the name of the where condition that uses foreign key(s) in target row that correspond to primary key(s) in source row.

"#sourceFieldNames" means use a where condition that uses fields defined by sourceParameterFieldNames(). If more than one field, then AND operand is used to combine them. Name target foreign key fields the same as source field to use this symbolic name.

"#foreignKeyValueFields" means to use a where condition with fields defined by OneToOneCascade.foreignKeyValueFields(), or OneToManyCascade.foreignKeyValueFields(), or Cascade.foreignKeyValueFields(). If more than one field, then AND operand is used to combine them.

Returns:

where condition name of target row; "primaryKey" to select by primary key; empty string will select all rows; "#sourceFieldNames" to select by target fields named same as sourceParameterFieldNames(); "#foreignKeyValueFields" to select by target foreign key value fields

Default:

"primaryKey"

targetOrderByName

public abstract java.lang.String targetOrderByName

Specifies the order condition to use in cascade. Name is one of names specified on target class by OrderBy.name() or empty string for unordered.

Returns:

order condition name of target row; empty string for none

Default:

""

post

public abstract boolean post

Specifies when the cascade is to occur. This value is ignored if lazy() is true.

Returns:

true to perform cascade after source row operation; false to perform cascade before source row operation

Default:

true

setForeignKeyValues

public abstract boolean setForeignKeyValues

Indicates that foreign key values should be set on target (child) rows during cascade. Foreign key value fields are defined by Cascade.foreignKeyValueFields(), OneToManyCascade.foreignKeyValueFields(), or OneToOneCascade.foreignKeyValueFields().

Foreign key values are set prior to cascade for insert, update, delete, and save cascades. They are set after select cascades.

Returns:

true to set foreign key values during cascade

Since:

3.0

Default:

true

setForeignKeyReference

public abstract boolean setForeignKeyReference

Indicates that foreign key reference should be set on target (child) rows during cascade. Foreign key reference field is defined by Cascade.foreignKeyReferenceField(), OneToManyCascade.foreignKeyReferenceField(), or OneToOneCascade.foreignKeyReferenceField().

Foreign key reference is set prior to cascade for insert, update, delete, and save cascades. It is set after select cascades.

Returns:

true to set foreign key reference during cascade

Since:

3.0

Default:

true

targetKeyMethodName

public abstract java.lang.String targetKeyMethodName

Method name in target class that returns row key value for adding to map results. Key method name is required when operation() is instance of MapSelectOperation; otherwise it is ignored.

The method used for target key is likely the primary key for the row but may be some other method if select cascade produces a subset of rows.

"#primaryKey" to use target primary key method (works only with single primary key).

Returns:

name of method that gets key value from target row; "#primaryKey" to use target row primary key getter method

Default:

"hashCode"

lazy

public abstract boolean lazy

Marks a select cascade to be performed some later time after source row is selected. The target row is selected when LazySelectable.checkLazySelects(String) is invoked or when ActiveRecord.checkLazySelects(String) is invoked.

Returns:

true to skip select when source row is selected and add it to list of pending lazy select fields; false to perform select cascade when source row is selected

Since:

1.8 and 2.2

See Also:

AbstractLazySelector, SimpleLazySelector, DurableLazySelector

Default:

false