gate

Interface CreoleRegister

All Superinterfaces:

CreoleListener, EventListener, Map<String,ResourceData>, Serializable

All Known Implementing Classes:

CreoleRegisterImpl

public interface CreoleRegister
extends Map<String,ResourceData>, Serializable, CreoleListener

The CREOLE register records the set of resources that are currently known to the system. Each member of the register is a ResourceData object, indexed by the class name of the resource.

The register is accessible from the static method gate.Gate.getCreoleRegister ; there is only one per application of the GATE framework.

Clients use the register by adding URLs (using the addDirectory method) pointing to CREOLE directories. A CREOLE directory is a URL at which resides a file called creole.xml describing the resources present, and one or more Jar files implementing those resources. E.g., the CREOLE resources at gate.ac.uk are registered by Gate.init() by registering the directory URL http://gate.ac.uk/creole/, under which lives a file called creole.xml.

To register resources clients use the registerDirectories methods. When resources have been registered they can be accessed via their ResourceData objects. So a typical use of the register is to: add the set of URLs containing CREOLE directories; register all resources found at those URLs; browse the set of registered resources.

In all cases, where a resource or a directory is added which is already present in the register, the new silently overwrites the old. The CreoleRegister notifies all registered listeners of all CreoleEvents that occur in the system regardless of whether they were initially fired by the Factory, the DataStoreRegister or the CreoleRegister itself.

See Also:

Gate, ResourceData

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
void	addCreoleListener(CreoleListener l) Registers a CreoleListenerwith this CreoleRegister.
void	addPluginListener(PluginListener l)
List<Resource>	getAllInstances(String type) Get a list of all the known Resource instances in the register that are of the specified (class or interface) type or one of its sub-types.
List<String>	getAnnotationVRs() Returns a list of strings representing class names for annotation VRs that are able to display/edit all types of annotations.
List<String>	getAnnotationVRs(String annotationType) Returns a list of strings representing class names for annotation VRs that are able to display/edit a given annotation type The default VR will be the first in the returned list.
Set<String>	getApplicationTypes() Get the list of packaged application types in the register.
Set<String>	getControllerTypes() Get the list of types of VR in the register.
Set<URL>	getDirectories() Deprecated.
List<String>	getLargeVRsForResource(String resourceClassName) Returns a list of strings representing class names for large VRs valid for a given type of language/processing resource.
List<LanguageResource>	getLrInstances() Get a list of all instantiations of LR in the register.
List<LanguageResource>	getLrInstances(String resourceTypeName) Get a list of all the known Language Resource instances in the register whose class is resourceTypeName.
Set<String>	getLrTypes() Get the list of types of LR in the register.
Set<Plugin>	getPlugins()
List<ProcessingResource>	getPrInstances() Get a list of all instantiations of PR in the register.
List<ProcessingResource>	getPrInstances(String resourceTypeName) Get a list of all the known Processing Resource instances in the register whose class is resourceTypeName.
Set<String>	getPrTypes() Get the list of types of PR in the register.
List<String>	getPublicControllerTypes() Get a list of all non-private types of Controller in the register.
List<LanguageResource>	getPublicLrInstances() Get a list of all non-private instantiations of LR in the register.
List<String>	getPublicLrTypes() Get a list of all non-private types of LR in the register.
List<ProcessingResource>	getPublicPrInstances() Get a list of all non-private instantiations of PR in the register.
List<String>	getPublicPrTypes() Get a list of all non-private types of PR in the register.
List<VisualResource>	getPublicVrInstances() Get a list of all non-private instantiations of VR in the register.
List<String>	getPublicVrTypes() Get a list of all non-private types of VR in the register.
List<String>	getSmallVRsForResource(String resourceClassName) Returns a list of strings representing class names for small VRs valid for a given type of language/processing resource The default VR will be the first in the returned list.
Set<String>	getToolTypes() Get the list of types of tool in the register.
List<String>	getVREnabledAnnotationTypes() Returns a list of strings representing annotations types for which there are custom viewers/editor registered.
List<VisualResource>	getVrInstances() Get a list of all instantiations of VR in the register.
List<VisualResource>	getVrInstances(String resourceTypeName) Get a list of all the known Visual Resource instances in the register whose class is resourceTypeName.
Set<String>	getVrTypes() Get the list of types of VR in the register.
void	registerBuiltins() Register resources that are built in to the GATE distribution.
void	registerComponent(Class<? extends Resource> clazz) Deprecated.
void	registerDirectories(URL directoryUrl) Deprecated.
void	registerDirectories(URL directoryUrl, boolean loadDependencies) Deprecated.
void	registerPlugin(Plugin plugin)
void	registerPlugin(Plugin plugin, boolean loadDependencies)
void	removeCreoleListener(CreoleListener l) Removes a CreoleListener previously registered with this CreoleRegister.
void	removeDirectory(URL directory) Deprecated.
void	removePluginListener(PluginListener l)
void	setResourceName(Resource res, String newName) Renames an existing resource.
void	unregisterPlugin(Plugin plugin)

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from interface gate.event.CreoleListener

datastoreClosed, datastoreCreated, datastoreOpened, resourceLoaded, resourceRenamed, resourceUnloaded

Method Detail

getDirectories

@Deprecated
Set<URL> getDirectories()

Deprecated.

Get the list of CREOLE directory URLs.

getPlugins

Set<Plugin> getPlugins()

registerComponent

@Deprecated
void registerComponent(Class<? extends Resource> clazz)
                            throws GateException

Deprecated.

Given the class object for a class with CreoleResource annotations, register that class as is if it was found in a scanned jar file with no additional creole.xml information. This API is intended for use in embedded GATE applications where the 'application' is created via the API. Components registered with this API won't work in saved applications, but they can be added to saved applications at runtime.

Parameters:

clazz - Class object for class with CreoleResource annotations.

Throws:

GateException

registerDirectories

@Deprecated
void registerDirectories(URL directoryUrl)
                              throws GateException

Deprecated.

Register a single CREOLE directory. The creole.xml file at the URL is parsed, and CreoleData objects added to the register. If the directory URL has not yet been added it is now added. If any other plugins that needs to be loaded for this plugin to load (specified by REQUIRES elements in creole.xml) will also be loaded.

Throws:

GateException

registerPlugin

void registerPlugin(Plugin plugin)
             throws GateException

Throws:

GateException

registerPlugin

void registerPlugin(Plugin plugin,
                    boolean loadDependencies)
             throws GateException

Throws:

GateException

registerDirectories

@Deprecated
void registerDirectories(URL directoryUrl,
                                     boolean loadDependencies)
                              throws GateException

Deprecated.

Register a single CREOLE directory. The creole.xml file at the URL is parsed, and CreoleData objects added to the register. If the directory URL has not yet been added it is now added. If any other plugins that nees top be loaded for this plugin to load (specified by REQUIRES elements in creole.xml) will only be loaded if the loadDependencies param is true. It is useful to be able to ignore dependencies when loading an xgapp where we know they have already been resolved.

Throws:

GateException

removeDirectory

@Deprecated
void removeDirectory(URL directory)

Deprecated.

Removes a CREOLE directory from the set of loaded directories.

Parameters:

directory -

unregisterPlugin

void unregisterPlugin(Plugin plugin)

registerBuiltins

void registerBuiltins()
               throws GateException

Register resources that are built in to the GATE distribution. These resources are described by the creole.xml file in resources/creole.

Throws:

GateException

getLrTypes

Set<String> getLrTypes()

Get the list of types of LR in the register.

getPrTypes

Set<String> getPrTypes()

Get the list of types of PR in the register.

getVrTypes

Set<String> getVrTypes()

Get the list of types of VR in the register.

getControllerTypes

Set<String> getControllerTypes()

Get the list of types of VR in the register.

getApplicationTypes

Set<String> getApplicationTypes()

Get the list of packaged application types in the register.

getToolTypes

Set<String> getToolTypes()

Get the list of types of tool in the register.

getLrInstances

List<LanguageResource> getLrInstances()

Get a list of all instantiations of LR in the register.

getPrInstances

List<ProcessingResource> getPrInstances()

Get a list of all instantiations of PR in the register.

getVrInstances

List<VisualResource> getVrInstances()

Get a list of all instantiations of VR in the register.

getLrInstances

List<LanguageResource> getLrInstances(String resourceTypeName)

Get a list of all the known Language Resource instances in the register whose class is resourceTypeName. This is only direct instances of the specified class, not its sub-classes, so if resourceTypeName refers to an interface or abstract class an empty list will be returned.

getPrInstances

List<ProcessingResource> getPrInstances(String resourceTypeName)

Get a list of all the known Processing Resource instances in the register whose class is resourceTypeName. This is only direct instances of the specified class, not its sub-classes, so if resourceTypeName refers to an interface or abstract class an empty list will be returned.

getVrInstances

List<VisualResource> getVrInstances(String resourceTypeName)

Get a list of all the known Visual Resource instances in the register whose class is resourceTypeName. This is only direct instances of the specified class, not its sub-classes, so if resourceTypeName refers to an interface or abstract class an empty list will be returned.

getPublicLrInstances

List<LanguageResource> getPublicLrInstances()

Get a list of all non-private instantiations of LR in the register.

getPublicPrInstances

List<ProcessingResource> getPublicPrInstances()

Get a list of all non-private instantiations of PR in the register.

getPublicVrInstances

List<VisualResource> getPublicVrInstances()

Get a list of all non-private instantiations of VR in the register.

getPublicLrTypes

List<String> getPublicLrTypes()

Get a list of all non-private types of LR in the register.

getPublicPrTypes

List<String> getPublicPrTypes()

Get a list of all non-private types of PR in the register.

getPublicVrTypes

List<String> getPublicVrTypes()

Get a list of all non-private types of VR in the register.

getPublicControllerTypes

List<String> getPublicControllerTypes()

Get a list of all non-private types of Controller in the register.

getAllInstances

List<Resource> getAllInstances(String type)
                        throws GateException

Get a list of all the known Resource instances in the register that are of the specified (class or interface) type or one of its sub-types. Specifically, all known Resources r such that

 Gate.getClassLoader().loadClass(type).isInstance(r)
 

Instances that are hidden (Gate.getHiddenAttribute(r.getFeatures()) == true) are not included in the returned list.

Throws:

GateException

getLargeVRsForResource

List<String> getLargeVRsForResource(String resourceClassName)

Returns a list of strings representing class names for large VRs valid for a given type of language/processing resource. The default VR will be the first in the returned list.

getSmallVRsForResource

List<String> getSmallVRsForResource(String resourceClassName)

Returns a list of strings representing class names for small VRs valid for a given type of language/processing resource The default VR will be the first in the returned list.

getAnnotationVRs

List<String> getAnnotationVRs()

Returns a list of strings representing class names for annotation VRs that are able to display/edit all types of annotations. The default VR will be the first in the returned list.

getAnnotationVRs

List<String> getAnnotationVRs(String annotationType)

Returns a list of strings representing class names for annotation VRs that are able to display/edit a given annotation type The default VR will be the first in the returned list.

getVREnabledAnnotationTypes

List<String> getVREnabledAnnotationTypes()

Returns a list of strings representing annotations types for which there are custom viewers/editor registered.

setResourceName

void setResourceName(Resource res,
                     String newName)

Renames an existing resource.

addCreoleListener

void addCreoleListener(CreoleListener l)

Registers a CreoleListenerwith this CreoleRegister. The register will fire events every time a resource is added to or removed from the system and when a datastore is created, opened or closed.

removeCreoleListener

void removeCreoleListener(CreoleListener l)

Removes a CreoleListener previously registered with this CreoleRegister.

See Also:

addCreoleListener(CreoleListener)

addPluginListener

void addPluginListener(PluginListener l)

removePluginListener

void removePluginListener(PluginListener l)