ch.rasc.extclassgenerator.association

Class AbstractAssociation

java.lang.Object

ch.rasc.extclassgenerator.association.AbstractAssociation

Direct Known Subclasses:

BelongsToAssociation, HasManyAssociation, HasOneAssociation

public abstract class AbstractAssociation
extends Object

Base class for the association objects

Constructor Summary

Constructors

Constructor and Description
AbstractAssociation(String type, String model) Creates an instance of the AbstractAssociation.

Method Summary

Methods

Modifier and Type	Method and Description
static AbstractAssociation	createAssociation(ch.rasc.extclassgenerator.ModelAssociation associationAnnotation)
static AbstractAssociation	createAssociation(ch.rasc.extclassgenerator.ModelAssociation associationAnnotation, ModelBean model, Class<?> typeOfFieldOrReturnValue, Class<?> declaringClass, String name)
String	getAssociationKey()
String	getForeignKey()
String	getInstanceName()
String	getModel()
protected static String	getModelName(Class<?> model)
String	getPrimaryKey()
String	getType()
void	setAssociationKey(String associationKey) The name of the property in the data to read the association from.
void	setForeignKey(String foreignKey) The name of the foreign key on the associated model that links it to the owner model.
void	setInstanceName(String instanceName)
void	setPrimaryKey(String primaryKey) The name of the primary key on the associated model.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAssociation

public AbstractAssociation(String type,
                   String model)

Creates an instance of the AbstractAssociation. Sets getType() and getModel() to the provided parameters.

Parameters:

type - The type of the association.

model - The name of the model that is being associated with.

Method Detail

getAssociationKey

public String getAssociationKey()

setAssociationKey

public void setAssociationKey(String associationKey)

The name of the property in the data to read the association from. Defaults to the name of the associated model.

Corresponds to the associationKey config property.

Parameters:

associationKey - name of the property in the json data

getForeignKey

public String getForeignKey()

setForeignKey

public void setForeignKey(String foreignKey)

The name of the foreign key on the associated model that links it to the owner model. Defaults to the lowercase name of the owner model + "_id" (HAS_MANY) or to the field name (BELONGS_TO, HAS_ONE) + "_id".

Corresponds to the foreignKey config property.

Parameters:

foreignKey - the new name for the foreignKey

getPrimaryKey

public String getPrimaryKey()

setPrimaryKey

public void setPrimaryKey(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.

Parameters:

primaryKey - the new name for the primaryKey

getType

public String getType()

getModel

public String getModel()

getInstanceName

public String getInstanceName()

setInstanceName

public void setInstanceName(String instanceName)

getModelName

protected static String getModelName(Class<?> model)

createAssociation

public static AbstractAssociation createAssociation(ch.rasc.extclassgenerator.ModelAssociation associationAnnotation)

createAssociation

public static AbstractAssociation createAssociation(ch.rasc.extclassgenerator.ModelAssociation associationAnnotation,
                                    ModelBean model,
                                    Class<?> typeOfFieldOrReturnValue,
                                    Class<?> declaringClass,
                                    String name)