public interface ExternalResourceDescription extends MetaDataObject
ExternalResourceDescription object describes a resource that is loaded in the
ResourceManager and may be shared between components. This
object has four properties:
ResourceSpecifier that describes how to create the
resource (for simple data resources this will be a
FileResourceSpecifier that contains a URL to the data file.SharedResourceObject. | Modifier and Type | Field and Description |
|---|---|
static ExternalResourceDescription[] |
EMPTY_EXTERNAL_RESORUCE_DESCRIPTIONS |
| Modifier and Type | Method and Description |
|---|---|
String |
getDescription()
Retrieves the textual description of the resource.
|
String |
getImplementationName()
Retrieves the name of the Java class to be instantiated from the resource data.
|
String |
getName()
Retrieves the name by which the resource is identified.
|
ResourceSpecifier |
getResourceSpecifier()
Retrieves the
ResourceSpecifier that describes how to create the resource. |
void |
setDescription(String aDescription)
Retrieves the textual description of the resource.
|
void |
setImplementationName(String aName)
Sets the name of the Java class to be instantiated from the resource data.
|
void |
setName(String aName)
Sets the name by which the resource is identified.
|
void |
setResourceSpecifier(ResourceSpecifier aSpecifier)
Sets the
ResourceSpecifier that describes how to create the resource. |
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlbuildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXMLstatic final ExternalResourceDescription[] EMPTY_EXTERNAL_RESORUCE_DESCRIPTIONS
String getName()
void setName(String aName)
aName - the name of this resource.String getDescription()
void setDescription(String aDescription)
aDescription - the textual description of the resource.ResourceSpecifier getResourceSpecifier()
ResourceSpecifier that describes how to create the resource.ResourceSpecifier for this external resourcevoid setResourceSpecifier(ResourceSpecifier aSpecifier)
ResourceSpecifier that describes how to create the resource.aSpecifier - the ResourceSpecifier for this external resourceUIMA_UnsupportedOperationException - if this object is not modifiableString getImplementationName()
SharedResourceObject as well as the interface specified
by ExternalResourceDependency.getInterfaceName().void setImplementationName(String aName)
SharedResourceObject as well as the interface specified by
ExternalResourceDependency.getInterfaceName().aName - the name of the Java class implementing the resource accessUIMA_UnsupportedOperationException - if this object is not modifiableCopyright © 2006–2021 The Apache Software Foundation. All rights reserved.