org.sormula.annotation.cascade

Class CascadeAnnotationReader

java.lang.Object

org.sormula.annotation.cascade.CascadeAnnotationReader

Direct Known Subclasses:

DeleteCascadeAnnotationReader, InsertCascadeAnnotationReader, SaveCascadeAnnotationReader, SelectCascadeAnnotationReader, UpdateCascadeAnnotationReader

public abstract class CascadeAnnotationReader
extends java.lang.Object

Base class for cascade annotation readers.

Since:

1.8 and 2.2

Author:

Jeff Miller

Constructor Summary

Constructors

Constructor and Description
CascadeAnnotationReader(java.lang.reflect.Field source) Constructs for a field.

Method Summary

Modifier and Type	Method and Description
protected void	checkDefaultTargetClass() Initializes target class based upon Field.getGenericType() and Field.getType() when target class is not specified (the default value of Object.class).
java.lang.String	getForeignKeyReferenceField() Gets the field name of that contains foreign key reference in target (child) rows.
java.lang.String[]	getForeignKeyValueFields() Gets the field names of foreign key values in target (child) rows.
java.lang.String	getName() Gets the name of the cascade as defined by OneToManyCascade.name(), or OneToManyCascade.name(), or Cascade.name().
java.lang.reflect.Field	getSource() Gets the source field supplied in constructor.
java.lang.Class<?>	getTargetClass() Gets the class of the field that will be affected by cascade.
protected void	init(Cascade cascadeAnnotation) Initializes common values when Cascade is annotated on source field.
protected void	init(OneToManyCascade cascadeAnnotation) Initializes common values when OneToManyCascade is annotated on source field.
protected void	init(OneToOneCascade cascadeAnnotation) Initializes common values when OneToOneCascade is annotated on source field.
protected abstract void	initCascade(Cascade cascacdeAnnotation) Initializes when Cascade is annotated on source field (or implied as default when no annotation is used).
protected abstract void	initOneToManyCascade(OneToManyCascade cascacdeAnnotation) Initializes when OneToManyCascade is annotated on source field (or implied as default when no annotation is used).
protected abstract void	initOneToOneCascade(OneToOneCascade cascacdeAnnotation) Initializes when OneToOneCascade is annotated on source field (or implied as default when no annotation is used).
protected void	initTargetClass(java.lang.Class<?> targetClass) Sets the class type for target field that will be affected by cascade.
void	setForeignKeyReferenceField(java.lang.String foreignKeyReferenceField) Sets the field name that contains a reference to the foreign key object in target (child) rows.
void	setForeignKeyValueFields(java.lang.String[] foreignKeyValueFields) Sets the name of fields that contain the foreign key values in target (child) rows.
void	setName(java.lang.String name) Sets the name of the cascade as defined by OneToManyCascade.name(), or OneToManyCascade.name(), or Cascade.name().

Methods inherited from class java.lang.Object

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

Constructor Detail

CascadeAnnotationReader

public CascadeAnnotationReader(java.lang.reflect.Field source)

Constructs for a field.

Parameters:

source - field with cascade annotation(s) (or default cascade)

Method Detail

initOneToManyCascade

protected abstract void initOneToManyCascade(OneToManyCascade cascacdeAnnotation)

Initializes when OneToManyCascade is annotated on source field (or implied as default when no annotation is used).

Parameters:

cascacdeAnnotation - annotation to use for cascade

Since:

3.1

initOneToOneCascade

protected abstract void initOneToOneCascade(OneToOneCascade cascacdeAnnotation)

Initializes when OneToOneCascade is annotated on source field (or implied as default when no annotation is used).

Parameters:

cascacdeAnnotation - annotation to use for cascade

Since:

3.1

initCascade

protected abstract void initCascade(Cascade cascacdeAnnotation)

Initializes when Cascade is annotated on source field (or implied as default when no annotation is used).

Parameters:

cascacdeAnnotation - annotation to use for cascade

Since:

3.1

init

protected void init(OneToManyCascade cascadeAnnotation)

Initializes common values when OneToManyCascade is annotated on source field.

Parameters:

cascadeAnnotation - cascade information

Since:

3.0

init

protected void init(OneToOneCascade cascadeAnnotation)

Initializes common values when OneToOneCascade is annotated on source field.

Parameters:

cascadeAnnotation - cascade information

Since:

3.0

init

protected void init(Cascade cascadeAnnotation)

Initializes common values when Cascade is annotated on source field.

Parameters:

cascadeAnnotation - cascade information

Since:

3.0

initTargetClass

protected void initTargetClass(java.lang.Class<?> targetClass)

Sets the class type for target field that will be affected by cascade. For scalar fields and simple parameterized types, the target type can be determined. Otherwise the type must be specified by OneToManyCascade.targetClass() or Cascade.targetClass().

Parameters:

targetClass - class of target field

checkDefaultTargetClass

protected void checkDefaultTargetClass()

Initializes target class based upon Field.getGenericType() and Field.getType() when target class is not specified (the default value of Object.class). OneToManyCascade.targetClass() and Cascade.targetClass() have a default of Object.class.

Since:

1.9 and 2.3

setName

public void setName(java.lang.String name)

Sets the name of the cascade as defined by OneToManyCascade.name(), or OneToManyCascade.name(), or Cascade.name(). Invoked by init(Cascade), init(OneToManyCascade), and init(OneToOneCascade).

Parameters:

name - of cascade or empty string if none

Since:

3.0

getName

public java.lang.String getName()

Gets the name of the cascade as defined by OneToManyCascade.name(), or OneToManyCascade.name(), or Cascade.name().

Returns:

name of cascade or empty string if none

Since:

3.0

getSource

public java.lang.reflect.Field getSource()

Gets the source field supplied in constructor.

Returns:

source field with cascade annotation(s)

getTargetClass

public java.lang.Class<?> getTargetClass()

Gets the class of the field that will be affected by cascade.

Returns:

OneToManyCascade.targetClass() or Cascade.targetClass()

setForeignKeyValueFields

public void setForeignKeyValueFields(java.lang.String[] foreignKeyValueFields)

Sets the name of fields that contain the foreign key values in target (child) rows.

Parameters:

foreignKeyValueFields - field names from cascade annotation foreignKeyValueFields

Since:

3.0

See Also:

Cascade.foreignKeyValueFields(), OneToManyCascade.foreignKeyValueFields(), OneToOneCascade.foreignKeyValueFields()

getForeignKeyValueFields

public java.lang.String[] getForeignKeyValueFields()

Gets the field names of foreign key values in target (child) rows. See cascade annotations for details.

Returns:

names of foreign key value fields

Since:

3.0

setForeignKeyReferenceField

public void setForeignKeyReferenceField(java.lang.String foreignKeyReferenceField)

Sets the field name that contains a reference to the foreign key object in target (child) rows.

Parameters:

foreignKeyReferenceField - field name of foreign key reference from cascade annotation foreignKeyReferenceField

Since:

3.0

See Also:

Cascade.foreignKeyReferenceField(), OneToManyCascade.foreignKeyReferenceField(), OneToOneCascade.foreignKeyReferenceField()

getForeignKeyReferenceField

public java.lang.String getForeignKeyReferenceField()

Gets the field name of that contains foreign key reference in target (child) rows. See cascade annotations for details.

Returns:

names of foreign key value fields

Since:

3.0