com.softwareag.mobile.runtime.toolkit.rest

Class DatasourceNotification

java.lang.Object

com.softwareag.mobile.runtime.toolkit.rest.DatasourceNotification

public class DatasourceNotification
extends java.lang.Object

A DatasourceNotification is used by datasources to notify it's observers about the type and the data that changed by an operation. If you create your own datasources as subclass of AbstractListDatasource most DatasourceNotifications will be send automatically. When overwriting any of AbstractListDatasource methods to manage it's data, e.g. AbstractListDatasource#setElements(Vector), make sure to call AbstractListDatasource#notifyObservers(Object) providing a DatasourceNotification as argument.

You can create DatasourceNotifications given any of the supported types. Optionally you can provide the objects that were added, removed or updated.

 new DatasourceNotification(DatasourceNotification.TYPE_SET);
 nf.setAddedObjects(myNewSetObjects);
 nf.setRemovedObjects(elements);
 

The following types of notifications are supported:

• TYPE_ADD - notify objects were added
• TYPE_REMOVE - notify objects were removed
• TYPE_UPDATE - notify objects were updated
• TYPE_CLEAR - notify all objects were removed
• TYPE_SET - notify all objects were removed and new objects were set
• TYPE_RELOAD - notify datasource reload finished
• TYPE_SELECTION_CHANGE - notify the selected object of the datasource changed
• TYPE_FILTER_CHANGE - notify the filter used by the datasource was changed
• TYPE_SERVICE_EXEC - notify a service being executed to load new data for the datasource

The datasource's observer implementations will need to check for the type of the notification in order to decide what to do.

 public void update(final Observable observable, final Object object) {
        if (object != null && object instanceof DatasourceNotification) {
                DatasourceNotification notification = (DatasourceNotification) object;
                switch (notification.getType()) {
                case DatasourceNotification.TYPE_SERVICE_EXEC:
                        // do something
                        break;
                case DatasourceNotification.TYPE_ADD:
                case DatasourceNotification.TYPE_RELOAD:
                case DatasourceNotification.TYPE_SET: {
                        // do something
                        break;
                }
                default:
                        break;
                }
        } else if (object instanceof DatasourceException) {
                onDatasourceError((IListDatasource) observable, (Exception) object);
        }
 }
 

Version:

10.1.0.0000-0462

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_ADD Objects in the datasource were added.
static int	TYPE_CLEAR All objects were removed from the datasource
static int	TYPE_FILTER_CHANGE The filter used by the datasource was changed.
static int	TYPE_RELOAD The datasource was successfully reloaded.
static int	TYPE_REMOVE Objects in the datasource were removed.
static int	TYPE_SELECTION_CHANGE The selected object of the datasource changed.
static int	TYPE_SERVICE_EXEC A service was executed to load new data for the datasource.
static int	TYPE_SET New objects have been set.
static int	TYPE_UPDATE Objects in the datasource were updated.

Constructor Summary

Constructors

Constructor and Description
DatasourceNotification(int type) Create a new DatasourceNotification using the given type.
DatasourceNotification(int type, java.lang.Object object) Create a new DatasourceNotification using the given type and a single object that was changed.
DatasourceNotification(int type, java.util.Vector objects) Create a new DatasourceNotification using the given type and the objects itself that were changed.

Method Summary

Modifier and Type	Method and Description
java.util.Vector	getAddedObjects() Returns the added objects or NULL if no objects were added in this type of DatasourceNotification
java.util.Vector	getRemovedObjects() Returns the removed objects or NULL if no objects were removed in this type of DatasourceNotification
int	getType() Returns the type of the DatasourceNotification.
java.util.Vector	getUpdatedObjects() Returns the updated objects or NULL if no objects were updated in this type of DatasourceNotification
void	setAddedObjects(java.util.Vector addedObjects) Sets the added objects.
void	setRemovedObjects(java.util.Vector removedObjects) Sets the removed objects.
void	setUpdatedObjects(java.util.Vector updatedObjects) Sets the updated objects.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_UPDATE

public static final int TYPE_UPDATE

Objects in the datasource were updated.

See Also:

Constant Field Values

TYPE_REMOVE

public static final int TYPE_REMOVE

Objects in the datasource were removed.

See Also:

Constant Field Values

TYPE_ADD

public static final int TYPE_ADD

Objects in the datasource were added.

See Also:

Constant Field Values

TYPE_CLEAR

public static final int TYPE_CLEAR

All objects were removed from the datasource

See Also:

Constant Field Values

TYPE_SET

public static final int TYPE_SET

New objects have been set. Old objects were overwritten.

See Also:

Constant Field Values

TYPE_RELOAD

public static final int TYPE_RELOAD

The datasource was successfully reloaded.

See Also:

Constant Field Values

TYPE_SELECTION_CHANGE

public static final int TYPE_SELECTION_CHANGE

The selected object of the datasource changed.

See Also:

Constant Field Values

TYPE_FILTER_CHANGE

public static final int TYPE_FILTER_CHANGE

The filter used by the datasource was changed.

See Also:

Constant Field Values

TYPE_SERVICE_EXEC

public static final int TYPE_SERVICE_EXEC

A service was executed to load new data for the datasource.

See Also:

Constant Field Values

Constructor Detail

DatasourceNotification

public DatasourceNotification(int type)

Create a new DatasourceNotification using the given type.

Parameters:

type - the type indicating the change of data to be notified

DatasourceNotification

public DatasourceNotification(int type,
                              java.util.Vector objects)

Create a new DatasourceNotification using the given type and the objects itself that were changed.

Parameters:

type - the type indicating the change of data to be notified

objects - the objects changed

DatasourceNotification

public DatasourceNotification(int type,
                              java.lang.Object object)

Create a new DatasourceNotification using the given type and a single object that was changed.

Parameters:

type - the type indicating the change of data to be notified

objects - the object itself that was changed

Method Detail

getUpdatedObjects

public java.util.Vector getUpdatedObjects()

Returns the updated objects or NULL if no objects were updated in this type of DatasourceNotification

setUpdatedObjects

public void setUpdatedObjects(java.util.Vector updatedObjects)

Sets the updated objects.

Parameters:

updatedObjects - the objects updated as Vector

getAddedObjects

public java.util.Vector getAddedObjects()

Returns the added objects or NULL if no objects were added in this type of DatasourceNotification

setAddedObjects

public void setAddedObjects(java.util.Vector addedObjects)

Sets the added objects.

Parameters:

addedObjects - the objects added as Vector

getRemovedObjects

public java.util.Vector getRemovedObjects()

Returns the removed objects or NULL if no objects were removed in this type of DatasourceNotification

setRemovedObjects

public void setRemovedObjects(java.util.Vector removedObjects)

Sets the removed objects.

Parameters:

removedObjects - the objects removed as Vector

getType

public int getType()

Returns the type of the DatasourceNotification.