ch.rasc.extclassgenerator

Class ModelBean

java.lang.Object

ch.rasc.extclassgenerator.ModelBean

public class ModelBean
extends Object

Represents a model. This object can be used to create JS code with ModelGenerator.writeModel(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, ModelBean, OutputFormat, boolean) or ModelGenerator.generateJavascript(ModelBean, OutputFormat, boolean).

Constructor Summary

Constructors

Constructor and Description
ModelBean()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAssociation(AbstractAssociation bean) Adds one instance of AbstractAssociation to the internal collection of associations
void	addAssociations(List<AbstractAssociation> associationsList)
void	addField(ModelFieldBean bean) Adds one instance of ModelFieldBean to the internal collection of fields
void	addFields(List<ModelFieldBean> modelFields) Add all provided fields to the collection of fields
void	addValidation(AbstractValidation bean) Adds one instance of one of the subclasses of AbstractValidation to the internal collection of validations
void	addValidations(List<AbstractValidation> fieldValidations)
List<AbstractAssociation>	getAssociations()
String	getCreateMethod()
String	getDestroyMethod()
ModelFieldBean	getField(String fieldName) Looks for the ModelFieldBean with the provided name and returns it.
Map<String,ModelFieldBean>	getFields()
String	getIdProperty()
String	getMessageProperty()
String	getName()
String	getReadMethod()
String	getUpdateMethod()
List<AbstractValidation>	getValidations()
String	getWriter()
boolean	isDisablePagingParameters()
boolean	isPaging()
void	setAssociations(List<AbstractAssociation> associations)
void	setCreateMethod(String createMethod) Specifies the create method.
void	setDestroyMethod(String destroyMethod) Specifies the destroy method.
void	setDisablePagingParameters(boolean disablePagingParameters) If set to true the pageParam, startParam and limitParam option of the proxy will be set to undefined.
void	setFields(Map<String,ModelFieldBean> fields) Overwrites all field definitions with the provided map.
void	setIdProperty(String idProperty) Name of the id property.
void	setMessageProperty(String messageProperty) if set add to reader
void	setName(String name) "Classname" of the model.
void	setPaging(boolean paging) If true a reader config with root : 'records' will be added to the model object.
void	setReadMethod(String readMethod) Specifies the read method.
void	setUpdateMethod(String updateMethod) Specifies the update method.
void	setValidations(List<AbstractValidation> validations)
void	setWriter(String writer) If set add a writer property to the proxy.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelBean

public ModelBean()

Method Detail

getName

public String getName()

setName

public void setName(String name)

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

Parameters:

name - new name for the model object

getIdProperty

public String getIdProperty()

setIdProperty

public void setIdProperty(String idProperty)

Name of the id property. See Ext.data.Model#idProperty.

Parameters:

idProperty - new value for the idProperty config option

getFields

public Map<String,ModelFieldBean> getFields()

setFields

public void setFields(Map<String,ModelFieldBean> fields)

Overwrites all field definitions with the provided map.

Parameters:

fields - new collection of ModelFieldBean

getValidations

public List<AbstractValidation> getValidations()

setValidations

public void setValidations(List<AbstractValidation> validations)

getAssociations

public List<AbstractAssociation> getAssociations()

setAssociations

public void setAssociations(List<AbstractAssociation> associations)

addFields

public void addFields(List<ModelFieldBean> modelFields)

Add all provided fields to the collection of fields

Parameters:

modelFields - collection of ModelFieldBean

addValidations

public void addValidations(List<AbstractValidation> fieldValidations)

addAssociations

public void addAssociations(List<AbstractAssociation> associationsList)

getField

public ModelFieldBean getField(String fieldName)

Looks for the ModelFieldBean with the provided name and returns it.

Parameters:

fieldName - name of a field

Returns:

a ModelFieldBean or null if not found

addField

public void addField(ModelFieldBean bean)

Adds one instance of ModelFieldBean to the internal collection of fields

Parameters:

bean - instance of ModelFieldBean

addValidation

public void addValidation(AbstractValidation bean)

Adds one instance of one of the subclasses of AbstractValidation to the internal collection of validations

Parameters:

bean - instance of subclass of AbstractValidation

addAssociation

public void addAssociation(AbstractAssociation bean)

Adds one instance of AbstractAssociation to the internal collection of associations

Parameters:

bean - instance of AbstractAssociation

isPaging

public boolean isPaging()

setPaging

public void setPaging(boolean paging)

If true a reader config with root : 'records' will be added to the model object. This configuration is needed it the STORE_READ method return an instance of ExtDirectStoreResult

 reader : {
   root : 'records'
 }
 

Parameters:

paging - new value for paging

isDisablePagingParameters

public boolean isDisablePagingParameters()

setDisablePagingParameters

public void setDisablePagingParameters(boolean disablePagingParameters)

If set to true the pageParam, startParam and limitParam option of the proxy will be set to undefined. 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

getReadMethod

public String getReadMethod()

setReadMethod

public void setReadMethod(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 generator will write property directFn instead.

Parameters:

readMethod - new value for read method

getCreateMethod

public String getCreateMethod()

setCreateMethod

public void setCreateMethod(String createMethod)

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

Parameters:

createMethod - new value for create method

getUpdateMethod

public String getUpdateMethod()

setUpdateMethod

public void setUpdateMethod(String updateMethod)

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

Parameters:

updateMethod - new value for update method

getDestroyMethod

public String getDestroyMethod()

setDestroyMethod

public void setDestroyMethod(String destroyMethod)

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

Parameters:

destroyMethod - new value for destroy method

getMessageProperty

public String getMessageProperty()

Returns:

the messageProperty

setMessageProperty

public void setMessageProperty(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

Parameters:

messageProperty - the messageProperty to set

getWriter

public String getWriter()

setWriter

public void setWriter(String writer)

If set add a writer property to the proxy.

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

See Ext.data.proxy.Proxy#writer