ch.rasc.extclassgenerator.ModelField 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.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation that configures different aspects of a model field. The annotation does not
* have to be present on the field to be included in the generated JS code. The generator
* takes all public readable fields into account.
*/
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Repeatable(ModelFields.class)
public @interface ModelField {
/**
* Name of the field. Property ' name ' in JS.
*
* If not present the name of the field is used.
*/
String value() default "";
/**
* Type of the field. Property ' type
* ' in JS.
*
* If not present and {@link Model#autodetectTypes()} is true the generator tries to
* figure out the type. If not present and {@link Model#autodetectTypes()} is false
* the type is set to 'auto'.
*/
ModelType type() default ModelType.NOT_SPECIFIED;
/**
* Type of the field. Property ' type
* ' in JS. This is used for the new Ext JS 5 Custom Field Types feature.
*
* If not present the library tries to figure out the type.
*
* If {@link #type()} and {@link #customType()} are present {@link #customType()} has
* precedence.
*/
String customType() default "";
/**
* The default value. Property ' defaultValue' in JS.
*
* Can be set to {@link #DEFAULTVALUE_UNDEFINED} to set defaultValue to the value
* undefined. This prevents defaulting a value.
*/
String defaultValue() default "";
/**
* Specifies format of date. Property ' dateFormat' in JS.
* For a list of all supported formats see Sencha Doc:
* Ext.Date
*
*
* Will be ignored if the field is not a {@link ModelType#DATE} field.
*/
String dateFormat() default "";
/**
* If true null value is used if value cannot be parsed. If false default values are
* used (0 for integer and float, "" for string and false for boolean).
* Property '
*
* useNull' in JS.
*
* Only used if type of field is {@link ModelType#INTEGER}, {@link ModelType#FLOAT},
* {@link ModelType#NUMBER}, {@link ModelType#STRING} or {@link ModelType#BOOLEAN}.
*/
boolean useNull() default false;
/**
* Use when converting received data into a integer,
* float/number, boolean or string type. If the
* value cannot be parsed, null will be used if allowNull is true, otherwise a default
* value for that type will be used (0 for integer and float/number, "" for string and
* false for boolean)
*
* See Ext.data.Field#allowNull
*
* Defaults to false
*
* Only used if type of field is {@link ModelType#INTEGER}, {@link ModelType#FLOAT},
* {@link ModelType#NUMBER}, {@link ModelType#STRING} or {@link ModelType#BOOLEAN}.
*
* This is another name for {@link #useNull()}. Both properties behave exactly
* the same. Use only one.
*/
boolean allowNull() default false;
/**
* Used for validating a model.
*
* Set Ext.data.Field#allowBlank
*
* Defaults to true
*/
boolean allowBlank() default true;
/**
* Typical use for a virtual field to extract field data from the model object
* Property ' mapping' in JS.
*
*/
String mapping() default "";
/**
* If set to false prevents the value of this field to be serialized or written with
* Ext.data.writer.Writer
* Typical use for a virtual field
* Property ' persist' in JS.
*
* Defaults to true
*/
boolean persist() default true;
/**
* A critical field is a field that must always be sent to the server even if it has
* not changed.
*
* See Ext.data.field.FieldView#critical
*
* Defaults to false
*/
boolean critical() default false;
/**
* The field name or names within the Model on which the value of this field depends,
* and from which a new value may be calculated. These values are the values used by
* the {@link #convert()} method. If you do not have a {@link #convert()} method then
* this config should not be specified. Before using this config you should consider
* if using a {@link #calculate()} method instead of a {@link #convert()} method would
* be simpler.
*
* See Ext.data.field.FieldView#depends
*
* Defaults to null
*/
String[] depends() default {};
/**
* Function which coerces string values in raw data into the field's type
* Typical use for a virtual field
* Property ' Ext.data.Field#convert' in JS.
*
*/
String convert() default "";
/**
* This config defines a simple field calculation function. A calculate method only
* has access to the record data and should return the value of the calculated field.
* When provided in this way, the depends config is automatically determined by
* parsing the calculate function.
*
* See Ext.data.Field#calculate
*/
String calculate() default "";
/**
* true if the value of this field is unique amongst all instances. When used with a
* reference this describes a "one-to-one" relationship
*
* See Ext.data.Field#unique
*
* Defaults to false
*/
boolean unique() default false;
/**
* Defines a relationship to another model.
*
* See Ext.data.Field#reference
*/
ReferenceConfig reference() default @ReferenceConfig
;
/**
* Constant for the value undefined. Can only be used for the property
* {@link #defaultValue()}. According to the documentation setting defaultValue to undefined prevents defaulting a value.
*/
public final static String DEFAULTVALUE_UNDEFINED = "undefined";
}