cytoscape.plugin
Class CytoscapePlugin

java.lang.Object
  cytoscape.plugin.CytoscapePlugin

All Implemented Interfaces:

PropertyChangeListener, EventListener

public abstract class CytoscapePlugin
extends Object
implements PropertyChangeListener

A CytoscapePlugin is the new "Global" plugin. A CytoscapePlugin constructor does not have any arguments, since it is Network agnostic. Instead all access to the Cytoscape Data Structures is handled throught the static methods provided by cytoscape.Cytoscape. It is encouraged, but not mandatory, for plugins to override the describe method to state what the plugin does and how it should be used.

Constructor Summary

CytoscapePlugin()
There are no arguments required or allowed in a CytoscapePlugin constructor.

Method Summary

void	activate() If implemented, then this plugin will be activated after being initialized
void	deactivate() If implemented then this plugin can remove itself from the Menu system, and anything else, when the user decides to deactivate it.
String	describe() Deprecated.
String	getScriptName() If this plugin is scriptable, then this will return a unique script name, that will come after the colon like: :name
CyNetwork	interpretScript(String[] args, CyNetwork network) Take a CyNetwork as input along with some arguments, and return a CyNetwork, which can be the same, or different, it doesn't really matter, and is up to the individual plugin.
boolean	isScriptable() If true, this plugin is capable if accepting scripts, and we will find out what its script name is
static Object	loadPlugin(Class pluginClass) Attempts to instantiate a plugin of the class argument.
void	onCytoscapeExit()
void	propertyChange(PropertyChangeEvent e) DOCUMENT ME!
void	restoreSessionState(List<File> pStateFileList) DOCUMENT ME!
void	saveSessionStateFiles(List<File> pFileList) DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Constructor Detail

CytoscapePlugin

public CytoscapePlugin()

There are no arguments required or allowed in a CytoscapePlugin constructor.

Method Detail

describe

public String describe()

Deprecated.

DEPRECATED This method will be removed in Dec 2007 please use the getPluginInfoObject() method and call setDescription on the PluginInfo object returned.

Returns:

description of plugin

isScriptable

public boolean isScriptable()

If true, this plugin is capable if accepting scripts, and we will find out what its script name is

getScriptName

public String getScriptName()

If this plugin is scriptable, then this will return a unique script name, that will come after the colon like: :name

interpretScript

public CyNetwork interpretScript(String[] args,
                                 CyNetwork network)

Take a CyNetwork as input along with some arguments, and return a CyNetwork, which can be the same, or different, it doesn't really matter, and is up to the individual plugin.

activate

public void activate()

If implemented, then this plugin will be activated after being initialized

deactivate

public void deactivate()

If implemented then this plugin can remove itself from the Menu system, and anything else, when the user decides to deactivate it.

loadPlugin

public static Object loadPlugin(Class pluginClass)
                         throws PluginException

Attempts to instantiate a plugin of the class argument.

Returns:

The object, if it was not successfully constructed object will be null

Throws:

PluginException

propertyChange

public void propertyChange(PropertyChangeEvent e)

DOCUMENT ME!

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

e - DOCUMENT ME!

onCytoscapeExit

public void onCytoscapeExit()

restoreSessionState

public void restoreSessionState(List<File> pStateFileList)

DOCUMENT ME!

Parameters:

pStateFileList - DOCUMENT ME!

saveSessionStateFiles

public void saveSessionStateFiles(List<File> pFileList)

DOCUMENT ME!

Parameters:

pFileList - DOCUMENT ME!