gate.creole

Class Plugin

java.lang.Object

gate.creole.Plugin

Direct Known Subclasses:

Plugin.Component, Plugin.Directory, Plugin.Maven

public abstract class Plugin
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Plugin.Component
static class	Plugin.Directory
static interface	Plugin.DownloadListener
static class	Plugin.Maven
protected static class	Plugin.ResourceInfoVisitor ClassVisitor that uses information from a CreoleResource annotation on the visited class (if such exists) to fill in the name and comment in the corresponding ResourceInfo.

Field Summary

Fields

Modifier and Type	Field and Description
protected URL	baseURL This is the URL against which all relative URLs in the CREOLE metadata are resolved
protected String	description
protected Vector<Plugin.DownloadListener>	downloadListeners
protected static org.slf4j.Logger	log
protected String	minGateVersion
protected String	name
protected Set<Plugin>	requiredPlugins The set of other plugins that must be loaded prior to the loading of this plugin
protected List<Gate.ResourceInfo>	resourceInfoList The list of Gate.ResourceInfo objects within this plugin
protected boolean	valid Is the plugin valid (i.e.
protected String	version

Constructor Summary

Constructors

Constructor and Description
Plugin()

Method Summary

Modifier and Type	Method and Description
void	addDownloadListener(Plugin.DownloadListener listener)
void	copyResources(File dir)
boolean	equals(Object obj)
protected void	fillInResInfos(List<Gate.ResourceInfo> incompleteResInfos, List<String> allJars)
protected void	fireDownloadFailed(String name, Throwable cause)
protected void	fireDownloadProgressed(String name, long totalBytes, long transferredBytes)
protected void	fireDownloadStarted(String name)
protected void	fireDownloadSucceeded(String name)
URI	getBaseURI()
URL	getBaseURL()
abstract org.jdom.Document	getCreoleXML() Returns a fully expanded creole.xml file that can be used for loading the plugin into GATE
String	getDescription()
org.jdom.Document	getMetadataXML() Returns a creole.xml file which is only guaranteed to contain information about the resources within the plugin and not dependency requirements.
String	getMinimumGateVersion()
String	getName()
static Plugin	getPlugin(Class<?> clazz) Given a class return the Plugin instance from which it was loaded.
Set<Plugin>	getRequiredPlugins()
List<Gate.ResourceInfo>	getResourceInfoList()
String	getVersion() Get the version of this plugin.
int	hashCode()
boolean	hasResources()
boolean	isValid()
protected void	parseCreole()
void	removeDownloadListener(Plugin.DownloadListener listener)
protected void	scanJar(URL jarUrl, Map<String,Gate.ResourceInfo> resInfos)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

downloadListeners

protected transient Vector<Plugin.DownloadListener> downloadListeners

log

protected static final org.slf4j.Logger log

valid

protected transient boolean valid

Is the plugin valid (i.e. is the location reachable and the creole.xml file parsable).

baseURL

protected transient URL baseURL

This is the URL against which all relative URLs in the CREOLE metadata are resolved

name

protected transient String name

description

protected transient String description

version

protected transient String version

minGateVersion

protected transient String minGateVersion

resourceInfoList

protected transient List<Gate.ResourceInfo> resourceInfoList

The list of Gate.ResourceInfo objects within this plugin

requiredPlugins

protected transient Set<Plugin> requiredPlugins

The set of other plugins that must be loaded prior to the loading of this plugin

Constructor Detail

Plugin

public Plugin()

Method Detail

addDownloadListener

public void addDownloadListener(Plugin.DownloadListener listener)

removeDownloadListener

public void removeDownloadListener(Plugin.DownloadListener listener)

fireDownloadStarted

protected void fireDownloadStarted(String name)

fireDownloadSucceeded

protected void fireDownloadSucceeded(String name)

fireDownloadFailed

protected void fireDownloadFailed(String name,
                                  Throwable cause)

fireDownloadProgressed

protected void fireDownloadProgressed(String name,
                                      long totalBytes,
                                      long transferredBytes)

getCreoleXML

public abstract org.jdom.Document getCreoleXML()
                                        throws Exception

Returns a fully expanded creole.xml file that can be used for loading the plugin into GATE

Returns:

a fully expanded creole.xml file that can be used for loading the plugin into GATE

Throws:

Exception

getMetadataXML

public org.jdom.Document getMetadataXML()
                                 throws Exception

Returns a creole.xml file which is only guaranteed to contain information about the resources within the plugin and not dependency requirements.

Returns:

a creole.xml file which is only guaranteed to contain information about the resources within the plugin and not dependency requirements.

Throws:

Exception

getName

public String getName()

getDescription

public String getDescription()

getVersion

public String getVersion()

Get the version of this plugin.

getMinimumGateVersion

public String getMinimumGateVersion()

getRequiredPlugins

public Set<Plugin> getRequiredPlugins()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getResourceInfoList

public List<Gate.ResourceInfo> getResourceInfoList()

getBaseURL

public URL getBaseURL()

getBaseURI

public URI getBaseURI()
               throws URISyntaxException

Throws:

URISyntaxException

isValid

public boolean isValid()

copyResources

public void copyResources(File dir)
                   throws IOException,
                          URISyntaxException

Throws:

IOException

URISyntaxException

hasResources

public boolean hasResources()

getPlugin

public static Plugin getPlugin(Class<?> clazz)
                        throws IOException

Given a class return the Plugin instance from which it was loaded.

Returns:

the Plugin instance from which the specified class was loaded

Throws:

IOException

parseCreole

protected void parseCreole()

scanJar

protected void scanJar(URL jarUrl,
                       Map<String,Gate.ResourceInfo> resInfos)
                throws IOException

Throws:

IOException

fillInResInfos

protected void fillInResInfos(List<Gate.ResourceInfo> incompleteResInfos,
                              List<String> allJars)
                       throws IOException

Throws:

IOException