com.softwareag.mobile.runtime.toolkit.rest

Class JSONDatasource

java.lang.Object

com.softwareag.mobile.runtime.toolkit.util.Observable

com.softwareag.mobile.runtime.toolkit.delegates.AbstractListViewDatasource

com.softwareag.mobile.runtime.toolkit.rest.JSONDatasource

All Implemented Interfaces:

IListViewDatasource, IServiceDelegate

public class JSONDatasource
extends AbstractListViewDatasource
implements IServiceDelegate

A JSONDatasource provides a IListViewDatasource implementation to manage and represent a data model based on JSON data to be used in ListViews.

Version:

9.6.0.0000-0237

Constructor Summary

Constructors

Constructor and Description
JSONDatasource(AbstractRestOperation jsonRequest, java.lang.String expression) Creates a new JSONDatasource from a given AbstractRestOperation and a JPath expression referencing the root object within the JSON data structure.
JSONDatasource(java.lang.String restData) Creates a new JSONDatasource with a String of JSON formatted data.
JSONDatasource(java.lang.String restData, java.lang.String expression) Creates a new JSONDatasource with a String of JSON formatted data and a JPath expression referencing the root object within the JSON data structure.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getExpressionValue(java.lang.String rootExpression) Call this method to get the object of the data model using an expression.
java.lang.Object	getExpressionValue(java.lang.String relativeExpression, int index) Call this method to get the object of the data model using an expression that is relative to on object in the data model with the given row index.
JPath	getRootJPath() Get the JPath object representing the root expression.
java.lang.String	getRootPathExpression() Returns the expression used to identify the root object within the JSON data structure.
void	init(org.json.me.JSONObject jsonObject) Initializes the data source with a JSONObject representing the JSON data structure..
void	init(java.lang.String restData) Initializes the data source with a JSON data structure as String.
void	onOperationFailed(AbstractRestOperation operation) Notifies this listener that the watched AbstractRestOperation failed.
void	onOperationFinished(AbstractRestOperation operation) Notifies this listener that the watched AbstractRestOperation finished.
void	reloadElements() Use to reload the objects managed by the datasource.
void	setRootPathExpression(java.lang.String rootPathExpression) Set a new expression to identify the root object within the JSON data structure.

Methods inherited from class com.softwareag.mobile.runtime.toolkit.delegates.AbstractListViewDatasource

addElement, addElementAtIndex, addElements, compare, getComparator, getElementAtIndex, getElements, getFilterExpression, getNumberOfElements, getSelectedElement, removeAllElements, removeElement, removeElementAtIndex, resort, setComparator, setFilterExpression, setSelectedElement

Methods inherited from class com.softwareag.mobile.runtime.toolkit.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONDatasource

public JSONDatasource(java.lang.String restData)

Creates a new JSONDatasource with a String of JSON formatted data.

Parameters:

restData - the json data to be used to initialize the datasource.

JSONDatasource

public JSONDatasource(java.lang.String restData,
              java.lang.String expression)

Creates a new JSONDatasource with a String of JSON formatted data and a JPath expression referencing the root object within the JSON data structure. The root object will be used for all other expressions.

Parameters:

restData - the json data to be used to initialize the datasource.

expression - a JPath expression to set the root object for the datasource

JSONDatasource

public JSONDatasource(AbstractRestOperation jsonRequest,
              java.lang.String expression)

Creates a new JSONDatasource from a given AbstractRestOperation and a JPath expression referencing the root object within the JSON data structure. The root object will be used for all other expressions. As soon as the service request finished loading the datasource will be initialized and all Observer objects will be notified of the changes available.

Parameters:

jsonRequest - the request to load the JSON data

expression - a JPath expression to set the root object for the datasource

Method Detail

init

public void init(java.lang.String restData)

Initializes the data source with a JSON data structure as String.

Parameters:

restData - the JSON data to be used

init

public void init(org.json.me.JSONObject jsonObject)

Initializes the data source with a JSONObject representing the JSON data structure..

Parameters:

jsonObject - the JSONObject to be used to initialize the datasource.

reloadElements

public void reloadElements()

Description copied from interface: IListViewDatasource

Use to reload the objects managed by the datasource.

Specified by:

reloadElements in interface IListViewDatasource

Specified by:

reloadElements in class AbstractListViewDatasource

getRootPathExpression

public java.lang.String getRootPathExpression()

Returns the expression used to identify the root object within the JSON data structure. Use JPath expressions and syntax.

Returns:

the expression representing the root object in the JSON data structure

setRootPathExpression

public void setRootPathExpression(java.lang.String rootPathExpression)

Set a new expression to identify the root object within the JSON data structure. If null, the expressions are evaluated on the entire data structue.

Parameters:

rootPathExpression - the new JPath root expression

getRootJPath

public JPath getRootJPath()

Get the JPath object representing the root expression. Use this object to get data from the JSON data structure.

Returns:

the JPath object representing the root object

getExpressionValue

public java.lang.Object getExpressionValue(java.lang.String rootExpression)
                                    throws java.lang.Exception

Description copied from interface: IListViewDatasource

Call this method to get the object of the data model using an expression. An expression can be any String an IListViewDatasource implementation uses to reference an object.

Specified by:

getExpressionValue in interface IListViewDatasource

Specified by:

getExpressionValue in class AbstractListViewDatasource

Parameters:

rootExpression - String that references an object in the data model

Returns:

the object for the given expression or null if there was no object

Throws:

java.lang.Exception - if an error occured evaluating the given expression

getExpressionValue

public java.lang.Object getExpressionValue(java.lang.String relativeExpression,
                                  int index)
                                    throws java.lang.Exception

Description copied from interface: IListViewDatasource

Call this method to get the object of the data model using an expression that is relative to on object in the data model with the given row index. An expression can be any String an IListViewDatasource implementation uses to reference an object.

Specified by:

getExpressionValue in interface IListViewDatasource

Specified by:

getExpressionValue in class AbstractListViewDatasource

index - the index of the object to be used to evaluate the given expression

Returns:

the object for the given expression or null if there was no object

Throws:

java.lang.Exception - if an error occured evaluating the given expression

onOperationFinished

public void onOperationFinished(AbstractRestOperation operation)

Description copied from interface: IServiceDelegate

Notifies this listener that the watched AbstractRestOperation finished.
Use the AbstractRestOperation.getResponseCode() to validate the success of the operation. E.g.:

 switch (operation.getResponseCode()) {
 case HttpConnection.HTTP_OK:
        break;
 case HttpConnection.HTTP_FORBIDDEN:
        break;
 }
 

Specified by:

onOperationFinished in interface IServiceDelegate

Parameters:

operation - The watched AbstractRestOperation.

onOperationFailed

public void onOperationFailed(AbstractRestOperation operation)

Description copied from interface: IServiceDelegate

Notifies this listener that the watched AbstractRestOperation failed. This only indicates an exception during the communication and does not represent the HTTP status code.

Specified by:

onOperationFailed in interface IServiceDelegate

Parameters:

operation - The watched AbstractRestOperation.