gate.creole.metadata

Annotation Type CreoleResource

@Documented
@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface CreoleResource

Annotates a CREOLE resource type. This annotation should only be used on classes or interfaces that implement the Resource interface (directly or indirectly).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	annotationTypeDisplayed The annotation type that this resource displays.
AutoInstance[]	autoinstances Defines any instances of this resource that should be created automatically when the plugin is loaded.
String	comment A descriptive comment about this resource, which appears in the tooltip in the GUI.
GuiType	guiType The GUI type of this resource.
String	helpURL A help URL about this resource, which is used to display the help page in the GATE help browser.
String	icon The path (in the Class.getResource(java.lang.String) sense) to the icon used to represent this resource in the GUI.
String	interfaceName The interface implemented by this resource.
boolean	isPrivate Is the resource private?
boolean	mainViewer Is this resource the "main" viewer for its target resource type?
String	name The name of the resource, as it will appear in the GATE GUI.
String	resourceDisplayed The name of the resource class that this resource is responsible for displaying in the GUI.
boolean	tool Is this resource a 'tool' (i.e. should its published actions be added to the Tools menu)?

Element Detail

name

public abstract String name

The name of the resource, as it will appear in the GATE GUI. If unspecified, defaults to the bare name of the resource class (without its package).

Default:

""

isPrivate

public abstract boolean isPrivate

Is the resource private? If true, this resource type will not appear in the menus of the GATE GUI, though it is still possible to create it in code using Factory.createResource(java.lang.String).

Default:

false

comment

public abstract String comment

A descriptive comment about this resource, which appears in the tooltip in the GUI.

Default:

""

helpURL

public abstract String helpURL

A help URL about this resource, which is used to display the help page in the GATE help browser.

Default:

""

autoinstances

public abstract AutoInstance[] autoinstances

Defines any instances of this resource that should be created automatically when the plugin is loaded.

Default:

{}

interfaceName

public abstract String interfaceName

The interface implemented by this resource. For example, a document implementation should specify "gate.Document" here.

Default:

""

icon

public abstract String icon

The path (in the Class.getResource(java.lang.String) sense) to the icon used to represent this resource in the GUI. A path starting with a forward slash is treated as an absolute path, a relative path (without the leading slash) is interpreted relative to gate/resources/img.

Default:

""

resourceDisplayed

public abstract String resourceDisplayed

The name of the resource class that this resource is responsible for displaying in the GUI. Only relevant for visual resources.

Default:

""

annotationTypeDisplayed

public abstract String annotationTypeDisplayed

The annotation type that this resource displays. Only relevant for annotation editor resources.

Default:

""

guiType

public abstract GuiType guiType

The GUI type of this resource. Only relevant for visual resources.

Default:

gate.creole.metadata.GuiType.NONE

mainViewer

public abstract boolean mainViewer

Is this resource the "main" viewer for its target resource type? Only relevant for visual resources.

Default:

false

tool

public abstract boolean tool

Is this resource a 'tool' (i.e. should its published actions be added to the Tools menu)?

Default:

false