com.smartgwt.mobile.client.data

Class DataSource

java.lang.Object

com.smartgwt.mobile.client.data.DataSource

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, HasHandleErrorHandlers, com.smartgwt.mobile.client.internal.data.events.HasDSDataChangedHandlers

public class DataSource
extends java.lang.Object
implements com.smartgwt.mobile.client.internal.data.events.HasDSDataChangedHandlers, HasHandleErrorHandlers

A minimal, standalone implementation of a SmartClient DataSource that communicates with the server using plain REST/HTTP messages and allows a pure GWT client to make use of the SmartClient Server without requiring any other client-side elements of SmartClient or SmartGWT. It is intended for applications that need to be as lightweight as possible, such as those intended to run on mobile phones and other limited devices

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	_deepCloneOnEdit
static int	_numDSRequestsSent
static boolean	_serializeTimeAsDatetime
static com.google.gwt.i18n.client.TimeZone	_UTC

Constructor Summary

Constructors

Constructor and Description
DataSource()
DataSource(java.lang.String ID)

Method Summary

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	_addDSDataChangedHandler(com.smartgwt.mobile.client.internal.data.events.DSDataChangedHandler handler)
protected com.google.gwt.event.shared.HandlerManager	_createHandlerManager()
protected com.google.gwt.event.shared.HandlerManager	_ensureHandlers()
java.lang.String	_getDataTagName()
java.lang.Boolean	_getDeepCloneOnEdit()
java.util.Map<java.lang.String,DataSourceField>	_getMergedFields()
java.lang.String	_getRecordName()
static OperationBinding	_makeDefaultOperation(DataSource dataSource, DSOperationType operationType, java.lang.String operationId)
java.lang.Object	_prepareData(java.lang.Object data)
static void	_register(java.lang.String ID, DataSource ds)
protected void	_sendGWTRequest(DSRequest dsRequest)
void	_setDeepCloneOnEdit(java.lang.Boolean deepCloneOnEdit)
void	addData(Record record)
void	addData(Record record, DSCallback callback)
void	addData(Record record, DSCallback callback, DSRequest props)
void	addField(DataSourceField field)
com.google.gwt.event.shared.HandlerRegistration	addHandleErrorHandler(HandleErrorHandler handler)
protected int	compareCriteria(Criteria newCriteria, Criteria oldCriteria)
protected static com.google.gwt.xml.client.Element	extractDataElement(com.google.gwt.xml.client.Element rootEl, java.lang.String dataTagName)
protected static java.util.List<com.google.gwt.xml.client.Element>	extractRecordElements(com.google.gwt.xml.client.Element dataEl, java.lang.String recordName)
protected RecordList	extractRecordList(com.google.gwt.json.client.JSONArray dataArr)
protected RecordList	extractRecordList(java.util.List<? extends com.google.gwt.xml.client.Node> recordNodes)
void	fetchData()
void	fetchData(Criteria criteria)
void	fetchData(Criteria criteria, DSCallback callback)
void	fetchData(Criteria criteria, DSCallback callback, DSRequest props)
void	fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)
protected static DataSource	fromConfig(com.google.gwt.core.client.JavaScriptObject configObj)
static DataSource	fromJSON(java.lang.String jsonText) Parses a JSON string containing one or more DataSource definitions.
java.lang.String	getAddDataURL()
java.lang.Boolean	getAutoDeriveSchema()
java.lang.String	getCallbackParam()
java.lang.String	getCriteriaPolicy()
java.lang.String	getCustomDataURL()
java.lang.String	getDataField()
DSProtocol	getDataProtocol()
static DataSource	getDataSource(java.lang.String ID)
java.lang.String	getDataTagName()
java.lang.String	getDataURL()
static java.lang.String	getDefaultDataURL()
java.lang.String	getDescriptionField()
java.lang.Boolean	getDropExtraFields()
java.lang.String	getFetchDataURL()
DataSourceField	getField(java.lang.String fieldName) Return the field definition object.
java.lang.String[]	getFieldNames()
java.lang.String[]	getFieldNames(boolean excludeHidden)
DataSourceField[]	getFields()
java.lang.String	getIconField()
java.lang.String	getID()
java.lang.String	getInfoField()
java.lang.String	getInheritsFrom()
java.lang.String	getJsonPrefix()
java.lang.String	getJsonSuffix()
static java.lang.String	getLoaderUrl()
java.lang.String	getMetaDataPrefix() If sendMetaData is true and OperationBinding.dataProtocol is DSProtocol.GETPARAMS or DSProtocol.POSTPARAMS, then this is the prefix that is added to meta data property names.
protected OperationBinding	getOperationBinding(DSOperationType operationType, java.lang.String operationId)
protected OperationBinding	getOperationBinding(DSRequest dsRequest)
protected OperationBinding[]	getOperationBindings()
java.lang.String	getPluralTitle()
java.lang.Boolean	getPreventHTTPCaching()
DataSourceField	getPrimaryKeyField() Returns a pointer to the primaryKey field for this DataSource
java.lang.String	getPrimaryKeyFieldName() Returns the primary key fieldName for this DataSource
java.lang.Boolean	getQualifyColumnNames()
java.lang.String	getRecordName()
java.lang.String	getRemoveDataURL()
java.util.Map<java.lang.String,java.lang.Object>	getRequestProperties()
java.lang.String	getRequiredMessage()
java.lang.Boolean	getSendExtraFields()
boolean	getSendMetaData() If true, meta data will be included in the parameters sent to the server, with each meta data parameter prefixed with metaDataPrefix.
java.lang.String	getServerConstructor()
java.lang.Boolean	getShowLocalFieldsOnly()
java.lang.Boolean	getShowPrompt()
java.lang.Boolean	getStrictJSON() Controls whether this DataSource will strictly conform to the JSON data format when serializing JSON.
java.lang.Boolean	getStrictSQLFiltering()
java.lang.String	getTitle()
java.lang.String	getTitleField()
java.lang.String	getUpdateDataURL()
Record[]	getUpdatedData(DSRequest dsRequest, DSResponse dsResponse)
Record[]	getUpdatedData(DSRequest dsRequest, DSResponse dsResponse, boolean useDataFromRequest)
java.lang.Boolean	getUseFlatFields()
java.lang.Boolean	getUseParentFieldOrder()
java.lang.String	getValidateDataURL()
java.lang.Boolean	getValidateRelatedRecords()
void	hidePrompt(com.google.gwt.user.client.ui.PopupPanel prompt)
static boolean	isUpdateOperation(DSOperationType opType)
static void	load(java.lang.String ID, LoadDSCallback callback)
static void	loadDataSource(java.lang.String ID, LoadDSCallback callback)
static void	loadWithParents(java.lang.String ID, LoadDSCallback callback)
void	performCustomOperation(java.lang.String operationId, Record data, DSCallback callback, DSRequest props)
boolean	propertyMatches(java.lang.Object property, java.lang.Object criterion, TextMatchStyle style)
boolean	recordMatchesCriteria(Record record, Criteria criteria, TextMatchStyle style)
void	removeData(Record record)
void	removeData(Record record, DSCallback callback)
void	removeData(Record record, DSCallback callback, DSRequest props)
void	sendRequest(DSRequest dsRequest)
void	setAddDataURL(java.lang.String dataURL)
void	setAutoDeriveSchema(java.lang.Boolean autoDeriveSchema)
void	setCallbackParam(java.lang.String callbackParam)
void	setCriteriaPolicy(java.lang.String criteriaPolicy)
void	setCustomDataURL(java.lang.String dataURL)
void	setDataField(java.lang.String dataField)
void	setDataProtocol(DSProtocol dataProtocol)
void	setDataTagName(java.lang.String dataTagName)
void	setDataURL(java.lang.String dataURL)
static void	setDefaultDataURL(java.lang.String value)
void	setDescriptionField(java.lang.String descriptionField)
void	setDropExtraFields(java.lang.Boolean dropExtraFields)
void	setFetchDataURL(java.lang.String dataURL)
void	setFields(DataSourceField... fieldDefs)
void	setIconField(java.lang.String iconField)
void	setID(java.lang.String id)
void	setInfoField(java.lang.String infoField)
void	setInheritsFrom(DataSource parentDataSource)
void	setInheritsFrom(java.lang.String parentDataSourceID)
void	setJsonPrefix(java.lang.String jsonPrefix)
void	setJsonSuffix(java.lang.String jsonSuffix)
static void	setLoaderUrl(java.lang.String loaderUrl)
void	setMetaDataPrefix(java.lang.String metaDataPrefix) Setter for metaDataPrefix.
void	setOperationBindings(OperationBinding... operationBindings)
void	setPluralTitle(java.lang.String pluralTitle)
void	setPreventHTTPCaching(java.lang.Boolean preventHTTPCaching)
void	setQualifyColumnNames(java.lang.Boolean qualifyColumnNames)
void	setRecordName(java.lang.String recordName)
void	setRemoveDataURL(java.lang.String dataURL)
void	setRequestProperties(DSRequest requestProperties)
void	setRequestProperties(java.util.Map<java.lang.String,java.lang.Object> requestProperties)
void	setRequiredMessage(java.lang.String requiredMessage)
void	setSendExtraFields(java.lang.Boolean sendExtraFields)
void	setSendMetaData(java.lang.Boolean sendMetaData) Setter for sendMetaData.
void	setServerConstructor(java.lang.String serverConstructor)
void	setShowLocalFieldsOnly(java.lang.Boolean showLocalFieldsOnly)
void	setShowPrompt(java.lang.Boolean showPrompt)
void	setStrictJSON(java.lang.Boolean strictJSON)
void	setStrictSQLFiltering(java.lang.Boolean strictSQLFiltering)
void	setTitle(java.lang.String title)
void	setTitleField(java.lang.String titleField)
void	setUpdateDataURL(java.lang.String dataURL)
void	setUseFlatFields(java.lang.Boolean useFlatFields)
void	setUseParentFieldOrder(java.lang.Boolean useParentFieldOrder)
void	setValidateDataURL(java.lang.String dataURL)
void	setValidateRelatedRecords(java.lang.Boolean validateRelatedRecords)
com.google.gwt.user.client.ui.PopupPanel	showPrompt()
protected java.lang.Object	transformRequest(DSRequest dsRequest) Transforms DSRequest metadata into a format understood by the server.
protected void	transformResponse(DSResponse response, DSRequest request, java.lang.Object data) Transforms service-specific metadata to DSResponse metadata.
void	updateCaches(DSResponse dsResponse)
void	updateCaches(DSResponse dsResponse, DSRequest dsRequest)
void	updateData(Record record)
void	updateData(Record record, DSCallback callback)
void	updateData(Record record, DSCallback callback, DSRequest props)
void	validateData(Record data, DSCallback callback)

Methods inherited from class java.lang.Object

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

Field Detail

_deepCloneOnEdit

@SGWTInternal
public static boolean _deepCloneOnEdit

_numDSRequestsSent

@SGWTInternal
public static int _numDSRequestsSent

_serializeTimeAsDatetime

@SGWTInternal
public static boolean _serializeTimeAsDatetime

_UTC

@SGWTInternal
public static final com.google.gwt.i18n.client.TimeZone _UTC

Constructor Detail

DataSource

public DataSource()

DataSource

public DataSource(java.lang.String ID)

Method Detail

_makeDefaultOperation

@SGWTInternal
public static OperationBinding _makeDefaultOperation(DataSource dataSource,
                                                                   DSOperationType operationType,
                                                                   java.lang.String operationId)

setID

public void setID(java.lang.String id)

getID

public final java.lang.String getID()

setAutoDeriveSchema

public void setAutoDeriveSchema(java.lang.Boolean autoDeriveSchema)

getAutoDeriveSchema

public java.lang.Boolean getAutoDeriveSchema()

setCallbackParam

public void setCallbackParam(java.lang.String callbackParam)

getCallbackParam

public java.lang.String getCallbackParam()

setCriteriaPolicy

public void setCriteriaPolicy(java.lang.String criteriaPolicy)

getCriteriaPolicy

public java.lang.String getCriteriaPolicy()

getDataProtocol

public final DSProtocol getDataProtocol()

setDataProtocol

public void setDataProtocol(DSProtocol dataProtocol)

setDataURL

public void setDataURL(java.lang.String dataURL)

getDataURL

public final java.lang.String getDataURL()

_getDeepCloneOnEdit

@SGWTInternal
public final java.lang.Boolean _getDeepCloneOnEdit()

_setDeepCloneOnEdit

@SGWTInternal
public void _setDeepCloneOnEdit(java.lang.Boolean deepCloneOnEdit)

setFetchDataURL

public void setFetchDataURL(java.lang.String dataURL)

getFetchDataURL

public java.lang.String getFetchDataURL()

setAddDataURL

public void setAddDataURL(java.lang.String dataURL)

getAddDataURL

public java.lang.String getAddDataURL()

setUpdateDataURL

public void setUpdateDataURL(java.lang.String dataURL)

getUpdateDataURL

public java.lang.String getUpdateDataURL()

setRemoveDataURL

public void setRemoveDataURL(java.lang.String dataURL)

getRemoveDataURL

public java.lang.String getRemoveDataURL()

getValidateDataURL

public java.lang.String getValidateDataURL()

setValidateDataURL

public void setValidateDataURL(java.lang.String dataURL)

getCustomDataURL

public java.lang.String getCustomDataURL()

setCustomDataURL

public void setCustomDataURL(java.lang.String dataURL)

getDataTagName

public final java.lang.String getDataTagName()

_getDataTagName

@SGWTInternal
public final java.lang.String _getDataTagName()

setDataTagName

public void setDataTagName(java.lang.String dataTagName)

setDropExtraFields

public void setDropExtraFields(java.lang.Boolean dropExtraFields)

getDropExtraFields

public java.lang.Boolean getDropExtraFields()

setIconField

public void setIconField(java.lang.String iconField)

getIconField

public java.lang.String getIconField()

setDataField

public void setDataField(java.lang.String dataField)

getDataField

public java.lang.String getDataField()

setJsonPrefix

public void setJsonPrefix(java.lang.String jsonPrefix)

getJsonPrefix

public final java.lang.String getJsonPrefix()

setJsonSuffix

public void setJsonSuffix(java.lang.String jsonSuffix)

getJsonSuffix

public final java.lang.String getJsonSuffix()

setPluralTitle

public void setPluralTitle(java.lang.String pluralTitle)

getPluralTitle

public java.lang.String getPluralTitle()

setPreventHTTPCaching

public void setPreventHTTPCaching(java.lang.Boolean preventHTTPCaching)

getPreventHTTPCaching

public java.lang.Boolean getPreventHTTPCaching()

setQualifyColumnNames

public void setQualifyColumnNames(java.lang.Boolean qualifyColumnNames)

getQualifyColumnNames

public java.lang.Boolean getQualifyColumnNames()

getRecordName

public final java.lang.String getRecordName()

_getRecordName

@SGWTInternal
public final java.lang.String _getRecordName()

setRecordName

public void setRecordName(java.lang.String recordName)

setRequiredMessage

public void setRequiredMessage(java.lang.String requiredMessage)

getRequiredMessage

public java.lang.String getRequiredMessage()

setSendExtraFields

public void setSendExtraFields(java.lang.Boolean sendExtraFields)

getSendExtraFields

public java.lang.Boolean getSendExtraFields()

setServerConstructor

public void setServerConstructor(java.lang.String serverConstructor)

getServerConstructor

public java.lang.String getServerConstructor()

setShowLocalFieldsOnly

public void setShowLocalFieldsOnly(java.lang.Boolean showLocalFieldsOnly)

getShowLocalFieldsOnly

public java.lang.Boolean getShowLocalFieldsOnly()

setShowPrompt

public void setShowPrompt(java.lang.Boolean showPrompt)

getShowPrompt

public java.lang.Boolean getShowPrompt()

setStrictSQLFiltering

public void setStrictSQLFiltering(java.lang.Boolean strictSQLFiltering)

getStrictSQLFiltering

public java.lang.Boolean getStrictSQLFiltering()

setTitle

public void setTitle(java.lang.String title)

getTitle

public java.lang.String getTitle()

setTitleField

public void setTitleField(java.lang.String titleField)

getTitleField

public java.lang.String getTitleField()

setInfoField

public void setInfoField(java.lang.String infoField)

getInfoField

public java.lang.String getInfoField()

setDescriptionField

public void setDescriptionField(java.lang.String descriptionField)

getDescriptionField

public java.lang.String getDescriptionField()

setInheritsFrom

public void setInheritsFrom(DataSource parentDataSource)

setInheritsFrom

public void setInheritsFrom(java.lang.String parentDataSourceID)

getInheritsFrom

public java.lang.String getInheritsFrom()

setUseFlatFields

public void setUseFlatFields(java.lang.Boolean useFlatFields)

getUseFlatFields

public java.lang.Boolean getUseFlatFields()

setUseParentFieldOrder

public void setUseParentFieldOrder(java.lang.Boolean useParentFieldOrder)

getUseParentFieldOrder

public java.lang.Boolean getUseParentFieldOrder()

setValidateRelatedRecords

public void setValidateRelatedRecords(java.lang.Boolean validateRelatedRecords)

getValidateRelatedRecords

public java.lang.Boolean getValidateRelatedRecords()

setRequestProperties

public void setRequestProperties(java.util.Map<java.lang.String,java.lang.Object> requestProperties)

getRequestProperties

public java.util.Map<java.lang.String,java.lang.Object> getRequestProperties()

getStrictJSON

public final java.lang.Boolean getStrictJSON()

Controls whether this DataSource will strictly conform to the JSON data format when serializing JSON.

If this attribute is not true, then JSON data generated for data source requests will be in a more relaxed JSON format in the sense that only '\b', '\t', '\n', '\f', '\r', '"', and '\\' are escaped within string literals. If this attribute is true, then all Unicode control characters (those having the Cc character property), '"', and '\\' are escaped.

The effect of this attribute is not the same as Smart GWT's DataSource.useStrictJSON. SGWT DataSource.useStrictJSON controls the server's conformance to the JSON format whereas SGWT.mobile DataSource.strictJSON controls the client's conformance. SGWT.mobile always requires strict JSON from the server, and will send useStrictJSON=true with requests.

Returns:

whether strict JSON is used. Default value: false

See Also:

Unicode Characters in the 'Other, Control' Category

setStrictJSON

public void setStrictJSON(java.lang.Boolean strictJSON)

_getMergedFields

@SGWTInternal
public java.util.Map<java.lang.String,DataSourceField> _getMergedFields()

getField

public DataSourceField getField(java.lang.String fieldName)

Return the field definition object.

Parameters:

fieldName - Name of the field to retrieve

Returns:

DataSourceField field object

getPrimaryKeyField

public DataSourceField getPrimaryKeyField()

Returns a pointer to the primaryKey field for this DataSource

Returns:

primary key field object

getPrimaryKeyFieldName

public java.lang.String getPrimaryKeyFieldName()

Returns the primary key fieldName for this DataSource

Returns:

primary key field name

compareCriteria

protected int compareCriteria(Criteria newCriteria,
                              Criteria oldCriteria)

performCustomOperation

public void performCustomOperation(java.lang.String operationId,
                                   Record data,
                                   DSCallback callback,
                                   DSRequest props)

validateData

public void validateData(Record data,
                         DSCallback callback)

fetchData

public void fetchData()

fetchData

public void fetchData(Criteria criteria)

fetchData

public void fetchData(Criteria criteria,
                      DSCallback callback)

fetchData

public void fetchData(Criteria criteria,
                      DSCallback callback,
                      DSRequest props)

addData

public void addData(Record record,
                    DSCallback callback,
                    DSRequest props)

addData

public void addData(Record record,
                    DSCallback callback)

addData

public void addData(Record record)

updateData

public void updateData(Record record,
                       DSCallback callback,
                       DSRequest props)

updateData

public void updateData(Record record,
                       DSCallback callback)

updateData

public void updateData(Record record)

removeData

public void removeData(Record record,
                       DSCallback callback,
                       DSRequest props)

removeData

public void removeData(Record record,
                       DSCallback callback)

removeData

public void removeData(Record record)

sendRequest

public void sendRequest(DSRequest dsRequest)

extractDataElement

protected static com.google.gwt.xml.client.Element extractDataElement(com.google.gwt.xml.client.Element rootEl,
                                                                      java.lang.String dataTagName)

extractRecordElements

protected static java.util.List<com.google.gwt.xml.client.Element> extractRecordElements(com.google.gwt.xml.client.Element dataEl,
                                                                                         java.lang.String recordName)

extractRecordList

protected RecordList extractRecordList(java.util.List<? extends com.google.gwt.xml.client.Node> recordNodes)

extractRecordList

protected RecordList extractRecordList(com.google.gwt.json.client.JSONArray dataArr)

_sendGWTRequest

@SGWTInternal
protected void _sendGWTRequest(DSRequest dsRequest)

showPrompt

public com.google.gwt.user.client.ui.PopupPanel showPrompt()

hidePrompt

public void hidePrompt(com.google.gwt.user.client.ui.PopupPanel prompt)

updateCaches

public void updateCaches(DSResponse dsResponse)

updateCaches

public void updateCaches(DSResponse dsResponse,
                         DSRequest dsRequest)

setOperationBindings

public void setOperationBindings(OperationBinding... operationBindings)

getOperationBindings

protected OperationBinding[] getOperationBindings()

getOperationBinding

protected OperationBinding getOperationBinding(DSRequest dsRequest)

getOperationBinding

protected OperationBinding getOperationBinding(DSOperationType operationType,
                                               java.lang.String operationId)

getSendMetaData

public boolean getSendMetaData()

If true, meta data will be included in the parameters sent to the server, with each meta data parameter prefixed with metaDataPrefix. Applies only when OperationBinding.dataProtocol is DSProtocol.GETPARAMS or DSProtocol.POSTPARAMS.

Returns:

whether to send operation meta data with the parameters. Default value: true.

setSendMetaData

public void setSendMetaData(java.lang.Boolean sendMetaData)

Setter for sendMetaData.

getMetaDataPrefix

public java.lang.String getMetaDataPrefix()

If sendMetaData is true and OperationBinding.dataProtocol is DSProtocol.GETPARAMS or DSProtocol.POSTPARAMS, then this is the prefix that is added to meta data property names.

Returns:

the meta data prefix. Default value: "_".

setMetaDataPrefix

public void setMetaDataPrefix(java.lang.String metaDataPrefix)

Setter for metaDataPrefix.

transformRequest

protected java.lang.Object transformRequest(DSRequest dsRequest)

Transforms DSRequest metadata into a format understood by the server.

The following table lists the return type expected by DataSource:

OperationBinding.dataFormat	OperationBinding.dataProtocol	Expected return type
ISCSERVER	N/A	Object, suitable for serialization
XML, JSON, CUSTOM	GETPARAMS, POSTPARAMS	Map<String, Object>
	POSTMESSAGE	String
	POSTXML	String or Document

An implementation may augment dsRequest with additional DSRequest metadata such as by adding to DSRequest.params.

Parameters:

dsRequest - (in/out) the DSRequest to transform.

Returns:

the transformed data.

_prepareData

@SGWTInternal
public java.lang.Object _prepareData(java.lang.Object data)

getUpdatedData

public Record[] getUpdatedData(DSRequest dsRequest,
                               DSResponse dsResponse)

getUpdatedData

public Record[] getUpdatedData(DSRequest dsRequest,
                               DSResponse dsResponse,
                               boolean useDataFromRequest)

transformResponse

protected void transformResponse(DSResponse response,
                                 DSRequest request,
                                 java.lang.Object data)

Transforms service-specific metadata to DSResponse metadata.

The following table lists the type of data:

OperationBinding.dataFormat	Type of data
ISCSERVER, JSON	Map<String, Object>, as returned by JSONUtils.serverResponseToMap(String).
XML	Element, representing the root element, or "document element" of the response document.
CUSTOM	String, the contents of the HTTP response body

NOTE: data may be null if the request was not successful. For example, if dataFormat is XML, but the server response was HTTP 403 Forbidden, then there usually is no response body to parse into a Document.

Parameters:

response - (in/out) the DSResponse to transform.

request - (in) the DSRequest resulting in a data source response.

data - (in) data from the server.

setRequestProperties

public void setRequestProperties(DSRequest requestProperties)
                          throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

setFields

public void setFields(DataSourceField... fieldDefs)
               throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

addField

public void addField(DataSourceField field)
              throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

getFields

public DataSourceField[] getFields()

getFieldNames

public java.lang.String[] getFieldNames()

getFieldNames

public java.lang.String[] getFieldNames(boolean excludeHidden)

recordMatchesCriteria

public boolean recordMatchesCriteria(Record record,
                                     Criteria criteria,
                                     TextMatchStyle style)

propertyMatches

public boolean propertyMatches(java.lang.Object property,
                               java.lang.Object criterion,
                               TextMatchStyle style)

_createHandlerManager

@SGWTInternal
protected com.google.gwt.event.shared.HandlerManager _createHandlerManager()

_ensureHandlers

@SGWTInternal
protected final com.google.gwt.event.shared.HandlerManager _ensureHandlers()

_addDSDataChangedHandler

public com.google.gwt.event.shared.HandlerRegistration _addDSDataChangedHandler(com.smartgwt.mobile.client.internal.data.events.DSDataChangedHandler handler)

Specified by:

_addDSDataChangedHandler in interface com.smartgwt.mobile.client.internal.data.events.HasDSDataChangedHandlers

fireEvent

public final void fireEvent(com.google.gwt.event.shared.GwtEvent<?> event)

Specified by:

fireEvent in interface com.google.gwt.event.shared.HasHandlers

_register

@SGWTInternal
public static void _register(java.lang.String ID,
                                           DataSource ds)

getDataSource

public static DataSource getDataSource(java.lang.String ID)

load

public static void load(java.lang.String ID,
                        LoadDSCallback callback)

loadWithParents

public static void loadWithParents(java.lang.String ID,
                                   LoadDSCallback callback)

loadDataSource

public static void loadDataSource(java.lang.String ID,
                                  LoadDSCallback callback)

fromJSON

public static DataSource fromJSON(java.lang.String jsonText)

Parses a JSON string containing one or more DataSource definitions. This method returns the first DataSource that is defined in the JSON. The remaining DataSources will be accessible via getDataSource().

fromJSON() requires that the input JSON be in the same form as the JSON returned by the DataSourceLoader servlet. This method is an alternative to load(), loadDataSource(), or loadWithParents() because it allows the loading of DataSources from a cached copy of DataSourceLoader output.

Parameters:

jsonText - a JSON string

Returns:

the first DataSource defined in the JSON, or null if no DataSource is defined.

fromConfig

protected static DataSource fromConfig(com.google.gwt.core.client.JavaScriptObject configObj)

setDefaultDataURL

public static void setDefaultDataURL(java.lang.String value)

getDefaultDataURL

public static java.lang.String getDefaultDataURL()

setLoaderUrl

public static void setLoaderUrl(java.lang.String loaderUrl)

getLoaderUrl

public static java.lang.String getLoaderUrl()

isUpdateOperation

public static boolean isUpdateOperation(DSOperationType opType)

addHandleErrorHandler

public com.google.gwt.event.shared.HandlerRegistration addHandleErrorHandler(HandleErrorHandler handler)

Specified by:

addHandleErrorHandler in interface HasHandleErrorHandlers