com.smartgwt.mobile.client.data

Class DataSourceField

java.lang.Object

com.smartgwt.mobile.client.data.DataSourceField

public class DataSourceField
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DataSourceField()
DataSourceField(DataSourceField field)
DataSourceField(java.lang.String fieldName)
DataSourceField(java.lang.String fieldName, java.lang.String type)

Method Summary

Modifier and Type	Method and Description
static DataSourceField	combineFieldData(DataSourceField localField, DataSourceField dsField)
java.lang.Boolean	getCanEdit()
java.lang.String	getChildTagName() For a field that is multiple:true, the tag name of each subelement.
java.lang.String	getEditorType()
java.lang.String	getForeignKey()
java.lang.String	getHint()
java.lang.Integer	getLength()
java.lang.String	getName()
java.lang.String	getOffText()
java.lang.String	getOnText()
java.lang.Boolean	getRequired()
java.lang.Boolean	getShowTitle()
java.lang.String	getSubrecordsProperty()
java.lang.String	getTitle()
java.lang.String	getType() The name of a registered SimpleType.
DataSource	getTypeAsDataSource()
java.util.LinkedHashMap<?,java.lang.String>	getValueMap()
boolean	isDerived()
boolean	isHidden()
java.lang.Boolean	isInapplicable()
java.lang.Boolean	isMultiple() Indicates that this field should always be array-valued (Java type List).
java.lang.Boolean	isPrimaryKey()
void	setCanEdit(java.lang.Boolean canEdit)
void	setChildTagName(java.lang.String childTagName)
void	setDerived(boolean derived)
void	setEditorType(java.lang.String editorType)
void	setForeignKey(java.lang.String fk)
void	setHidden(boolean hidden)
void	setHint(java.lang.String hint)
void	setInapplicable(java.lang.Boolean inapplicable)
void	setLength(java.lang.Long length)
void	setMultiple(java.lang.Boolean multiple)
void	setName(java.lang.String name)
void	setNestedFields(DataSourceField... nestedFields) Deprecated. The preferred approach is to create a DataSource with the nested fields and call setTypeAsDataSource(DataSource).
void	setOffText(java.lang.String offText)
void	setOnText(java.lang.String onText)
void	setPrimaryKey(java.lang.Boolean pk)
void	setRequired(java.lang.Boolean required)
void	setShowTitle(java.lang.Boolean showTitle)
void	setSubrecordsProperty(java.lang.String subrecordsProperty)
void	setTitle(java.lang.String title)
void	setType(java.lang.String type)
void	setTypeAsDataSource(DataSource typeDS) Sets the field type to a DataSource, which allows you to model nested structures.
void	setValueMap(java.util.LinkedHashMap<?,java.lang.String> valueMap)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceField

public DataSourceField()

DataSourceField

public DataSourceField(java.lang.String fieldName)

DataSourceField

public DataSourceField(java.lang.String fieldName,
                       java.lang.String type)

DataSourceField

public DataSourceField(DataSourceField field)

Method Detail

combineFieldData

public static DataSourceField combineFieldData(DataSourceField localField,
                                               DataSourceField dsField)

getName

public final java.lang.String getName()

setName

public void setName(java.lang.String name)

isMultiple

public java.lang.Boolean isMultiple()

Indicates that this field should always be array-valued (Java type List). If the value is singular, it will be wrapped in an array.

Specifically for XML serialization and deserialization, multiple:true behaves similarly to the SOAP array idiom; that is, there is a "wrapper element" having the field name as its tag name and one or more child "value" elements that specify the values of the array.

The childTagName attribute allows the tag name of the child "value" elements to be customized.

setMultiple

public void setMultiple(java.lang.Boolean multiple)

setNestedFields

@Deprecated
public void setNestedFields(DataSourceField... nestedFields)

Deprecated. The preferred approach is to create a DataSource with the nested fields and call setTypeAsDataSource(DataSource).

Sets nested fields.

Parameters:

nestedFields - the nested fields.

getChildTagName

public java.lang.String getChildTagName()

For a field that is multiple:true, the tag name of each subelement.

If null, then the child tag name is presumed to be "value".

Returns:

String the tag name of subelements.

setChildTagName

public void setChildTagName(java.lang.String childTagName)

setDerived

public void setDerived(boolean derived)

isDerived

public boolean isDerived()

setHidden

public void setHidden(boolean hidden)

isHidden

public boolean isHidden()

getRequired

public java.lang.Boolean getRequired()

setRequired

public void setRequired(java.lang.Boolean required)

getType

public final java.lang.String getType()

The name of a registered SimpleType.

Returns:

the name of a registered SimpleType representing the type of this field.

setType

public void setType(java.lang.String type)

getTypeAsDataSource

public final DataSource getTypeAsDataSource()

setTypeAsDataSource

public void setTypeAsDataSource(DataSource typeDS)

Sets the field type to a DataSource, which allows you to model nested structures.

When the type of the field is a DataSource, then this field will have RecordList or Record values, depending on whether this field is multiple:true or not, respectively. The fields of this DataSource are called "nested fields". The nested fields are referred to when parsing DataSource responses for the DataSource corresponding to this DataSourceField.

JSON responses

When a field has nested fields, then the JSON value for the field should either be an object or an array of objects, depending on the value of multiple. If multiple is true, then the value should be an array; otherwise, the value should be an object.

Example JSON data source responses and corresponding DataSourceField configurations

	Example 1	Example 2
Data source response	{ "response": { "status": 0, "startRow": 0, "endRow": 1, "totalRows": 1, "data": [ { "nestedRecord": { "id": 7, "title": "Nest #7" } } ] } }	{ "response": { "status": 0, "startRow": 0, "endRow": 1, "totalRows": 1, "data": [ { "nestedRecords": [ { "id": 7, "title": "Nest #7" }, { "id": 91, "title": "Nest #91" }, { "id": 12, "title": "Nest #12" }, { "id": 2, "title": "Nest #2" } ] } ] } }
name	"nestedRecord"	"nestedRecords"
multiple	false	true

XML responses

If multiple is true, childTagName is still applicable. If not null, as in Example 3 below, childTagName is the name of subelements that will be parsed as records using the nested fields. Otherwise, as in Example 2 below, subelements of the record element having tag name name are collected and processed as the subelements.

Example XML data source responses and corresponding DataSourceField configurations

	Example 1	Example 2	Example 3
Data source response	<response> <status>0</status> <startRow>0</startRow> <endRow>1</endRow> <totalRows>1</totalRows> <data> <record> <nestedRecord> <id>7</id> <title>Nest #7</title> </nestedRecord> </record> </data> </response>	<response> <status>0</status> <startRow>0</startRow> <endRow>1</endRow> <totalRows>1</totalRows> <data> <record> <nestedRecord id="7" title="Nest #7"/> <nestedRecord id="91" title="Nest #91"/> <nestedRecord id="12" title="Nest #12"/> <nestedRecord id="2" title="Nest #2"/> </record> </data> </response>	<response> <status>0</status> <startRow>0</startRow> <endRow>1</endRow> <totalRows>1</totalRows> <data> <record> <nestedRecords> <nestedRecord id="7" title="Nest #7"/> <nestedRecord id="91" title="Nest #91"/> <nestedRecord id="12" title="Nest #12"/> <nestedRecord id="2" title="Nest #2"/> </nestedRecords> </record> </data> </response>
name	"nestedRecord"	"nestedRecord"	"nestedRecords"
multiple	false	true	true
childTagName	N/A	null	"nestedRecord"

See Also:

isMultiple(), getChildTagName()

getEditorType

public final java.lang.String getEditorType()

setEditorType

public final void setEditorType(java.lang.String editorType)

getHint

public final java.lang.String getHint()

setHint

public void setHint(java.lang.String hint)

setLength

public void setLength(java.lang.Long length)

getLength

public final java.lang.Integer getLength()

setTitle

public void setTitle(java.lang.String title)

getTitle

public final java.lang.String getTitle()

getShowTitle

public final java.lang.Boolean getShowTitle()

setShowTitle

public void setShowTitle(java.lang.Boolean showTitle)

setPrimaryKey

public void setPrimaryKey(java.lang.Boolean pk)

isPrimaryKey

public java.lang.Boolean isPrimaryKey()

setForeignKey

public void setForeignKey(java.lang.String fk)

getForeignKey

public java.lang.String getForeignKey()

setInapplicable

public void setInapplicable(java.lang.Boolean inapplicable)

isInapplicable

public java.lang.Boolean isInapplicable()

getValueMap

public final java.util.LinkedHashMap<?,java.lang.String> getValueMap()

setValueMap

public void setValueMap(java.util.LinkedHashMap<?,java.lang.String> valueMap)

getCanEdit

public final java.lang.Boolean getCanEdit()

setCanEdit

public final void setCanEdit(java.lang.Boolean canEdit)

getOnText

public final java.lang.String getOnText()

setOnText

public final void setOnText(java.lang.String onText)

getOffText

public final java.lang.String getOffText()

setOffText

public final void setOffText(java.lang.String offText)

getSubrecordsProperty

public final java.lang.String getSubrecordsProperty()

setSubrecordsProperty

public final void setSubrecordsProperty(java.lang.String subrecordsProperty)