com.softwareag.mobile.runtime.toolkit.delegates

Class AbstractListDatasource

java.lang.Object

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

com.softwareag.mobile.runtime.toolkit.delegates.AbstractListDatasource

All Implemented Interfaces:

IDatasource, IListDatasource

Direct Known Subclasses:

JSONDatasource

public abstract class AbstractListDatasource
extends Observable
implements IListDatasource

Abstract base implementation of an IListDatasource based on a Vector to manage its data model. It uses Observable to notify changes to a number of Observer.

Version:

9.8.0.0000-0080

Constructor Summary

Constructors

Constructor and Description
AbstractListDatasource()
AbstractListDatasource(Observer observer)

Method Summary

Modifier and Type	Method and Description
void	addElement(java.lang.Object object) Add a new object to the data model.
void	addElementAtIndex(java.lang.Object object, int index) Insert a new object to the data model at the given row index.
void	addElements(java.util.Vector objects) Add multiple new objects to the data model.
int	compare(java.lang.Object o1, java.lang.Object o2)
IComparator	getComparator() Use this method to get the current IComparator used by the ListView.
java.lang.Object	getElementAtIndex(int index) Call this method to get the object of the data model at a given index.
java.util.Vector	getElements() Call this method to get all objects in the data model managed by this datasource.
DatasourceException	getException() Use this method to get the last exception that has been caught while reloading the datasource.
abstract java.lang.Object	getExpressionValue(java.lang.String rootExpression) This method is used to retrieve an object from the data model using an expression.
abstract java.lang.Object	getExpressionValue(java.lang.String relativeExpression, int elementIndex) This method is used to get the object from the data model using an expression that is relative to on object in the data model with the given row index.
java.util.Vector	getFilteredElements() Returns all elements matching the IListDatasource.getFilterExpression().
java.lang.String	getFilterExpression() Returns the filter expression currently used.
int	getNumberOfElements() Call this method to get the total number of objects in the data model managed by this datasource.
java.lang.Object	getSelectedElement() Returns the currently selected object of the ListView or null if no object was set as selected.
boolean	hasException() Use this method to check for exceptions that might have been caught while reloading the datasource.
boolean	isFilteredElement(java.lang.Object object) Returns true if the given object matches the filter for this datasource returned by IListDatasource.getFilterExpression().
abstract void	reloadElements() Use to reload the objects managed by the datasource.
void	removeAllElements() Removes all objects from the data model.
void	removeElement(java.lang.Object object) Remove the given object from the data model.
void	removeElementAtIndex(int index) Remove the object at the given index of the data model.
void	resort() Call this method to manually resort the contents of the data model.
void	setComparator(IComparator comparator) Use this method to set a IComparator implementation to be used when sorting or resorting the data model represention in the ListView.
void	setElements(java.util.Vector objects) Set the elements managed by the datasource to the given Vector of objects.
abstract void	setExpressionValue(java.lang.String rootExpression, java.lang.Object value) This method is used to update an object in the data model.
abstract void	setExpressionValue(java.lang.String relativeExpression, java.lang.Object value, int elementIndex) This method is used to set the object in the data model using an expression that is relative to on object in the data model with the given row index.
void	setFilterExpression(java.lang.String valueFilter) Use this method to set a filter expression and enable filtering for the datasource.
void	setSelectedElement(java.lang.Object object) Set the object selected by the ListView.

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

addObserver, deleteObserver, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractListDatasource

public AbstractListDatasource()

AbstractListDatasource

public AbstractListDatasource(Observer observer)

Method Detail

getFilterExpression

public java.lang.String getFilterExpression()

Description copied from interface: IListDatasource

Returns the filter expression currently used. If no filter expression is used, null will be returned

Specified by:

getFilterExpression in interface IListDatasource

Returns:

the filter expression currently used

setFilterExpression

public void setFilterExpression(java.lang.String valueFilter)

Description copied from interface: IListDatasource

Use this method to set a filter expression and enable filtering for the datasource. If filtering is enabled, only the objects matching the filter expression will be returned by IListDatasource.getNumberOfElements(), IListDatasource.getElements(), etc. You typically use filter to implement searches in a . An expression can be any String an IListDatasource implementation uses to reference an object.

Specified by:

setFilterExpression in interface IListDatasource

Parameters:

valueFilter - the filter string the datasource uses to filter it's content

getFilteredElements

public java.util.Vector getFilteredElements()

Description copied from interface: IListDatasource

Returns all elements matching the IListDatasource.getFilterExpression(). If no filter is set, all elements will be returned. If the datasource content is changed, on the next call of this method the filter is applied first before returning the result.

Specified by:

getFilteredElements in interface IListDatasource

Returns:

the elements matching the IListDatasource.getFilterExpression() or all elements if IListDatasource.getFilterExpression() returns null

isFilteredElement

public boolean isFilteredElement(java.lang.Object object)

Description copied from interface: IListDatasource

Returns true if the given object matches the filter for this datasource returned by IListDatasource.getFilterExpression(). You need to implement this method specifically for your datasource and the object types managed.

Specified by:

isFilteredElement in interface IListDatasource

Parameters:

object - the object to test if it matches IListDatasource.getFilterExpression()

Returns:

true if the filter returned by IListDatasource.getFilterExpression() matches the object, false if it does not

getElements

public java.util.Vector getElements()

Description copied from interface: IListDatasource

Call this method to get all objects in the data model managed by this datasource. Changing the Vector returned will not change the contents of the data model.

Specified by:

getElements in interface IListDatasource

Returns:

all objects in the data model

getNumberOfElements

public int getNumberOfElements()

Description copied from interface: IListDatasource

Call this method to get the total number of objects in the data model managed by this datasource.

Specified by:

getNumberOfElements in interface IListDatasource

Returns:

the total number of objects

getExpressionValue

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

Description copied from interface: IDatasource

This method is used to retrieve an object from the data model using an expression.
An expression can be any String an IDatasource implementation uses to reference an object.

Specified by:

getExpressionValue in interface IDatasource

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 abstract java.lang.Object getExpressionValue(java.lang.String relativeExpression,
                                                    int elementIndex)
                                             throws java.lang.Exception

Description copied from interface: IListDatasource

This method is used to get the object from 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 IDatasource implementation uses to reference an object.

Specified by:

getExpressionValue in interface IListDatasource

elementIndex - 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

setExpressionValue

public abstract void setExpressionValue(java.lang.String rootExpression,
                                        java.lang.Object value)
                                 throws java.lang.Exception

Description copied from interface: IDatasource

This method is used to update an object in the data model.
An expression can be any String an IDatasource implementation uses to reference an object.

Specified by:

setExpressionValue in interface IDatasource

Parameters:

rootExpression - String that references an object in the data model

value - new object value for the given expression

Throws:

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

setExpressionValue

public abstract void setExpressionValue(java.lang.String relativeExpression,
                                        java.lang.Object value,
                                        int elementIndex)
                                 throws java.lang.Exception

Description copied from interface: IListDatasource

This method is used to set the object in 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 IDatasource implementation uses to reference an object.

Specified by:

setExpressionValue in interface IListDatasource

Parameters:

relativeExpression - String that references an object in the data model

value - the new value for the given expression

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

Throws:

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

removeElementAtIndex

public void removeElementAtIndex(int index)

Description copied from interface: IListDatasource

Remove the object at the given index of the data model.

Specified by:

removeElementAtIndex in interface IListDatasource

Parameters:

index - the row index of the object to be removed

removeElement

public void removeElement(java.lang.Object object)

Description copied from interface: IListDatasource

Remove the given object from the data model.

Specified by:

removeElement in interface IListDatasource

Parameters:

object - the object to be removed

removeAllElements

public void removeAllElements()

Description copied from interface: IListDatasource

Removes all objects from the data model.

Specified by:

removeAllElements in interface IListDatasource

addElement

public void addElement(java.lang.Object object)

Description copied from interface: IListDatasource

Add a new object to the data model. Objects are added to the end.

Specified by:

addElement in interface IListDatasource

Parameters:

object - the object to be added to the data model

addElementAtIndex

public void addElementAtIndex(java.lang.Object object,
                              int index)

Description copied from interface: IListDatasource

Insert a new object to the data model at the given row index.

Specified by:

addElementAtIndex in interface IListDatasource

Parameters:

object - the object to be added to the data model

index - the index to add the object at

addElements

public void addElements(java.util.Vector objects)

Description copied from interface: IListDatasource

Add multiple new objects to the data model. Objects are added to the end.

Specified by:

addElements in interface IListDatasource

Parameters:

objects - a Vector of objects to be added

setElements

public void setElements(java.util.Vector objects)

Description copied from interface: IListDatasource

Set the elements managed by the datasource to the given Vector of objects. This overwrites the current elements.

Specified by:

setElements in interface IListDatasource

Parameters:

objects - to be managed by the datasource

getElementAtIndex

public java.lang.Object getElementAtIndex(int index)

Description copied from interface: IListDatasource

Call this method to get the object of the data model at a given index.

Specified by:

getElementAtIndex in interface IListDatasource

Parameters:

index - the row index of the object starting at 0.

Returns:

the object at the given row index

setSelectedElement

public void setSelectedElement(java.lang.Object object)

Description copied from interface: IListDatasource

Set the object selected by the ListView.

Specified by:

setSelectedElement in interface IListDatasource

Parameters:

object - the selected object

getSelectedElement

public java.lang.Object getSelectedElement()

Description copied from interface: IListDatasource

Returns the currently selected object of the ListView or null if no object was set as selected.

Specified by:

getSelectedElement in interface IListDatasource

Returns:

the object selected by the ListView

setComparator

public void setComparator(IComparator comparator)

Description copied from interface: IListDatasource

Use this method to set a IComparator implementation to be used when sorting or resorting the data model represention in the ListView.

Specified by:

setComparator in interface IListDatasource

Parameters:

comparator - the comparator implementation used for sorting

getComparator

public IComparator getComparator()

Description copied from interface: IListDatasource

Use this method to get the current IComparator used by the ListView.

Specified by:

getComparator in interface IListDatasource

Returns:

the IComparator implementation currently used or null if sorting is disabled.

compare

public int compare(java.lang.Object o1,
                   java.lang.Object o2)

resort

public void resort()

Description copied from interface: IListDatasource

Call this method to manually resort the contents of the data model. Changing the order of objects by resorting requires a ListView.reload() to reflect the changes in the user interface.

Specified by:

resort in interface IListDatasource

hasException

public boolean hasException()

Description copied from interface: IListDatasource

Use this method to check for exceptions that might have been caught while reloading the datasource.

Specified by:

hasException in interface IListDatasource

Returns:

true if there was an exception when initializing the elements.

getException

public DatasourceException getException()

Description copied from interface: IListDatasource

Use this method to get the last exception that has been caught while reloading the datasource.

Specified by:

getException in interface IListDatasource

Returns:

the last exception.

reloadElements

public abstract void reloadElements()

Description copied from interface: IListDatasource

Use to reload the objects managed by the datasource.

Specified by:

reloadElements in interface IListDatasource