Package org.apache.uima.resource
Interface ExternalResourceDescription
- All Superinterfaces:
Cloneable,MetaDataObject,Serializable,XMLizable
- All Known Implementing Classes:
ExternalResourceDescription_impl
An
ExternalResourceDescription object describes a resource that is loaded in the
ResourceManager and may be shared between components. This
object has four properties:
- A name, used to identify the resource.
- A textual description of the resource.
- A
ResourceSpecifierthat describes how to create the resource (for simple data resources this will be aFileResourceSpecifierthat contains a URL to the data file. - The name of a Java class that implements the specified interface and which also implements
SharedResourceObject.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionRetrieves the textual description of the resource.Retrieves the name of the Java class to be instantiated from the resource data.getName()Retrieves the name by which the resource is identified.Retrieves theResourceSpecifierthat describes how to create the resource.voidsetDescription(String aDescription) Retrieves the textual description of the resource.voidsetImplementationName(String aName) Sets the name of the Java class to be instantiated from the resource data.voidSets the name by which the resource is identified.voidsetResourceSpecifier(ResourceSpecifier aSpecifier) Sets theResourceSpecifierthat describes how to create the resource.Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Field Details
-
EMPTY_EXTERNAL_RESORUCE_DESCRIPTIONS
-
-
Method Details
-
getName
String getName()Retrieves the name by which the resource is identified.- Returns:
- the name of this resource.
-
setName
Sets the name by which the resource is identified.- Parameters:
aName- the name of this resource.
-
getDescription
String getDescription()Retrieves the textual description of the resource.- Returns:
- the textual description of the resource.
-
setDescription
Retrieves the textual description of the resource.- Parameters:
aDescription- the textual description of the resource.
-
getResourceSpecifier
ResourceSpecifier getResourceSpecifier()Retrieves theResourceSpecifierthat describes how to create the resource.- Returns:
- the
ResourceSpecifierfor this external resource
-
setResourceSpecifier
Sets theResourceSpecifierthat describes how to create the resource.- Parameters:
aSpecifier- theResourceSpecifierfor this external resource- Throws:
UIMA_UnsupportedOperationException- if this object is not modifiable
-
getImplementationName
String getImplementationName()Retrieves the name of the Java class to be instantiated from the resource data. This must extendSharedResourceObjectas well as the interface specified byExternalResourceDependency.getInterfaceName().- Returns:
- the name of the Java class implementing the resource access
-
setImplementationName
Sets the name of the Java class to be instantiated from the resource data. This must extendSharedResourceObjectas well as the interface specified byExternalResourceDependency.getInterfaceName().- Parameters:
aName- the name of the Java class implementing the resource access- Throws:
UIMA_UnsupportedOperationException- if this object is not modifiable
-