Interface ExternalResourceBinding
-
- All Superinterfaces:
Cloneable
,MetaDataObject
,Serializable
,XMLizable
- All Known Implementing Classes:
ExternalResourceBinding_impl
public interface ExternalResourceBinding extends MetaDataObject
Binds anExternalResourceDependency
to anExternalResourceDescription
. The biding has two parts - thekey
, which indicates the resource dependency being bound, and theresource name
, which identifies the resource to which that dependency is bound.
-
-
Field Summary
Fields Modifier and Type Field Description static ExternalResourceBinding[]
EMPTY_RESOURCE_BINDINGS
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getKey()
Retrieves the key that identifies theExternalResourceDependency
being bound.String
getResourceName()
Retrieves the name of the actual Resource instance that will satisfy this dependency.void
setKey(String aKey)
Sets the key that identifies theExternalResourceDependency
being bound.void
setResourceName(String aName)
Sets the name of the actual Resource instance that will satisfy this dependency.-
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
-
-
-
-
Field Detail
-
EMPTY_RESOURCE_BINDINGS
static final ExternalResourceBinding[] EMPTY_RESOURCE_BINDINGS
-
-
Method Detail
-
getKey
String getKey()
Retrieves the key that identifies theExternalResourceDependency
being bound. If this binding is declared in a primitive component, this is exactly the same key as is specified in theExternalResourceDependency
.Within an aggregate, a slash-separated name is used to identify which component the binding applies to. For example, if an Aggregate AE contains an annotator with key
annotator1
which declares a resource dependencymyResource
, that Aggregate AE could binding that resource dependency by using the keyannotator1/myResource
.- Returns:
- the key for this resource binding.
-
setKey
void setKey(String aKey)
Sets the key that identifies theExternalResourceDependency
being bound. If this binding is declared in a primitive component, this is exactly the same key as is specified in theExternalResourceDependency
.Within an aggregate, a slash-separated name is used to identify which component the binding applies to. For example, if an Aggregate AE contains an annotator with key
annotator1
which declares a resource dependencymyResource
, that Aggregate AE could binding that resource dependency by using the keyannotator1/myResource
.- Parameters:
aKey
- the key for this resource binding.
-
getResourceName
String getResourceName()
Retrieves the name of the actual Resource instance that will satisfy this dependency. This name must match one of the names specified in anExternalResourceDescription
within the enclosingResourceManagerConfiguration
object.- Returns:
- the name of the resource satisfying this dependency.
-
setResourceName
void setResourceName(String aName)
Sets the name of the actual Resource instance that will satisfy this dependency. This name must match one of the names specified in anExternalResourceDescription
within the enclosingResourceManagerConfiguration
object.- Parameters:
aName
- the name of the resource satisfying this dependency.
-
-