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

Nested classes/interfaces inherited from class cytoscape.plugin.DownloadableInfo

DownloadableInfo.License

Field Summary

protected String	enclosingJar
protected String	installLocation

Fields inherited from class cytoscape.plugin.DownloadableInfo

versionMatch, versionSplit

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.
protected void	addFileName(String fileName) Adds a file to the list of installed files.
void	clearAuthorList() Clears author list.
List<PluginInfo.AuthorInfo>	getAuthors()
List<String>	getFileList()
PluginInfo.FileType	getFileType()
Installable	getInstallable()
String	getInstallLocation()
String	getPluginClassName()
File	getPluginDirectory() Gets the full install path for this plugin.
String	getProjectUrl()
DownloadableType	getType() DownloadableInfo.getType()
String	htmlOutput()
protected void	setFileList(List<String> list) Sets a list of files (prefer full paths) installed with this plugin.
protected void	setFiletype(PluginInfo.FileType type) Jar or Zip are currently supported.
protected void	setInstallLocation(String Loc) This is meant to only get set by the PluginManager.
void	setPluginClassName(String className) Sets the plugin class name.
void	setProjectUrl(String url) Sets the url of a site describing this plugin project

Methods inherited from class cytoscape.plugin.DownloadableInfo

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

enclosingJar

protected String enclosingJar

installLocation

protected String installLocation

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 -

setProjectUrl

public void setProjectUrl(String url)

Sets the url of a site describing this plugin project

Parameters:

url -

setFiletype

protected void setFiletype(PluginInfo.FileType type)

Jar or Zip are currently supported. Use PluginInfo.JAR or PluginInfo.ZIP. This will only be set by the PluginManager generally and can only be set once as an object's file type will not change.

Parameters:

type -

setFileList

protected void setFileList(List<String> list)

Sets a list of files (prefer full paths) installed with this plugin. Includes the jar file.

Parameters:

list -

addFileName

protected void addFileName(String fileName)

Adds a file to the list of installed files.

Parameters:

fileName -

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.

setInstallLocation

protected void setInstallLocation(String Loc)

This is meant to only get set by the PluginManager. It can only be set once as the install location can't move.

Parameters:

Loc -

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

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.

getProjectUrl

public String getProjectUrl()

Returns:

Url that points to a site describing this plugin project

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).

htmlOutput

public String htmlOutput()

Specified by:

htmlOutput in class DownloadableInfo