cytoscape.plugin
Class PluginInfo

java.lang.Object
  cytoscape.plugin.DownloadableInfo
      cytoscape.plugin.PluginInfo

public class PluginInfo
extends DownloadableInfo

Object describes a plugin

Nested Class Summary

class	PluginInfo.AuthorInfo Describes an author for a given plugin.
static class	PluginInfo.FileType Jar and Zip files currently supported

Constructor Summary

PluginInfo()
See DownloadableInfo.DownloadableInfo() Initializes a PluginInfo object with the following defaults: setName("Unknown"); setDescription("No description"); setObjectVersion("0.1"); setCytoscapeVersion( cytoscape.cytoscapeVersion.version ); setCategory("Uncategorized");

PluginInfo(String UniqueID)
See DownloadableInfo.DownloadableInfo(String)

PluginInfo(String UniqueID, DownloadableInfo ParentObj)
See DownloadableInfo.DownloadableInfo(String)

PluginInfo(String UniqueID, String Name)

Method Summary

void	addAuthor(String authorName, String institution) Adds an author to the list of authors.
void	clearAuthorList() Clears author list.
List<PluginInfo.AuthorInfo>	getAuthors()
String	getDownloadUrl() Deprecated. See DownloadableInfo.getDownloadableURL()} will be removed June 2008
List<String>	getFileList()
PluginInfo.FileType	getFileType()
Installable	getInstallable()
String	getInstallLocation()
String	getLicenseText() Deprecated. See DownloadableInfo.getLicenseText() will be removed June 2008
String	getPluginClassName()
File	getPluginDirectory() Gets the full install path for this plugin.
String	getPluginVersion() Deprecated. See DownloadableInfo.getObjectVersion() will be removed June 2008
String	getProjectUrl()
DownloadableType	getType() DownloadableInfo.getType()
String	getUrl() Deprecated. See DownloadableInfo.getObjectUrl()} will be removed June 2008
String	htmlOutput()
boolean	isLicenseRequired() Deprecated. See DownloadableInfo.isLicenseRequired() will be removed June 2008
boolean	isNewerPluginVersion(PluginInfo New) Deprecated. See DownloadableInfo.isNewerObjectVersion(DownloadableInfo)} will be removed June 2008 Compare the version of the object to the given object.
void	setLicense(String licenseText, boolean alwaysRequired) Deprecated. See DownloadableInfo.setLicense(String, boolean) will be removed June 2008 Sets the license information for the plugin. Not required.
void	setLicense(URL url) Deprecated. See DownloadableInfo#setLicense(String) will be removed June 2008 Sets the license information for the plugin. Not required.
void	setPluginClassName(String className) Sets the plugin class name.
void	setPluginVersion(double Version) Deprecated. See DownloadableInfo.setObjectVersion(double)} will be removed June 2008 Sets the version of the plugin. Defaults to 0.1
void	setProjectUrl(String url) Sets the url of a site describing this plugin project

Methods inherited from class cytoscape.plugin.DownloadableInfo

addCytoscapeVersion, equals, equalsDifferentObjectVersion, getCategory, getCytoscapeVersion, getCytoscapeVersions, getDescription, getDownloadableURL, getID, getName, getObjectUrl, getObjectVersion, getParent, getReleaseDate, isNewerObjectVersion, isPluginCompatibleWithCurrent, setCategory, setCategory, setDescription, setDownloadableURL, setName, setObjectUrl, setObjectVersion, setParent, setReleaseDate, toString

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PluginInfo

public PluginInfo()

See DownloadableInfo.DownloadableInfo() Initializes a PluginInfo object with the following defaults: setName("Unknown"); setDescription("No description"); setObjectVersion("0.1"); setCytoscapeVersion( cytoscape.cytoscapeVersion.version ); setCategory("Uncategorized");

PluginInfo

public PluginInfo(String UniqueID)

See DownloadableInfo.DownloadableInfo(String)

Parameters:

UniqueID - Additionally this sets the unique identifier that will be used to find a new version of the plugin at the given download url.

PluginInfo

public PluginInfo(String UniqueID,
                  String Name)

PluginInfo

public PluginInfo(String UniqueID,
                  DownloadableInfo ParentObj)

See DownloadableInfo.DownloadableInfo(String)

Parameters:

UniqueID -

ParentObj - Additionally this sets the unique identifier that will be used to find a new version of the plugin at the given download url and sets the parent downloadable object.

Method Detail

setPluginClassName

public void setPluginClassName(String className)

Sets the plugin class name. Used for tracking plugins.

Parameters:

className -

setPluginVersion

public void setPluginVersion(double Version)
                      throws NumberFormatException

Deprecated. See DownloadableInfo.setObjectVersion(double)} will be removed June 2008 Sets the version of the plugin. Defaults to 0.1

Parameters:

version - String version with format \d+.\d+

Throws:

NumberFormatException - If the string version is of a format other than \d+.\d+

setProjectUrl

public void setProjectUrl(String url)

Sets the url of a site describing this plugin project

Parameters:

url -

addAuthor

public void addAuthor(String authorName,
                      String institution)

Adds an author to the list of authors.

Parameters:

authorName -

institution -

clearAuthorList

public void clearAuthorList()

Clears author list.

setLicense

public void setLicense(URL url)

Deprecated. See DownloadableInfo#setLicense(String) will be removed June 2008 Sets the license information for the plugin. Not required.

Description copied from class: DownloadableInfo

Sets the license information for the plugin. Not required.

Overrides:

setLicense in class DownloadableInfo

Parameters:

java.net.URL - object where license can be downloaded from.

setLicense

public void setLicense(String licenseText,
                       boolean alwaysRequired)

Deprecated. See DownloadableInfo.setLicense(String, boolean) will be removed June 2008 Sets the license information for the plugin. Not required.

Description copied from class: DownloadableInfo

Sets the license information for the plugin. Not required.

Overrides:

setLicense in class DownloadableInfo

Parameters:

Text - string of license.

alwaysRequired - If the user expects the license to be required for both install and update at all times (true) or only at install (false)

getPluginDirectory

public File getPluginDirectory()

Gets the full install path for this plugin. Should look like /.cytoscape//plugins/

getInstallLocation

public String getInstallLocation()

Returns:

String of the installation location for the plugin and all of it's files. Generally this is .cytoscape/[cytoscape version]/plugins/PluginName-version

getLicenseText

public String getLicenseText()

Deprecated. See DownloadableInfo.getLicenseText() will be removed June 2008

Overrides:

getLicenseText in class DownloadableInfo

Returns:

The text of the license for this plugin if available.

isLicenseRequired

public boolean isLicenseRequired()

Deprecated. See DownloadableInfo.isLicenseRequired() will be removed June 2008

Overrides:

isLicenseRequired in class DownloadableInfo

Returns:

If the license is always required to be accepted for installs and updates this returns true. If it only is required at install time (never at update) returns false.

getFileType

public PluginInfo.FileType getFileType()

Returns:

FileType of file type for plugin. PluginInfo.JAR or PluginInfo.ZIP

getPluginClassName

public String getPluginClassName()

Returns:

Java class name

getAuthors

public List<PluginInfo.AuthorInfo> getAuthors()

Returns:

List of authors.

getPluginVersion

public String getPluginVersion()

Deprecated. See DownloadableInfo.getObjectVersion() will be removed June 2008

Returns:

Plugin version.

getUrl

public String getUrl()

Deprecated. See DownloadableInfo.getObjectUrl()} will be removed June 2008

Returns:

Url to download plugin from

getProjectUrl

public String getProjectUrl()

Returns:

Url that points to a site describing this plugin project

getDownloadUrl

public String getDownloadUrl()

Deprecated. See DownloadableInfo.getDownloadableURL()} will be removed June 2008

Returns:

Url that returns the document of available plugins this plugin came from. Example http://cytoscape.org/plugins/all_plugins.xml

getInstallable

public Installable getInstallable()

Specified by:

getInstallable in class DownloadableInfo

getType

public DownloadableType getType()

DownloadableInfo.getType()

Specified by:

getType in class DownloadableInfo

getFileList

public List<String> getFileList()

Returns:

List of files installed with this plugin (includes plugin jar file).

isNewerPluginVersion

public boolean isNewerPluginVersion(PluginInfo New)

Deprecated. See DownloadableInfo.isNewerObjectVersion(DownloadableInfo)} will be removed June 2008 Compare the version of the object to the given object.

Parameters:

New - Potentially newer PluginInfo object

Returns:

true if given version is newer

htmlOutput

public String htmlOutput()

Specified by:

htmlOutput in class DownloadableInfo