ch.ralscha.extdirectspring.generator

Annotation Type ModelAssociation

@Target(value=FIELD)
@Retention(value=RUNTIME)
@Inherited
@Documented
public @interface ModelAssociation

Annotation that configures an association to another object. If this annotation is present on a field the generator creates an associations config object in the model.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
ModelAssociationType	value The type of the association.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoLoad True to automatically load the related store from a remote source when instantiated.
String	foreignKey The name of the foreign key on the associated model that links it to the owner model.
String	getterName The name of the getter function that will be added to the local model's prototype.
Class<?>	model The class of the model that is being associated with.
String	name The name of the function to create on the owner model to retrieve the child store.
String	primaryKey The name of the primary key on the associated model.
String	setterName The name of the setter function that will be added to the local model's prototype.

Element Detail

value

public abstract ModelAssociationType value

The type of the association.

Corresponds to the type config property.

model

public abstract Class<?> model

The class of the model that is being associated with.

Corresponds to the model config property. The generated Javascript code contains either the full qualified class name of the class or the string from Model.value() if present on the class.

Default:

java.lang.Object.class

autoLoad

public abstract boolean autoLoad

True to automatically load the related store from a remote source when instantiated. Defaults to false.

Corresponds to the autoLoad config property.

Only ModelAssociationType.HAS_MANY association support this property.

Default:

false

foreignKey

public abstract String foreignKey

The name of the foreign key on the associated model that links it to the owner model. Defaults to the lowercased name of the owner class plus "_id".

Corresponds to the foreignKey config property.

Default:

""

name

public abstract String name

The name of the function to create on the owner model to retrieve the child store. If not specified, the name of the field is used.

Corresponds to the name config property.

Only ModelAssociationType.HAS_MANY association support this property.

Default:

""

primaryKey

public abstract String primaryKey

The name of the primary key on the associated model.
In general this will be the value of Model.idProperty().

Corresponds to the primaryKey config property.

Default:

""

setterName

public abstract String setterName

The name of the setter function that will be added to the local model's prototype. Defaults to 'set' + name of the field, e.g. setCategory.

Corresponds to the setterName config property.

Only ModelAssociationType.BELONGS_TO and ModelAssociationType.HAS_ONE associations support this property.

Default:

""

getterName

public abstract String getterName

The name of the getter function that will be added to the local model's prototype. Defaults to 'get' + name of the field, e.g. getCategory.

Corresponds to the getterName config property.

Only ModelAssociationType.BELONGS_TO and ModelAssociationType.HAS_ONE associations support this property.

Default:

""