equip.data
Class DataCallback

java.lang.Object
  equip.runtime.Object
      equip.runtime.ValueBase
          equip.data.DataCallback

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

DataBrowserFrame.EventHandler, DataCallbackImpl, DataCallbackPost, DataDelegatePeer, DataItemListener.ItemCallback, DataManagerBrowser.MyDataCallback, DataProxyImpl.WaitCallback, LocalDSTest.MyDataCallback

public abstract class DataCallback

extends ValueBase

Original event callback interface for DataProxy events; now largely superceded by DataCallbackPost and/or the IDataspace API.

First you have to get a DataSession object from the local DataProxy using DataProxy.createSession(equip.data.DataCallback, equip.runtime.ValueBase). When creating the session object you provide a callback object (a subclass of this class) that will be invoked for a matching item/event.

This kind of callback is called (for real events) immediate BEFORE the event is enacted. E.g. an add event will NOT yet have placed its item in the dataspace, a delete event will NOT yet have deleted its item. See DataCallbackPost for a post-enactment callback.

Constructor Summary

DataCallback()
Default no-arg constructor

Method Summary

boolean	_equals_helper(DataCallback c) Internal IDL-generated equality test helper
boolean	_matches_helper(DataCallback c) Internal IDL-generated match test helper
boolean	equals(java.lang.Object c) Standard IDL-generated equality test.
java.lang.String	getModuleName() IDL-generated helper routine to get module name (currently unimplemented).
boolean	matches(java.lang.Object c) Standard IDL-generated template match test.
abstract void	notify(Event event, EventPattern pattern, boolean patternDeleted, DataSession session, ValueBase closure) notification of a matched event or pseudo event.
void	readObject(ObjectInputStream in) Internal IDL-generated serialisation helper.
void	writeObject(ObjectOutputStream out) Internal IDL-generated serialisation helper.

Methods inherited from class equip.runtime.ValueBase

_equals_helper, _matches_helper, clone

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataCallback

public DataCallback()

Default no-arg constructor

Method Detail

notify

public abstract void notify(Event event,
                            EventPattern pattern,
                            boolean patternDeleted,
                            DataSession session,
                            ValueBase closure)

notification of a matched event or pseudo event. Note, should really have more info here, e.g. dataspace.

Parameters:

event - The matched event being enacted by the dataspace.

pattern - The pattern that was matched.

patternDeleted - Whether the pattern has been deleted as a result of the event, e.g. matched.

session - The DataSession generating this callback.

closure - As provided when the DataSession was created.

getModuleName

public java.lang.String getModuleName()

IDL-generated helper routine to get module name (currently unimplemented).

Overrides:

getModuleName in class Object

Returns:

name of this class's module

equals

public boolean equals(java.lang.Object c)

Standard IDL-generated equality test.

Overrides:

equals in class ValueBase

Parameters:

c - The object to be compared against this.

Returns:

true if this is equal to c

_equals_helper

public boolean _equals_helper(DataCallback c)

Internal IDL-generated equality test helper

matches

public boolean matches(java.lang.Object c)

Standard IDL-generated template match test.

Overrides:

matches in class ValueBase

Parameters:

c - The object to be checked against this template.

Returns:

true if this (as a template) matches the argument

_matches_helper

public boolean _matches_helper(DataCallback c)

Internal IDL-generated match test helper

writeObject

public void writeObject(ObjectOutputStream out)
                 throws java.io.IOException

Internal IDL-generated serialisation helper. Used by ObjectInputStream and ObjectOutputStream only.

Overrides:

writeObject in class ValueBase

Throws:

java.io.IOException

readObject

public void readObject(ObjectInputStream in)
                throws java.io.IOException,
                       java.lang.ClassNotFoundException,
                       java.lang.InstantiationException

Internal IDL-generated serialisation helper. Used by ObjectInputStream and ObjectOutputStream only.

Overrides:

readObject in class ValueBase

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.InstantiationException