Cytoscape 2.8.0 API

cytoscape.plugin
Class PluginFileReader

java.lang.Object
  extended by cytoscape.plugin.PluginFileReader

public class PluginFileReader
extends Object

Author:
skillcoy

Constructor Summary
protected PluginFileReader(String Url)
          Creates a new PluginFileReader object.
 
Method Summary
protected static PluginInfo addLicense(PluginInfo obj, org.jdom.Element Plugin)
           
protected  DownloadableInfo addVersion(DownloadableInfo obj, org.jdom.Element e, DownloadableType Type)
           
protected  PluginInfo createPluginObject(org.jdom.Element CurrentPlugin)
          Creates the PluginInfo object from the xml element.
protected  ThemeInfo createThemeObject(org.jdom.Element CurrentTheme)
           
protected  List<DownloadableInfo> getDownloadables()
          Retrieves the full list of all downloadable objects in the xml file.
protected  List<PluginInfo> getPlugins()
          Use getDownloadables() This gets the PluginInfo objects as set up in the xml document.
protected  String getProjectDescription()
           
protected  String getProjectName()
           
protected  String getProjectUrl()
           
protected  List<ThemeInfo> getThemes()
          Use getDownloadables() Gets the ThemeInfo objects as set up in the xml document.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PluginFileReader

protected PluginFileReader(String Url)
                    throws IOException,
                           org.jdom.JDOMException
Creates a new PluginFileReader object.

Parameters:
Url - DOCUMENT ME!
Throws:
IOException
org.jdom.JDOMException
Method Detail

getProjectName

protected String getProjectName()
Returns:
The global project name given by the xml document. NOT CURRENTLY USED

getProjectDescription

protected String getProjectDescription()
Returns:
The global project description given by the xml document. NOT CURRENTLY USED

getProjectUrl

protected String getProjectUrl()
Returns:
The global project url given by the xml document. NOT CURRENTLY USED

getDownloadables

protected List<DownloadableInfo> getDownloadables()
Retrieves the full list of all downloadable objects in the xml file.

Returns:

getThemes

protected List<ThemeInfo> getThemes()
Use getDownloadables() Gets the ThemeInfo objects as set up in the xml document.

Returns:

getPlugins

protected List<PluginInfo> getPlugins()
Use getDownloadables() This gets the PluginInfo objects as set up in the xml document.

Returns:
The list of PluginInfo objects specified by the xml document.

createThemeObject

protected ThemeInfo createThemeObject(org.jdom.Element CurrentTheme)

createPluginObject

protected PluginInfo createPluginObject(org.jdom.Element CurrentPlugin)
Creates the PluginInfo object from the xml element. This could be useful to the PluginTracker.

Parameters:
CurrentPlugin - Element
Returns:
PluginInfo object

addVersion

protected DownloadableInfo addVersion(DownloadableInfo obj,
                                      org.jdom.Element e,
                                      DownloadableType Type)

addLicense

protected static PluginInfo addLicense(PluginInfo obj,
                                       org.jdom.Element Plugin)

Cytoscape 2.8.0 API

Copyright 2010 Cytoscape Consortium. All rights reserved.