gate.gui

Class ResourceHelper

java.lang.Object

gate.util.AbstractFeatureBearer

gate.creole.AbstractResource

gate.gui.ResourceHelper

All Implemented Interfaces:

CreoleListener, Resource, FeatureBearer, NameBearer, Serializable, EventListener

public abstract class ResourceHelper
extends AbstractResource
implements CreoleListener

See Also:

Serialized Form

Field Summary

Fields inherited from class gate.creole.AbstractResource

name

Fields inherited from class gate.util.AbstractFeatureBearer

features

Constructor Summary

Constructors

Constructor and Description
ResourceHelper()

Method Summary

Modifier and Type	Method and Description
protected abstract List<Action>	buildActions(NameBearerHandle handle) Build the Action instances that should be used to enhance the right-click menu of the specified NameBearerHandle.
Object	call(String action, Resource resource, Object... params) Allows for the calling of methods defined within ResourceHelper instances which aren't part of the core API and so which can only be called via reflection.
void	cleanup() releases the memory allocated to this resource
void	datastoreClosed(CreoleEvent e) Called when a DataStore has been closed
void	datastoreCreated(CreoleEvent e) Called when a DataStore has been created
void	datastoreOpened(CreoleEvent e) Called when a DataStore has been opened
List<Action>	getActions(NameBearerHandle handle) Get the right-click menu items that this tool will add to the specified resource.
Resource	init() Initialise this resource, and return it.
void	resourceLoaded(CreoleEvent e) Called when a new Resource has been loaded into the system
void	resourceRenamed(Resource resource, String oldName, String newName) Called when the creole register has renamed a resource.1
void	resourceUnloaded(CreoleEvent e) Called when a Resource has been removed from the system

Methods inherited from class gate.creole.AbstractResource

checkParameterValues, flushBeanInfoCache, forgetBeanInfo, getBeanInfo, getInitParameterValues, getInitParameterValues, getName, getParameterValue, getParameterValue, getParameterValues, removeResourceListeners, setName, setParameterValue, setParameterValue, setParameterValues, setParameterValues, setResourceListeners, toString

Methods inherited from class gate.util.AbstractFeatureBearer

getFeatures, setFeatures

Methods inherited from class java.lang.Object

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

Methods inherited from interface gate.util.FeatureBearer

getFeatures, setFeatures

Constructor Detail

ResourceHelper

public ResourceHelper()

Method Detail

init

public Resource init()
              throws ResourceInstantiationException

Description copied from class: AbstractResource

Initialise this resource, and return it.

Specified by:

init in interface Resource

Overrides:

init in class AbstractResource

Throws:

ResourceInstantiationException

getActions

public List<Action> getActions(NameBearerHandle handle)

Get the right-click menu items that this tool will add to the specified resource. Note that this implementation uses a cache so that the same items will be returned each time the menu is displayed. For a fully dynamic approach a subclass should override this method to simply call @{link buildActions(NameBearerHandle).

Parameters:

handle - the NameBearerHandle instance we are wanting to add new menu items to

Returns:

a list of Action instances which will be added to the right click menu of the specified handle

buildActions

protected abstract List<Action> buildActions(NameBearerHandle handle)

Build the Action instances that should be used to enhance the right-click menu of the specified NameBearerHandle.

Parameters:

handle - the NameBearerHandle instance we are adding to

Returns:

a list of Action instances that will be added to the right-click menu of the resource.

call

public Object call(String action,
                   Resource resource,
                   Object... params)
            throws NoSuchMethodException,
                   IllegalArgumentException,
                   IllegalAccessException,
                   InvocationTargetException

Allows for the calling of methods defined within ResourceHelper instances which aren't part of the core API and so which can only be called via reflection.

Parameters:

action - the name of the method to call (method must take a Resource instance as it's first parameter)

resource - the Resource instance that you want to help

params - parameters to the method you are trying to call

Returns:

the return value from the method you are calling, or null if the method has a void return type

Throws:

NoSuchMethodException

IllegalArgumentException

IllegalAccessException

InvocationTargetException

cleanup

public void cleanup()

Description copied from class: AbstractResource

releases the memory allocated to this resource

Specified by:

cleanup in interface Resource

Overrides:

cleanup in class AbstractResource

resourceUnloaded

public void resourceUnloaded(CreoleEvent e)

Description copied from interface: CreoleListener

Called when a Resource has been removed from the system

Specified by:

resourceUnloaded in interface CreoleListener

resourceLoaded

public void resourceLoaded(CreoleEvent e)

Description copied from interface: CreoleListener

Called when a new Resource has been loaded into the system

Specified by:

resourceLoaded in interface CreoleListener

datastoreOpened

public void datastoreOpened(CreoleEvent e)

Description copied from interface: CreoleListener

Called when a DataStore has been opened

Specified by:

datastoreOpened in interface CreoleListener

datastoreCreated

public void datastoreCreated(CreoleEvent e)

Description copied from interface: CreoleListener

Called when a DataStore has been created

Specified by:

datastoreCreated in interface CreoleListener

datastoreClosed

public void datastoreClosed(CreoleEvent e)

Description copied from interface: CreoleListener

Called when a DataStore has been closed

Specified by:

datastoreClosed in interface CreoleListener

resourceRenamed

public void resourceRenamed(Resource resource,
                            String oldName,
                            String newName)

Description copied from interface: CreoleListener

Called when the creole register has renamed a resource.1

Specified by:

resourceRenamed in interface CreoleListener