|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | 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 FormField Summary | |
static int |
LARGE_GUI
This type indicates that the resource goes into the large area of GATE GUI |
static int |
NULL_GUI
This type indicates that the resource is not a GUI |
static int |
SMALL_GUI
This type indicates that the resource goes into the small area of GATE GUI |
Constructor Summary | |
ResourceData()
Construction |
Method Summary | |
void |
addInstantiation(Resource resource)
Add an instantiation of the resource to the register of these |
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 |
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 |
getIcon()
Get method for the resource icon |
WeakBumpyStack |
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. |
String |
getResourceDisplayed()
A simple accessor for resourceDisplayed field |
String |
getValidityMessage()
Get validity statues message. |
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 |
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? If not, leave an error message that can be returned by getValidityMessage(). |
void |
makeInstantiationPersistant(Resource resource)
This method makes a certain resource persistant by adding it into a persistantInstantiationList. |
void |
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 |
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 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 |
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 |
Field Detail |
public static final int NULL_GUI
public static final int LARGE_GUI
public static final int SMALL_GUI
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)
public String getName()
public void setIcon(String icon)
public String getIcon()
public WeakBumpyStack getInstantiations()
public void addInstantiation(Resource resource)
public void makeInstantiationPersistant(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
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 boolean isValid()
public String getValidityMessage()
public void setGuiType(int aGuiType)
public int getGuiType()
public void setIsMainView(boolean mainView)
public boolean isMainView()
public void setResourceDisplayed(String aResourceDisplayed)
public String getResourceDisplayed()
public void setAnnotationTypeDisplayed(String anAnnotationTypeDisplayed)
public String getAnnotationTypeDisplayed()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |