ch.rasc.extclassgenerator

Annotation Type Model

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
public @interface Model

Annotation to configure different aspects of a model object

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autodetectTypes If true the model generator tries to auto-detect the type of a field when no ModelField annotation is present.
String	clientIdProperty The name of the property a server will use to send back a client-generated id in a create or update operation.
String	createMethod Specifies the create method.
String	destroyMethod Specifies the destroy method.
boolean	disablePagingParameters If set to true the pageParam, startParam and limitParam option of the proxy will be set to undefined (Ext JS 4), false (Sencha Touch 2) or '' (Ext JS 5).
String	extend "Superclass" of this model.
String	identifier The id generator to use for this model.
String	idProperty Name of the id property.
String	messageProperty If set add to reader
boolean	paging If true a reader config with root : 'records' (Ext JS 4) or rootProperty : 'records' (Sencha Touch 2 and Ext JS 5) will be added to the model object.
String	reader If set adds a reader config to the proxy object.
String	readMethod Specifies the read method.
String	rootProperty If set a reader config with root : 'rootProperty' (Ext JS 4) or rootProperty : 'rootProperty' (Sencha Touch 2 and Ext JS 5) will be added to the model object.
String	successProperty If set add to reader
String	totalProperty If set add to reader
String	updateMethod Specifies the update method.
String	value "Classname" of the model.
String	versionProperty If specified, this is the name of the property that contains the entity "version".
boolean	writeAllFields If specified the generator adds a writer config object to the proxy with writeAllFields.
String	writer If set adds a writer config to the proxy object.

Element Detail

autodetectTypes

public abstract boolean autodetectTypes

If true the model generator tries to auto-detect the type of a field when no ModelField annotation is present.

If false every field that is not annotated with ModelField or contains an empty ModelField.type() attribute is set to the type ModelType.AUTO

Default:

true

value

public abstract String value

"Classname" of the model. See Ext.data.Model .

If not present full qualified name of the class is used.

Default:

""

extend

public abstract String extend

"Superclass" of this model.

Defaults to "Ext.data.Model"

Default:

"Ext.data.Model"

idProperty

public abstract String idProperty

Name of the id property. See Ext.data.Model#idProperty. This also sets the idParam property on the proxy.

If not present default value of 'id' is used.

This is an alternative to the ModelId annotation. The annotation takes precedence if both are present.

Default:

"id"

versionProperty

public abstract String versionProperty

If specified, this is the name of the property that contains the entity "version". The version property is used to manage a long-running transaction and allows the detection of simultaneous modification.

This is an alternative to the ModelVersion annotation. The annotation takes precedence if both are present.

See Ext.data.Model#versionProperty

Defaults to null

Default:

""

clientIdProperty

public abstract String clientIdProperty

The name of the property a server will use to send back a client-generated id in a create or update operation. This also sets the property clientIdProperty on the writer config.

This is an alternative to the ModelClientId annotation. The annotation takes precedence if both are present.

See Ext.data.Model#clientIdProperty

Defaults to null

Default:

""

paging

public abstract boolean paging

If true a reader config with root : 'records' (Ext JS 4) or rootProperty : 'records' (Sencha Touch 2 and Ext JS 5) will be added to the model object.

 reader : {
   rootProperty : 'records'
 }
 

Default value is false. To set a specific value to the root property use rootProperty()

Default:

false

disablePagingParameters

public abstract boolean disablePagingParameters

If set to true the pageParam, startParam and limitParam option of the proxy will be set to undefined (Ext JS 4), false (Sencha Touch 2) or '' (Ext JS 5). This prevents the proxy of sending the page, start and limit parameter to the server.

   proxy: {
     type: 'direct',
     pageParam: undefined,
     startParam: undefined,
     limitParam: undefined,
   }
 

Default value is false

Default:

false

readMethod

public abstract String readMethod

Specifies the read method. This is a ExtDirect reference in the form action.methodName. See Ext.data.proxy.Direct#api.

If only the readMethod is specified the generator will write the property directFn instead.

Default:

""

createMethod

public abstract String createMethod

Specifies the create method. This is a ExtDirect reference in the form action.methodName. See Ext.data.proxy.Direct#api.

Default:

""

updateMethod

public abstract String updateMethod

Specifies the update method. This is a ExtDirect reference in the form action.methodName. See Ext.data.proxy.Direct#api.

Default:

""

destroyMethod

public abstract String destroyMethod

Specifies the destroy method. This is a ExtDirect reference in the form action.methodName. See Ext.data.proxy.Direct#api.

Default:

""

messageProperty

public abstract String messageProperty

If set add to reader

 reader : {
   messageProperty : 'your property name'
 }
 

It is useful to add a customized message in case of error See Ext.data.reader.Reader#messageProperty

Default:

""

writer

public abstract String writer

If set adds a writer config to the proxy object.

   proxy: {
     type: 'direct',
     writer: {
       type: 'mywriter'
     }
   }
 

See Ext.data.proxy.Proxy#writer

Defaults to "json"

Default:

"json"

reader

public abstract String reader

If set adds a reader config to the proxy object.

   proxy: {
     type: 'direct',
     reader: {
       type: 'myreader'
     }
   }
 

See Ext.data.proxy.Proxy#reader

Defaults to "json"

Default:

"json"

successProperty

public abstract String successProperty

If set add to reader

 reader : {
   successProperty : 'success'
 }
 

See Ext.data.reader.Reader#successProperty

If not present default value 'success' is used.

Default:

""

totalProperty

public abstract String totalProperty

If set add to reader

 reader : {
   totalProperty : 'total'
 }
 

See Ext.data.reader.Reader#totalProperty

If not present default value 'total' is used.

Default:

""

rootProperty

public abstract String rootProperty

If set a reader config with root : 'rootProperty' (Ext JS 4) or rootProperty : 'rootProperty' (Sencha Touch 2 and Ext JS 5) will be added to the model object.

 reader : {
   rootProperty : 'rootProperty'
 }
 

If paging() and rootProperty() are present rootProperty() has precedence.

See Ext.data.reader.Reader#root

Default:

""

writeAllFields

public abstract boolean writeAllFields

If specified the generator adds a writer config object to the proxy with writeAllFields.

   proxy: {
     type: 'direct',
     writer: {
       writeAllFields: true
     }
   }
 

See Ext.data.writer.WriterView#writeAllFields

Defaults to true

Default:

true

identifier

public abstract String identifier

The id generator to use for this model.

See Ext.data.Model#identifier

Defaults to null

Default:

""