|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ResourceCreationSpecifier
A ResourceCreationSpecifier
is the supertype of
AnalysisEngineDescription
,
CasConsumerDescription
,
CollectionReaderDescription
, and
CasInitializerDescription
.
All Resource Creation Specifiers must the following:
frameworkImplementation
: The name of the UIMA framework in which the
component executes. The name for this implementation is given by Constants.JAVA_FRAMEWORK_NAME
.
A component that runs in the C++ enablement layer needs to have the framework name given by
Constants.CPP_FRAMEWORK_NAME
.
implementationName
: The fully-qualified Java class name of the user's
component (Annotator, CAS Consumer, Collection Reader, or CAS Initializer).
metaData
: the ResourceMetaData
describing the resourceExternalResourceDependency
objects that define this resource's dependencies
on other resources.ExternalResourceDescription
objects that satisfy the dependencies.
Method Summary | |
---|---|
void |
doFullValidation()
Does full validation of this specifier. |
void |
doFullValidation(ResourceManager aResourceManager)
Does full validation of this specifier. |
ExternalResourceDependency[] |
getExternalResourceDependencies()
Retrieves descriptions of this Analysis Engine's dependencies on external resources. |
ExternalResourceDependency |
getExternalResourceDependency(String aKey)
Gets the external resource dependency with the given key. |
String |
getFrameworkImplementation()
Gets the name of the AE framework implementation within which the CasConsumer executes. |
String |
getImplementationName()
Retrieves the name of the CasConsumer implementation. |
ResourceMetaData |
getMetaData()
Retrieves the ResourceMetaData to assign to the newly constructed Resource. |
ResourceManagerConfiguration |
getResourceManagerConfiguration()
Retrieves the Resource Manager configuration, which declares the resources that satisfy the dependencies defined by getExternalResourceDependencies() . |
void |
setExternalResourceDependencies(ExternalResourceDependency[] aDependencies)
Sets the descriptions of this AnalysisEngine's dependencies on external resources. |
void |
setFrameworkImplementation(String aFrameworkImplementation)
Sets the name of the AE framework implementation within which the CasConsumer executes. |
void |
setImplementationName(String aImplementationName)
Sets the name of the CasConsumer implementation. |
void |
setMetaData(ResourceMetaData aMetaData)
Sets the MetaData for this ResourceCreationSpecifier . |
void |
setResourceManagerConfiguration(ResourceManagerConfiguration aResourceManagerConfiguration)
Sets the Resource Manager configuration, which declares the resources that satisfy the dependencies defined by getExternalResourceDependencies() . |
void |
validate()
Checks that this specifier is valid. |
void |
validate(ResourceManager aResourceManager)
Checks that this specifier is valid. |
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 |
---|
String getFrameworkImplementation()
Constants.JAVA_FRAMEWORK_NAME
..
void setFrameworkImplementation(String aFrameworkImplementation)
Constants.JAVA_FRAMEWORK_NAME
..
aFrameworkImplementation
- the framework implementation nameString getImplementationName()
void setImplementationName(String aImplementationName)
aImplementationName
- the implementation name of the CasConsumerResourceMetaData getMetaData()
ResourceMetaData
to assign to the newly constructed Resource.
void setMetaData(ResourceMetaData aMetaData)
ResourceCreationSpecifier
.
aMetaData
- metadata to assignExternalResourceDependency[] getExternalResourceDependencies()
Annotators
can use to locate the Resource (using the
AnnotatorContext.getResourceObject(String)
method).
ExternalResourceDependency
objects that describe this
AnalysisEngine's resource dependencies.void setExternalResourceDependencies(ExternalResourceDependency[] aDependencies)
aDependencies
- an array of ExternalResourceDependency
objects that describe this
AnalysisEngine's resource dependencies.ExternalResourceDependency getExternalResourceDependency(String aKey)
aKey
- the key of the exteranl resource dependency to get
null
if none.ResourceManagerConfiguration getResourceManagerConfiguration()
getExternalResourceDependencies()
.
void setResourceManagerConfiguration(ResourceManagerConfiguration aResourceManagerConfiguration)
getExternalResourceDependencies()
.
aResourceManagerConfiguration
- the Resource Manager configuration that describes how external resource dependencies
are bound to actual resources.void validate() throws ResourceInitializationException, ResourceConfigurationException
doFullValidation()
.
ResourceInitializationException
- if aDesc
is invalid
ResourceConfigurationException
- if the configuration parameter settings in aDesc
are invalidvoid validate(ResourceManager aResourceManager) throws ResourceInitializationException, ResourceConfigurationException
doFullValidation()
.
aResourceManager
- a ResourceManager instance to use to resolve imports by name.
ResourceInitializationException
- if aDesc
is invalid
ResourceConfigurationException
- if the configuration parameter settings in aDesc
are invalidvoid doFullValidation() throws ResourceInitializationException
ResourceInitializationException
- if validation failedvoid doFullValidation(ResourceManager aResourceManager) throws ResourceInitializationException
aResourceManager
- a ResourceManager instance to use to load annotator classes, external resource
classes, and resolve imports by name.
ResourceInitializationException
- if validation failed
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |