|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--gate.util.AbstractFeatureBearer | +--gate.creole.ResourceData
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.
CreoleRegister
, Serialized FormConstructor Summary | |
ResourceData()
Construction |
Method Summary | |
void |
addInstantiation(Resource resource)
Add an instantiation of the resource to the register of these |
void |
addView(FeatureMap viewFeatures)
Add a view (a feature map minimally defining the view's TYPE and TITLE). |
void |
bumpInstantiation(Resource resource)
Bump an instantiation to the top of the instantiation stack |
boolean |
equals(Object other)
Equality: two resource data objects are the same if they have the same name |
List |
getAllSmallViews()
Get all the small views of this resource and those Resource classes that it inherits from. |
List |
getAllViews()
Get all the (not small) views of this resource and those Resource classes that it inherits from. |
List |
getAllViews(boolean small)
Get all the views of this resource and those Resource classes that it inherits from. |
String |
getClassName()
Get method for the resource class name |
String |
getComment()
Get method for the resource comment |
String |
getIcon()
Get method for the resource icon |
BumpyStack |
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 |
Class |
getResourceClass()
Get method for the resource class. |
List |
getSmallViews()
Get the views registered for this resource. |
String |
getValidityMessage()
Get validity statues message. |
List |
getViews()
Get the views registered for this resource. |
String |
getXmlFileName()
Get method for the resource xml file name |
URL |
getXmlFileUrl()
Deprecated. Get method for the resource xml file URL |
int |
hashCode()
Hashing, based on the name field of the object |
boolean |
isAutoLoading()
Is the resource autoloading? |
boolean |
isPrivate()
Is the resource private? |
boolean |
isTool()
Is the resource a tool? |
boolean |
isValid()
Is this a valid resource data configuration? If not, leave an error message that can be returned by getValidityMessage(). |
void |
removeInstantiation(Resource resource)
Remove an instantiation of the resource from the register of these |
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 |
setIcon(String icon)
Set method for the resource icon |
void |
setInterfaceName(String interfaceName)
Set method for the resource interface name |
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 resourceClass)
Set method for the resource class |
void |
setTool(boolean tool)
Set method for resource tool flag |
void |
setXmlFileName(String xmlFileName)
Set method for the resource xml file name |
void |
setXmlFileUrl(URL xmlFileUrl)
Set method for the resource xml file URL |
String |
toString()
String representation |
Methods inherited from class gate.util.AbstractFeatureBearer |
getFeatures, setFeatures |
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ResourceData()
Method Detail |
public String toString()
toString
in class Object
public boolean equals(Object other)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void setName(String name)
setName
in class AbstractFeatureBearer
public String getName()
getName
in class AbstractFeatureBearer
public void setIcon(String icon)
public String getIcon()
public BumpyStack getInstantiations()
public void addInstantiation(Resource resource)
public void removeInstantiation(Resource resource)
public void bumpInstantiation(Resource resource)
public void setClassName(String className)
public String getClassName()
public void setInterfaceName(String interfaceName)
public String getInterfaceName()
public void setResourceClass(Class resourceClass)
public Class getResourceClass() throws ClassNotFoundException
public void setJarFileName(String jarFileName)
public String getJarFileName()
public void setJarFileUrl(URL jarFileUrl)
public URL getJarFileUrl()
public void setXmlFileName(String xmlFileName)
public String getXmlFileName()
public void setXmlFileUrl(URL xmlFileUrl)
public URL getXmlFileUrl()
public String getComment()
public void setComment(String comment)
public void setParameterList(ParameterList parameterList)
public ParameterList getParameterList()
public void setAutoLoading(boolean autoLoading)
public boolean isAutoLoading()
public void setPrivate(boolean priv)
public boolean isPrivate()
public void setTool(boolean tool)
public boolean isTool()
public void addView(FeatureMap viewFeatures)
public List getViews()
This list excludes views that have the SMALL attribute set true.
public List getSmallViews()
This list contains only those views that have the SMALL attribute set true.
public List getAllViews()
Each member of the list is a FeatureMap with a TYPE attribute giving the class name of the vcvs upiewer. Other data to be passed to the viewer is present as other features on the map.
public List getAllSmallViews()
Each member of the list is a FeatureMap with a TYPE attribute giving the class name of the vcvs upiewer. Other data to be passed to the viewer is present as other features on the map.
public List getAllViews(boolean small)
Each member of the list is a FeatureMap with a TYPE attribute giving the class name of the vcvs upiewer. Other data to be passed to the viewer is present as other features on the map.
small
- If true then small views are returned; else non-small viewspublic boolean isValid()
public String getValidityMessage()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |