ResourceData (GATE JavaDoc)

java.lang.Object
- gate.util.AbstractFeatureBearer
- - gate.creole.ResourceData

All Implemented Interfaces:

FeatureBearer, Serializable
```
public class ResourceData
extends AbstractFeatureBearer
implements Serializable
```
Models an individual CREOLE resource metadata, plus configuration data, plus the instantiations of the resource current within the system. Some metadata elements are used by GATE to load resources, or index the members of the CREOLE register; some are used during resource parameterisation and initialisation. Metadata elements which are used by the CREOLE registration and loading mechanisms are properties of ResourceData implementations and have their own get/set methods. Other metadata elements are made features of the ResourceData. So, for example, if you add an element "FunkyElementThaing" to the metadata of a resource, this will be made a feature of that resource's ResourceData.

See Also:
CreoleRegister, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`annotationTypeDisplayed` The full type name of the annotation displayed by this viewer.
`protected boolean`	`autoLoading` Autoloading flag
`protected String`	`className` The class name of the resource
`protected String`	`comment` The comment string
`protected static boolean`	`DEBUG` Debug flag
`protected static String`	`DEFAULT_EXPORTER_ICON`
`protected static String`	`DEFAULT_LR_ICON`
`protected static String`	`DEFAULT_OTHER_ICON`
`protected static String`	`DEFAULT_PR_ICON`
`protected int`	`guiType` A filed which can have one of the 3 predefined values.
`protected String`	`helpURL` The helpURL string
`protected String`	`icon` Location of an icon for the resource
`protected List<Resource>`	`instantiationStack` The stack of instantiations
`protected String`	`interfaceName` The interface name of the resource
`protected boolean`	`isMainView` Whether or not this viewer will be the default one
`protected String`	`jarFileName` The jar file name of the resource
`protected URL`	`jarFileUrl` The jar file URL of the resource
`static int`	`LARGE_GUI` This type indicates that the resource goes into the large area of GATE GUI
`protected String`	`name` The name of the resource
`static int`	`NULL_GUI` This type indicates that the resource is not a GUI
`protected ParameterList`	`parameterList` The set of parameter lists
`protected boolean`	`priv` Private flag
`protected Class<? extends Resource>`	`resourceClass` The class of the resource
`protected String`	`resourceDisplayed` The full class name of the resource displayed by this viewer.
`protected Collection<String>`	`sharableProperties`
`static int`	`SMALL_GUI` This type indicates that the resource goes into the small area of GATE GUI
`protected boolean`	`tool` Tool flag
`protected List<Resource>`	`unmodifiableInstantiationStack` Unmodifiable view of the instantiation stack, returned by getInstantiations to ensure that the only way to modify the list is through the add/removeInstantiation methods of this class.
`protected String`	`validityMessage` Status message set by isValid()
`protected String`	`xmlFileName` The xml file name of the resource
`protected URL`	`xmlFileUrl` The xml file URL of the resource

Fields inherited from class gate.util.AbstractFeatureBearer
features

Constructor Summary

Constructors
Constructor and Description

ResourceData()
Construction

Constructors
Constructor and Description
`ResourceData()` Construction

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addInstantiation(Resource resource)` Add an instantiation of the resource to the register of these
`boolean`	`equals(Object other)` Equality: two resource data objects are the same if they have the same name
`String`	`getAnnotationTypeDisplayed()` A simple accessor for annotationTypeDisplayed field
`String`	`getClassName()` Get method for the resource class name
`String`	`getComment()` Get method for the resource comment
`int`	`getGuiType()` A simple accessor for guiType field
`String`	`getHelpURL()` Get method for the resource helpURL
`String`	`getIcon()` Get method for the resource icon
`List<Resource>`	`getInstantiations()` Get the list of instantiations of resources
`String`	`getInterfaceName()` Get method for the resource interface name
`String`	`getJarFileName()` Get method for the resource jar file name
`URL`	`getJarFileUrl()` Get method for the resource jar file URL
`String`	`getName()` Get method for the resource name
`ParameterList`	`getParameterList()` Get the parameter list
`int`	`getReferenceCount()`
`Class<? extends Resource>`	`getResourceClass()` Get method for the resource class.
`String`	`getResourceDisplayed()` A simple accessor for resourceDisplayed field
`Collection<String>`	`getSharableProperties()` Get the collection of property names that should be treated as sharable state when duplicating resources of this type.
`String`	`getValidityMessage()` Get validity statues message.
`URL`	`getXmlFileUrl()` Get the URL to the creole.xml file that defines this resource
`protected String`	`guessIcon()` Makes the best attempt of guessing an appropriate icon for this resource type based on whether it is a Language Resource, a Processing Resource, or something else.
`int`	`hashCode()` Hashing, based on the name field of the object
`int`	`increaseReferenceCount()`
`void`	`init()` Initialize this ResourceData.
`boolean`	`isAutoLoading()` Is the resource autoloading?
`boolean`	`isMainView()` A simple accessor for isMainView field
`boolean`	`isPrivate()` Is the resource private?
`boolean`	`isTool()` Is the resource a tool?
`boolean`	`isValid()` Is this a valid resource data configuration?
`int`	`reduceReferenceCount()`
`boolean`	`removeInstantiation(Resource resource)` Remove an instantiation of the resource from the register of these.
`void`	`setAnnotationTypeDisplayed(String anAnnotationTypeDisplayed)` A simple mutator for annotationTypeDisplayed field
`void`	`setAutoLoading(boolean autoLoading)` Set method for resource autoloading flag
`void`	`setClassName(String className)` Set method for the resource class name
`void`	`setComment(String comment)` Set method for the resource comment
`void`	`setGuiType(int aGuiType)` A simple mutator for guiType field
`void`	`setHelpURL(String helpURL)` Set method for the resource helpURL
`void`	`setIcon(String icon)` Set method for the resource icon
`void`	`setInterfaceName(String interfaceName)` Set method for the resource interface name
`void`	`setIsMainView(boolean mainView)` A simple mutator for isMainView field
`void`	`setJarFileName(String jarFileName)` Set method for the resource jar file name
`void`	`setJarFileUrl(URL jarFileUrl)` Set method for the resource jar file URL
`void`	`setName(String name)` Set method for the resource name
`void`	`setParameterList(ParameterList parameterList)` Set the parameter list
`void`	`setPrivate(boolean priv)` Set method for resource private flag
`void`	`setResourceClass(Class<? extends Resource> resourceClass)` Set method for the resource class
`void`	`setResourceDisplayed(String aResourceDisplayed)` A simple mutator for resourceDisplayed field
`void`	`setTool(boolean tool)` Set method for resource tool flag
`void`	`setXmlFileUrl(URL xmlFileUrl)` Set the URL to the creole.xml file that defines this resource
`String`	`toString()` String representation

Methods inherited from class gate.util.AbstractFeatureBearer
getFeatures, setFeatures

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEBUG
```
protected static final boolean DEBUG
```
    Debug flag
    
    See Also:
    Constant Field Values
  - DEFAULT_LR_ICON
```
protected static final String DEFAULT_LR_ICON
```
    See Also:
    Constant Field Values
  - DEFAULT_PR_ICON
```
protected static final String DEFAULT_PR_ICON
```
    See Also:
    Constant Field Values
  - DEFAULT_EXPORTER_ICON
```
protected static final String DEFAULT_EXPORTER_ICON
```
    See Also:
    Constant Field Values
  - DEFAULT_OTHER_ICON
```
protected static final String DEFAULT_OTHER_ICON
```
    See Also:
    Constant Field Values
  - name
```
protected String name
```
    The name of the resource
  - icon
```
protected String icon
```
    Location of an icon for the resource
  - instantiationStack
```
protected List<Resource> instantiationStack
```
    The stack of instantiations
  - unmodifiableInstantiationStack
```
protected List<Resource> unmodifiableInstantiationStack
```
    Unmodifiable view of the instantiation stack, returned by getInstantiations to ensure that the only way to modify the list is through the add/removeInstantiation methods of this class.
  - className
```
protected String className
```
    The class name of the resource
  - interfaceName
```
protected String interfaceName
```
    The interface name of the resource
  - resourceClass
```
protected Class<? extends Resource> resourceClass
```
    The class of the resource
  - jarFileName
```
protected String jarFileName
```
    The jar file name of the resource
  - jarFileUrl
```
protected URL jarFileUrl
```
    The jar file URL of the resource
  - xmlFileName
```
protected String xmlFileName
```
    The xml file name of the resource
  - xmlFileUrl
```
protected URL xmlFileUrl
```
    The xml file URL of the resource
  - comment
```
protected String comment
```
    The comment string
  - helpURL
```
protected String helpURL
```
    The helpURL string
  - parameterList
```
protected ParameterList parameterList
```
    The set of parameter lists
  - autoLoading
```
protected boolean autoLoading
```
    Autoloading flag
  - priv
```
protected boolean priv
```
    Private flag
  - tool
```
protected boolean tool
```
    Tool flag
  - validityMessage
```
protected String validityMessage
```
    Status message set by isValid()
  - NULL_GUI
```
public static final int NULL_GUI
```
    This type indicates that the resource is not a GUI
    
    See Also:
    Constant Field Values
  - LARGE_GUI
```
public static final int LARGE_GUI
```
    This type indicates that the resource goes into the large area of GATE GUI
    
    See Also:
    Constant Field Values
  - SMALL_GUI
```
public static final int SMALL_GUI
```
    This type indicates that the resource goes into the small area of GATE GUI
    
    See Also:
    Constant Field Values
  - guiType
```
protected int guiType
```
    A filed which can have one of the 3 predefined values. See above.
  - isMainView
```
protected boolean isMainView
```
    Whether or not this viewer will be the default one
  - resourceDisplayed
```
protected String resourceDisplayed
```
    The full class name of the resource displayed by this viewer.
  - annotationTypeDisplayed
```
protected String annotationTypeDisplayed
```
    The full type name of the annotation displayed by this viewer.
  - sharableProperties
```
protected Collection<String> sharableProperties
```
- Constructor Detail
  - ResourceData
```
public ResourceData()
```
    Construction
- Method Detail
  - getReferenceCount
```
public int getReferenceCount()
```
  - reduceReferenceCount
```
public int reduceReferenceCount()
```
  - increaseReferenceCount
```
public int increaseReferenceCount()
```
  - toString
```
public String toString()
```
    String representation
    
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object other)
```
    Equality: two resource data objects are the same if they have the same name
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Hashing, based on the name field of the object
    
    Overrides:
    
    hashCode in class Object
  - setName
```
public void setName(String name)
```
    Set method for the resource name
  - getName
```
public String getName()
```
    Get method for the resource name
  - setIcon
```
public void setIcon(String icon)
```
    Set method for the resource icon
  - getIcon
```
public String getIcon()
```
    Get method for the resource icon
  - guessIcon
```
protected String guessIcon()
```
    Makes the best attempt of guessing an appropriate icon for this resource type based on whether it is a Language Resource, a Processing Resource, or something else.
    
    Returns:
    a String representing the file name for most appropriate icon for this resource type.
  - getInstantiations
```
public List<Resource> getInstantiations()
```
    Get the list of instantiations of resources
  - addInstantiation
```
public void addInstantiation(Resource resource)
```
    Add an instantiation of the resource to the register of these
  - removeInstantiation
```
public boolean removeInstantiation(Resource resource)
```
    Remove an instantiation of the resource from the register of these.
    
    Returns:
    true if the given instance was contained in the register, false otherwise (i.e. the instance had already been removed).
  - setClassName
```
public void setClassName(String className)
```
    Set method for the resource class name
  - getClassName
```
public String getClassName()
```
    Get method for the resource class name
  - setInterfaceName
```
public void setInterfaceName(String interfaceName)
```
    Set method for the resource interface name
  - getInterfaceName
```
public String getInterfaceName()
```
    Get method for the resource interface name
  - setResourceClass
```
public void setResourceClass(Class<? extends Resource> resourceClass)
```
    Set method for the resource class
  - getResourceClass
```
public Class<? extends Resource> getResourceClass()
                                           throws ClassNotFoundException
```
    Get method for the resource class. Asks the GATE class loader to load it, if it is not already present.
    
    Throws:
    
    ClassNotFoundException
  - setJarFileName
```
public void setJarFileName(String jarFileName)
```
    Set method for the resource jar file name
  - getJarFileName
```
public String getJarFileName()
```
    Get method for the resource jar file name
  - setJarFileUrl
```
public void setJarFileUrl(URL jarFileUrl)
```
    Set method for the resource jar file URL
  - getJarFileUrl
```
public URL getJarFileUrl()
```
    Get method for the resource jar file URL
  - setXmlFileUrl
```
public void setXmlFileUrl(URL xmlFileUrl)
```
    Set the URL to the creole.xml file that defines this resource
  - getXmlFileUrl
```
public URL getXmlFileUrl()
```
    Get the URL to the creole.xml file that defines this resource
  - getComment
```
public String getComment()
```
    Get method for the resource comment
  - setComment
```
public void setComment(String comment)
```
    Set method for the resource comment
  - getHelpURL
```
public String getHelpURL()
```
    Get method for the resource helpURL
  - setHelpURL
```
public void setHelpURL(String helpURL)
```
    Set method for the resource helpURL
  - setParameterList
```
public void setParameterList(ParameterList parameterList)
```
    Set the parameter list
  - getParameterList
```
public ParameterList getParameterList()
```
    Get the parameter list
  - setAutoLoading
```
public void setAutoLoading(boolean autoLoading)
```
    Set method for resource autoloading flag
  - isAutoLoading
```
public boolean isAutoLoading()
```
    Is the resource autoloading?
  - setPrivate
```
public void setPrivate(boolean priv)
```
    Set method for resource private flag
  - isPrivate
```
public boolean isPrivate()
```
    Is the resource private?
  - setTool
```
public void setTool(boolean tool)
```
    Set method for resource tool flag
  - isTool
```
public boolean isTool()
```
    Is the resource a tool?
  - isValid
```
public boolean isValid()
```
    Is this a valid resource data configuration? If not, leave an error message that can be returned by getValidityMessage().
  - getValidityMessage
```
public String getValidityMessage()
```
    Get validity statues message.
  - setGuiType
```
public void setGuiType(int aGuiType)
```
    A simple mutator for guiType field
  - getGuiType
```
public int getGuiType()
```
    A simple accessor for guiType field
  - setIsMainView
```
public void setIsMainView(boolean mainView)
```
    A simple mutator for isMainView field
  - isMainView
```
public boolean isMainView()
```
    A simple accessor for isMainView field
  - setResourceDisplayed
```
public void setResourceDisplayed(String aResourceDisplayed)
```
    A simple mutator for resourceDisplayed field
  - getResourceDisplayed
```
public String getResourceDisplayed()
```
    A simple accessor for resourceDisplayed field
  - setAnnotationTypeDisplayed
```
public void setAnnotationTypeDisplayed(String anAnnotationTypeDisplayed)
```
    A simple mutator for annotationTypeDisplayed field
  - getAnnotationTypeDisplayed
```
public String getAnnotationTypeDisplayed()
```
    A simple accessor for annotationTypeDisplayed field
  - getSharableProperties
```
public Collection<String> getSharableProperties()
```
    Get the collection of property names that should be treated as sharable state when duplicating resources of this type. The specified properties may also be declared as parameters of the resource but this is not required.
  - init
```
public void init()
          throws Exception
```
    Initialize this ResourceData. Called by CreoleXmlHandler once all the properties of this ResourceData specified in the XML have been filled in, but before autoinstances are created.
    
    Throws:
    
    Exception

Class ResourceData

Field Summary

Fields inherited from class gate.util.AbstractFeatureBearer

Constructor Summary

Method Summary

Methods inherited from class gate.util.AbstractFeatureBearer

Methods inherited from class java.lang.Object

Field Detail

DEBUG

DEFAULT_LR_ICON

DEFAULT_PR_ICON

DEFAULT_EXPORTER_ICON

DEFAULT_OTHER_ICON

name

icon

instantiationStack

unmodifiableInstantiationStack

className

interfaceName

resourceClass

jarFileName

jarFileUrl

xmlFileName

xmlFileUrl

comment

helpURL

parameterList

autoLoading

priv

tool

validityMessage

NULL_GUI

LARGE_GUI

SMALL_GUI

guiType

isMainView

resourceDisplayed

annotationTypeDisplayed

sharableProperties

Constructor Detail

ResourceData

Method Detail

getReferenceCount

reduceReferenceCount

increaseReferenceCount

toString

equals

hashCode

setName

getName

setIcon

getIcon

guessIcon

getInstantiations

addInstantiation

removeInstantiation

setClassName

getClassName

setInterfaceName

getInterfaceName

setResourceClass

getResourceClass

setJarFileName

getJarFileName

setJarFileUrl

getJarFileUrl

setXmlFileUrl

getXmlFileUrl

getComment

setComment

getHelpURL

setHelpURL

setParameterList

getParameterList

setAutoLoading

isAutoLoading

setPrivate

isPrivate

setTool

isTool