|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.uci.isr.yancees.server.plugin.AbstractPlugin
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 | |
AbstractPlugin(org.w3c.dom.Node subTree)
|
Method Summary | |
void |
addListener(PluginListenerInterface plugin)
Makes this plug-in notify another provided plugin whenever it computers its output |
void |
addRequiredPlugin(PluginInterface 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. |
long[] |
getExpectedPluginIDs()
|
java.lang.String |
getFullContext()
|
java.lang.String |
getFullPath()
|
long |
getId()
|
PluginInterface[] |
getRequiredPluginsList()
|
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 the event dispatcher. |
protected void |
publishOutput(EventInterface[] evtPat)
Publishes the provided event pattern to the event dispatcher |
abstract void |
receivePluginNotification(EventInterface[] evtList,
PluginInterface source)
Receives a list of events as notifications from another plug-in |
abstract void |
receivePluginNotification(EventInterface evt,
PluginInterface source)
Receives a notification from another plug-in |
void |
removeListener(PluginListenerInterface plugin)
Removes a plug-in registered as listener of this plug-in |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.util.Vector myListeners
protected java.util.Vector myRequiredPlugins
Constructor Detail |
public AbstractPlugin(org.w3c.dom.Node subTree)
subTree
- is the DOM tree this plugin is responsible for executingMethod Detail |
public void addRequiredPlugin(PluginInterface plugin)
addRequiredPlugin
in interface PluginInterface
public PluginInterface[] getRequiredPluginsList()
getRequiredPluginsList
in interface PluginInterface
public boolean hasChildren()
hasChildren
in interface PluginInterface
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 PluginInterface
public java.lang.String getFullPath()
getFullPath
in interface PluginInterface
public org.w3c.dom.Node getSubtree()
getSubtree
in interface PluginInterface
protected void publishOutput(EventInterface evt)
evt
- is the event to be published to the dispather to whoever may
be interested 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, PluginInterface source)
receivePluginNotification
in interface PluginListenerInterface
evt
- is the event receivedsource
- is the plug-in sending the notification.public abstract void receivePluginNotification(EventInterface[] evtList, PluginInterface source)
receivePluginNotification
in interface PluginListenerInterface
evtList
- is the list of events receivedsource
- is the plug-in sending the notification.public void addListener(PluginListenerInterface plugin)
addListener
in interface PluginInterface
public void removeListener(PluginListenerInterface plugin)
removeListener
in interface PluginInterface
public void dispose()
dispose
in interface PluginInterface
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |