equip.data.beans
Interface IDataspace

All Known Implementing Classes:

DataspaceBean

public interface IDataspace

main interface of dataspace client JavaBean

Method Summary

void	add(ItemData item) add a globally visible item to the dataspace
DataSession	addDataspaceEventListener(Event template, boolean localFlag, DataspaceEventListener listener) add an event monitor.
DataSession	addDataspaceEventListener(ItemData template, boolean localFlag, DataspaceEventListener listener) add a item monitor.
void	addEvent(Event event) emit an event directly
void	addLocal(ItemData item) add a local-only item to the dataspace
void	addPersistent(ItemData item, Lease lease) add a (potentially) persistent item to the dataspace, i.e. not process bound, and normally with a Lease (although null is permitted)
GUID	allocateId() allocated a new GUID for a data item to be published
ItemData[]	copyCollect(ItemData template) copy collect - local only.
void	copyCollect(ItemData template, DataspaceEventListener listener) copy collect - local only - callback form.
void	delete(GUID id) delete a globally visible item from the dataspace
void	deleteLocal(GUID id) delete a local-only item from the dataspace
ItemData	getItem(GUID id) get current value for an item by id - local only.
void	removeDataspaceEventListener(DataSession session) remove a previously added event monitor
void	update(ItemData item) update an item, globally visible, reliable
void	update(ItemData item, boolean reliableFlag) update an item, globally visible, optionally reliable
void	updateLocal(ItemData item) update an item, local-only, reliable
void	updateLocal(ItemData item, boolean reliableFlag) update an item, local-only, optionally reliable

Method Detail

allocateId

public GUID allocateId()

allocated a new GUID for a data item to be published

add

public void add(ItemData item)
         throws DataspaceInactiveException

add a globally visible item to the dataspace

Throws:

DataspaceInactiveException

addPersistent

public void addPersistent(ItemData item,
                          Lease lease)
                   throws DataspaceInactiveException

add a (potentially) persistent item to the dataspace, i.e. not process bound, and normally with a Lease (although null is permitted)

Throws:

DataspaceInactiveException

addLocal

public void addLocal(ItemData item)
              throws DataspaceInactiveException

add a local-only item to the dataspace

Throws:

DataspaceInactiveException

update

public void update(ItemData item)
            throws DataspaceInactiveException

update an item, globally visible, reliable

Throws:

DataspaceInactiveException

update

public void update(ItemData item,
                   boolean reliableFlag)
            throws DataspaceInactiveException

update an item, globally visible, optionally reliable

Throws:

DataspaceInactiveException

updateLocal

public void updateLocal(ItemData item)
                 throws DataspaceInactiveException

update an item, local-only, reliable

Throws:

DataspaceInactiveException

updateLocal

public void updateLocal(ItemData item,
                        boolean reliableFlag)
                 throws DataspaceInactiveException

update an item, local-only, optionally reliable

Throws:

DataspaceInactiveException

delete

public void delete(GUID id)
            throws DataspaceInactiveException

delete a globally visible item from the dataspace

Throws:

DataspaceInactiveException

deleteLocal

public void deleteLocal(GUID id)
                 throws DataspaceInactiveException

delete a local-only item from the dataspace

Throws:

DataspaceInactiveException

addEvent

public void addEvent(Event event)
              throws DataspaceInactiveException

emit an event directly

Throws:

DataspaceInactiveException

getItem

public ItemData getItem(GUID id)
                 throws DataspaceInactiveException

get current value for an item by id - local only.

Throws:

DataspaceInactiveException

copyCollect

public ItemData[] copyCollect(ItemData template)
                       throws DataspaceInactiveException

copy collect - local only. returns all known items (local or replicated) matching the template item.

Throws:

DataspaceInactiveException

copyCollect

public void copyCollect(ItemData template,
                        DataspaceEventListener listener)
                 throws DataspaceInactiveException

copy collect - local only - callback form. returns all known items (local or replicated) matching the template item. Calls listener once for each item

Throws:

DataspaceInactiveException

addDataspaceEventListener

public DataSession addDataspaceEventListener(ItemData template,
                                             boolean localFlag,
                                             DataspaceEventListener listener)
                                      throws DataspaceInactiveException

add a item monitor. listener is called with matching events. returned reference is only need to removing the monitor. Its actually a DataSession.

Throws:

DataspaceInactiveException

addDataspaceEventListener

public DataSession addDataspaceEventListener(Event template,
                                             boolean localFlag,
                                             DataspaceEventListener listener)
                                      throws DataspaceInactiveException

add an event monitor. listener is called with matching events. returned reference is only need to removing the monitor. Its actually a DataSession.

Throws:

DataspaceInactiveException

removeDataspaceEventListener

public void removeDataspaceEventListener(DataSession session)
                                  throws DataspaceInactiveException

remove a previously added event monitor

Throws:

DataspaceInactiveException