|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ExternalResourceDependency
An ExternalResourceDependency
object describes an resources's requirements on an
external resource. This object has four properties:
DataResource
interface will be used.
Method Summary | |
---|---|
java.lang.String |
getDescription()
Retrieves the textual description of the resource. |
java.lang.String |
getInterfaceName()
Retrieves the name of the Java interface through which this resource will be accessed. |
java.lang.String |
getKey()
Retrieves the key by which the resource is identified. |
boolean |
isOptional()
Gets whether this resource dependency is optional. |
void |
setDescription(java.lang.String aDescription)
Retrieves the textual description of the resource. |
void |
setInterfaceName(java.lang.String aName)
Sets the name of the Java interface through which this resource will be accessed. |
void |
setKey(java.lang.String aKey)
Sets the key by which the resource is identified. |
void |
setOptional(boolean aOptional)
Sets whether this resource dependency is optional. |
Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject |
---|
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl |
Methods inherited from interface org.apache.uima.util.XMLizable |
---|
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML |
Method Detail |
---|
java.lang.String getKey()
void setKey(java.lang.String aKey)
aKey
- the key for this resource.java.lang.String getDescription()
void setDescription(java.lang.String aDescription)
aDescription
- the textual description of the resource.java.lang.String getInterfaceName()
null
if none.void setInterfaceName(java.lang.String aName)
aName
- the name of the Java interface for this external resource, null
if
none.
UIMA_UnsupportedOperationException
- if this object is not modifiableboolean isOptional()
void setOptional(boolean aOptional)
aOptional
- true if this resource dependency is optional, false if not
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |