edu.udo.cs.yale.tools.plugin
Class Plugin

java.lang.Object
  edu.udo.cs.yale.tools.plugin.Plugin

public class Plugin
extends java.lang.Object

The class for Yale plugins. This class is used to encapsulate the .jar file which must be in the lib/plugins subdirectory of Yale. Provides methods for plugin checks, operator registering, and getting information about the plugin.

Plugin dependencies must be defined in the form
plugin_name1 (plugin_version1) # ... # plugin_nameM (plugin_versionM) < />r> of the manifest parameter Plugin-Dependencies. You must define both the name and the version of the desired plugins and separate them with "#".

Version:

$Id: Plugin.java,v 1.24 2006/08/03 14:39:30 ingomierswa Exp $

Author:

Simon Fischer, Ingo Mierswa

Field Summary

private static java.util.List<Plugin>	allPlugins The collection of all plugins.
private java.util.jar.JarFile	archive The jar archive of the plugin which must be placed in the lib/plugins subdirectory of Yale.
private PluginClassLoader	classLoader The class loader based on the plugin file.
private java.lang.String	name The name of the plugin.
private java.lang.String	neededYaleVersion The Yale version which is needed for this plugin.
private java.util.List<Dependency>	pluginDependencies The plugins and their versions which are needed for this plugin.
private java.lang.String	url The url for this plugin (in WWW).
private java.lang.String	vendor The vendor of the plugin.
private java.lang.String	version The version of the plugin.

Constructor Summary

Plugin(java.io.File file)
Creates a new pluging based on the plugin .jar file.

Method Summary

private void	addDependencies(java.lang.String dependencies) Register plugin dependencies.
private boolean	checkDependencies(java.util.List plugins) Checks the Yale version and plugin dependencies.
AboutBox	createAboutBox(java.awt.Frame owner) Creates the about box for this plugin.
static void	findPlugins() Returns a list of Plugins found in the plugins directory.
static java.util.List	getAllPlugins() Returns the collection of all plugins.
java.lang.ClassLoader	getClassLoader() Returns the class loader of this plugin.
private void	getMetaData() Collects all meta data of the plugin from the manifest file.
java.lang.String	getName() Returns the name of the plugin.
java.lang.String	getNeededYaleVersion() Returns the needed Yale version.
static Plugin	getPlugin(java.lang.String name) Returns the desired plugin.
java.util.List	getPluginDependencies() Returns the plugin dependencies of this plugin.
java.lang.String	getVersion() Returns the version of this plugin.
protected void	mergeClassLoader(Plugin other) Adds the URLs of the given Plugin to class loader of this one.
void	register() Register the operators of this plugin in Yale.
static void	registerAllPlugins() Returns a list of Plugins found in the plugins directory.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

archive

private java.util.jar.JarFile archive

The jar archive of the plugin which must be placed in the lib/plugins subdirectory of Yale.

classLoader

private PluginClassLoader classLoader

The class loader based on the plugin file.

name

private java.lang.String name

The name of the plugin.

version

private java.lang.String version

The version of the plugin.

vendor

private java.lang.String vendor

The vendor of the plugin.

url

private java.lang.String url

The url for this plugin (in WWW).

neededYaleVersion

private java.lang.String neededYaleVersion

The Yale version which is needed for this plugin.

pluginDependencies

private java.util.List<Dependency> pluginDependencies

The plugins and their versions which are needed for this plugin.

allPlugins

private static java.util.List<Plugin> allPlugins

The collection of all plugins.

Constructor Detail

Plugin

public Plugin(java.io.File file)
       throws java.io.IOException

Creates a new pluging based on the plugin .jar file.

Throws:

java.io.IOException

Method Detail

getName

public java.lang.String getName()

Returns the name of the plugin.

getVersion

public java.lang.String getVersion()

Returns the version of this plugin.

getNeededYaleVersion

public java.lang.String getNeededYaleVersion()

Returns the needed Yale version.

getPluginDependencies

public java.util.List getPluginDependencies()

Returns the plugin dependencies of this plugin.

getClassLoader

public java.lang.ClassLoader getClassLoader()

Returns the class loader of this plugin.

checkDependencies

private boolean checkDependencies(java.util.List plugins)

Checks the Yale version and plugin dependencies.

getMetaData

private void getMetaData()

Collects all meta data of the plugin from the manifest file.

addDependencies

private void addDependencies(java.lang.String dependencies)

Register plugin dependencies.

register

public void register()

Register the operators of this plugin in Yale.

createAboutBox

public AboutBox createAboutBox(java.awt.Frame owner)

Creates the about box for this plugin.

findPlugins

public static void findPlugins()

Returns a list of Plugins found in the plugins directory.

mergeClassLoader

protected void mergeClassLoader(Plugin other)

Adds the URLs of the given Plugin to class loader of this one. This method should only be used to resolve plugin dependencies.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

registerAllPlugins

public static void registerAllPlugins()

Returns a list of Plugins found in the plugins directory.

getAllPlugins

public static java.util.List getAllPlugins()

Returns the collection of all plugins.

getPlugin

public static Plugin getPlugin(java.lang.String name)

Returns the desired plugin.