com.softwareag.mobile.runtime.toolkit.delegates

Class AbstractListViewDatasource

java.lang.Object

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

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

All Implemented Interfaces:

IListViewDatasource

Direct Known Subclasses:

JSONDatasource

public abstract class AbstractListViewDatasource
extends Observable
implements IListViewDatasource

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

Version:

9.6.0.0000-0237

Constructor Summary

Constructors

Constructor and Description
AbstractListViewDatasource()
AbstractListViewDatasource(Observer observer)

Method Summary

Methods

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)
IListViewComparator	getComparator() Use this method to get the current IListViewComparator 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.
abstract java.lang.Object	getExpressionValue(java.lang.String rootExpression) Call this method to get the object of the data model using an expression.
abstract java.lang.Object	getExpressionValue(java.lang.String relativeExpression, int elementIndex) 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.
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.
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(IListViewComparator comparator) Use this method to set a IListViewComparator implementation to be used when sorting or resorting the data model represention in the ListView.
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, 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

AbstractListViewDatasource

public AbstractListViewDatasource()

AbstractListViewDatasource

public AbstractListViewDatasource(Observer observer)

Method Detail

reloadElements

public abstract void reloadElements()

Description copied from interface: IListViewDatasource

Use to reload the objects managed by the datasource.

Specified by:

reloadElements in interface IListViewDatasource

getFilterExpression

public java.lang.String getFilterExpression()

Description copied from interface: IListViewDatasource

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

Specified by:

getFilterExpression in interface IListViewDatasource

Returns:

the filter expression currently used

setFilterExpression

public void setFilterExpression(java.lang.String valueFilter)

Description copied from interface: IListViewDatasource

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 IListViewDatasource.getNumberOfElements(), IListViewDatasource.getElements(), etc. You typically use filter to implement searches in a . An expression can be any String an IListViewDatasource implementation uses to reference an object.

Specified by:

setFilterExpression in interface IListViewDatasource

Parameters:

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

getElements

public java.util.Vector getElements()

Description copied from interface: IListViewDatasource

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 IListViewDatasource

Returns:

all objects in the data model

getNumberOfElements

public int getNumberOfElements()

Description copied from interface: IListViewDatasource

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

Specified by:

getNumberOfElements in interface IListViewDatasource

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

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

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

removeElementAtIndex

public void removeElementAtIndex(int index)

Description copied from interface: IListViewDatasource

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

Specified by:

removeElementAtIndex in interface IListViewDatasource

Parameters:

index - the row index of the object to be removed

removeElement

public void removeElement(java.lang.Object object)

Description copied from interface: IListViewDatasource

Remove the given object from the data model.

Specified by:

removeElement in interface IListViewDatasource

Parameters:

object - the object to be removed

removeAllElements

public void removeAllElements()

Description copied from interface: IListViewDatasource

Removes all objects from the data model.

Specified by:

removeAllElements in interface IListViewDatasource

addElement

public void addElement(java.lang.Object object)

Description copied from interface: IListViewDatasource

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

Specified by:

addElement in interface IListViewDatasource

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: IListViewDatasource

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

Specified by:

addElementAtIndex in interface IListViewDatasource

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: IListViewDatasource

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

Specified by:

addElements in interface IListViewDatasource

Parameters:

objects - a Vector of objects to be added

getElementAtIndex

public java.lang.Object getElementAtIndex(int index)

Description copied from interface: IListViewDatasource

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

Specified by:

getElementAtIndex in interface IListViewDatasource

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: IListViewDatasource

Set the object selected by the ListView.

Specified by:

setSelectedElement in interface IListViewDatasource

Parameters:

object - the selected object

getSelectedElement

public java.lang.Object getSelectedElement()

Description copied from interface: IListViewDatasource

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

Specified by:

getSelectedElement in interface IListViewDatasource

Returns:

the object selected by the ListView

setComparator

public void setComparator(IListViewComparator comparator)

Description copied from interface: IListViewDatasource

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

Specified by:

setComparator in interface IListViewDatasource

Parameters:

comparator - the comparator implementation used for sorting

getComparator

public IListViewComparator getComparator()

Description copied from interface: IListViewDatasource

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

Specified by:

getComparator in interface IListViewDatasource

Returns:

the IListViewComparator 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: IListViewDatasource

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 IListViewDatasource