|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.uci.isr.yancees.plugin.AbstractMOPlugin
public abstract class AbstractMOPlugin
This abstract class defines the basic functionality of the plug-in as well as its main attributes.
Field Summary | |
---|---|
protected java.util.Vector |
myListeners
|
protected java.util.Vector |
myRequiredPlugins
|
Constructor Summary | |
---|---|
AbstractMOPlugin(SubscriberInterface si,
SubscriptionInterface sub,
org.w3c.dom.Node subTree)
|
Method Summary | |
---|---|
void |
addListener(MOPluginListenerInterface plugin)
Makes this plug-in notify another provided plugin whenever it computers its output |
void |
addRequiredPlugin(MOPluginInterface plugin)
This method is used by the subscription parser to inform the plugin of all the plug-ins that are supposed to notify this plugin when they are finished with their processing. |
void |
dispose()
This method is part of the plug-in memory and resources management. |
protected void |
finalize()
|
long[] |
getExpectedPluginIDs()
|
java.lang.String |
getFullContext()
|
java.lang.String |
getFullPath()
|
long |
getId()
|
MOPluginInterface[] |
getRequiredPluginsList()
|
SubscriberInterface |
getSubscriber()
|
SubscriptionInterface |
getSubscription()
|
org.w3c.dom.Node |
getSubtree()
|
java.lang.String |
getTag()
|
boolean |
hasChildren()
Determines whether this plug-in requires other plug-ins or not. |
protected void |
publishOutput(EventInterface evt)
Publishes the provided output to this plug-in listeners. |
protected void |
publishOutput(EventInterface[] evtPat)
Publishes the provided event pattern to the event dispatcher |
abstract void |
receivePluginNotification(EventInterface[] evtList,
MOPluginInterface source)
Receives a list of events as notifications from another plug-in |
abstract void |
receivePluginNotification(EventInterface evt,
MOPluginInterface source)
Receives a notification from another plug-in |
void |
removeListener(MOPluginListenerInterface plugin)
Removes a plug-in registered as listener of this plug-in |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.util.Vector myListeners
protected java.util.Vector myRequiredPlugins
Constructor Detail |
---|
public AbstractMOPlugin(SubscriberInterface si, SubscriptionInterface sub, org.w3c.dom.Node subTree)
si
- TODOsub
- TODOsubTree
- is the DOM tree this plugin is responsible for executingMethod Detail |
---|
public SubscriberInterface getSubscriber()
getSubscriber
in interface MOPluginInterface
public SubscriptionInterface getSubscription()
getSubscription
in interface MOPluginInterface
public void addRequiredPlugin(MOPluginInterface plugin)
addRequiredPlugin
in interface MOPluginInterface
id
- is an id of a plug-in that will notify this instancepublic MOPluginInterface[] getRequiredPluginsList()
getRequiredPluginsList
in interface MOPluginInterface
public boolean hasChildren()
hasChildren
in interface MOPluginInterface
public long[] getExpectedPluginIDs()
public long getId()
getId
in interface PluginInterface
public java.lang.String getTag()
getTag
in interface PluginInterface
public java.lang.String getFullContext()
getFullContext
in interface MOPluginInterface
public java.lang.String getFullPath()
getFullPath
in interface MOPluginInterface
public org.w3c.dom.Node getSubtree()
getSubtree
in interface MOPluginInterface
protected void publishOutput(EventInterface evt)
evt
- is the event to be published to the listeners of this plug-inprotected void publishOutput(EventInterface[] evtPat)
evtPat
- is the event pattern to be published to the dispather to
whoever may be interested inpublic abstract void receivePluginNotification(EventInterface evt, MOPluginInterface source)
receivePluginNotification
in interface MOPluginListenerInterface
evt
- is the event receivedsource
- is the plug-in sending the notification.public abstract void receivePluginNotification(EventInterface[] evtList, MOPluginInterface source)
receivePluginNotification
in interface MOPluginListenerInterface
evtList
- is the list of events receivedsource
- is the plug-in sending the notification.public void addListener(MOPluginListenerInterface plugin)
addListener
in interface MOPluginInterface
public void removeListener(MOPluginListenerInterface plugin)
removeListener
in interface MOPluginInterface
public void dispose()
dispose
in interface MOPluginInterface
protected void finalize() throws java.lang.Throwable
finalize
in class java.lang.Object
java.lang.Throwable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |