ch.rasc.extclassgenerator.ModelAssociation Maven / Gradle / Ivy
/**
* Copyright 2013-2016 Ralph Schaer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package ch.rasc.extclassgenerator;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 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.
*/
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface ModelAssociation {
/**
* The type of the association.
*
* Corresponds to the
* type config property.
*/
ModelAssociationType value();
/**
* Name of the property. Must be present when annotation is located on a type. Has to
* correspond with a {@link ModelField#value()} entry.
*/
String propertyName() default "";
/**
* 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 {@link Model#value()} if
* present on the class.
*/
Classmodel() default Object.class;
/**
* True to automatically load the related store from a remote source when
* instantiated. Defaults to false.
*
* Corresponds to the autoLoad config property.
*
* Only {@link ModelAssociationType#HAS_MANY} association support this property.
*/
boolean autoLoad() default false;
/**
* 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.
*/
String foreignKey() default "";
/**
* 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 {@link ModelAssociationType#HAS_MANY} association support this property.
*/
String name() default "";
/**
* The name of the primary key on the associated model.
* In general this will be the value of {@link Model#idProperty()}.
*
* Corresponds to the primaryKey config property.
*/
String primaryKey() default "";
/**
* 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 {@link ModelAssociationType#BELONGS_TO} and
* {@link ModelAssociationType#HAS_ONE} associations support this property.
*/
String setterName() default "";
/**
* 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 {@link ModelAssociationType#BELONGS_TO} and
* {@link ModelAssociationType#HAS_ONE} associations support this property.
*/
String getterName() default "";
/**
* Sets the private config field instanceName of Ext.data.association.HasOne,
* Ext.data.association.HasMany or Ext.data.association.BelongsTo
*
* Setting this property fixes a problem in Ext JS when there are two associations
* that use the same class type (Ext JS only sets one association correctly).
*
* Warning: instanceName is a private config field in Ext JS and it can change
* anytime.
*/
String instanceName() default "";
}