org.LexGrid.LexBIG.gui.plugin
Class PluginRetriever

java.lang.Object
  extended by org.LexGrid.LexBIG.gui.plugin.PluginRetriever

public class PluginRetriever
extends java.lang.Object

PluginRetriever loads all the plugins for the LexBig UI from a specified top-level directory. By default, the directory "plugins" is used.

Each plugin must reside in its own directory underneath the top-level directory, and must consist of a manifest file (named plugin.xml) and a jar containing the class files which define the plugin.

Author:
Jason Leisch

Field Summary
static java.lang.String DEFAULT_BASE_FOLDER
           
static java.lang.String MANIFEST_FILE_NAME
           
 
Constructor Summary
PluginRetriever()
          Construct a PluginRetriever with a base directory of "plugins".
PluginRetriever(java.lang.String directory)
          Construct a PluginRetriever with a base directory other than the default.
 
Method Summary
 TabbedContent[] getTabbedContentPlugins()
          Returns the TabbedContent plugins.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MANIFEST_FILE_NAME

public static final java.lang.String MANIFEST_FILE_NAME
See Also:
Constant Field Values

DEFAULT_BASE_FOLDER

public static final java.lang.String DEFAULT_BASE_FOLDER
See Also:
Constant Field Values
Constructor Detail

PluginRetriever

public PluginRetriever(java.lang.String directory)
Construct a PluginRetriever with a base directory other than the default.

TODO: Currently this class only supports "TabbedContent" style plugins. Eventually it should be modified to be more generic and allow for extension points in other areas.

Parameters:
directory - the name of the folder plugins are located, relative to the home directory

PluginRetriever

public PluginRetriever()
Construct a PluginRetriever with a base directory of "plugins".

TODO: Currently this class only supports "TabbedContent" style plugins. Eventually it should be modified to be more generic and allow for extension points in other areas.

Method Detail

getTabbedContentPlugins

public TabbedContent[] getTabbedContentPlugins()
Returns the TabbedContent plugins.

Returns:
an array of TabbedContent objects.

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.