|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.resource.metadata.impl.MetaDataObject_impl
org.apache.uima.resource.metadata.impl.Capability_impl
public class Capability_impl
Reference implementation of Capability
Constructor Summary | |
---|---|
Capability_impl()
|
Method Summary | |
---|---|
void |
addInputFeature(java.lang.String aFeatureName)
A convenience method that adds an input Feature to this Capability. |
void |
addInputSofa(java.lang.String aSofaName)
A convenience method that adds an input Sofa name to this Capability. |
void |
addInputType(java.lang.String aTypeName,
boolean aAllAnnotatorFeatures)
A convenience method that adds an input Type to this Capability. |
void |
addOutputFeature(java.lang.String aFeatureName)
A convenience method that adds an output Feature to this Capability. |
void |
addOutputSofa(java.lang.String aSofaName)
A convenience method that adds an output Sofa name to this Capability. |
void |
addOutputType(java.lang.String aTypeName,
boolean aAllAnnotatorFeatures)
A convenience method that adds an output Type to this Capability. |
void |
addSupportedLanguage(java.lang.String aLanguage)
A convenience method that adds a supported language to this Capability. |
java.lang.String |
getDescription()
Gets the description of this Capability. |
TypeOrFeature[] |
getInputs()
Gets the inputs of this Capability. |
java.lang.String[] |
getInputSofas()
Gets the inputs Sofa names of this Capability. |
java.lang.String[] |
getLanguagesSupported()
A convenience method that analyzes the preconditions of this Capability and
returns the ISO language identifiers that the Resource supports. |
java.lang.String[] |
getMimeTypesSupported()
A convenience method that analyzes the preconditions of this Capability and
returns the MIME types that the Resource can take as input. |
TypeOrFeature[] |
getOutputs()
Gets the outputs of this Capability. |
java.lang.String[] |
getOutputSofas()
Gets the output Sofa names of this Capability. |
Precondition[] |
getPreconditions()
Retrieves the preconditions that must be satisfied in order for the Resource to begin processing. |
protected XmlizationInfo |
getXmlizationInfo()
To be implemented by subclasses to return information describing how to represent this object in XML. |
void |
removeSupportedLanguage(java.lang.String aLanguage)
A convenience method that removes a supported language from this Capability. |
void |
setDescription(java.lang.String aDescription)
Sets the description of this Capability. |
void |
setInputs(TypeOrFeature[] aInputs)
Sets the inputs of this Capability. |
void |
setInputSofas(java.lang.String[] aInputSofaNames)
Reserved for future use. |
void |
setLanguagesSupported(java.lang.String[] aLanguageIDs)
A convenience method that sets the languages that this Resource supports. |
void |
setMimeTypesSupported(java.lang.String[] aMimeTypes)
A convenience method that sets the MIME types that this Resource can take as input. |
void |
setOutputs(TypeOrFeature[] aOutputs)
Sets the outputs of this Capability. |
void |
setOutputSofas(java.lang.String[] aOutputSofaNames)
Sets the output Sofa names of this capabilitty |
void |
setPreconditions(Precondition[] aPreconditions)
Sets the Precondition s of this Capability . |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
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 |
Constructor Detail |
---|
public Capability_impl()
Method Detail |
---|
public java.lang.String getDescription()
Capability
getDescription
in interface Capability
public void setDescription(java.lang.String aDescription)
Capability
setDescription
in interface Capability
aDescription
- aDescription the description of this Capability.public TypeOrFeature[] getInputs()
Capability
getInputs
in interface Capability
org.apache.uima.analysis_engine.metadata.Capability#getInputs()
public TypeOrFeature[] getOutputs()
Capability
getOutputs
in interface Capability
org.apache.uima.analysis_engine.metadata.Capability#getOutputs()
public Precondition[] getPreconditions()
Capability
getPreconditions
in interface Capability
Precondition
s.org.apache.uima.analysis_engine.metadata.Capability#getPreconditions()
public java.lang.String[] getLanguagesSupported()
Capability
Capability
and
returns the ISO language identifiers that the Resource supports. This is only meaningful when
analyzing text documents.
getLanguagesSupported
in interface Capability
org.apache.uima.analysis_engine.metadata.Capability#getLanguagesSupported()
public java.lang.String[] getMimeTypesSupported()
Capability
Capability
and
returns the MIME types that the Resource can take as input.
getMimeTypesSupported
in interface Capability
Capability.getMimeTypesSupported()
public void setInputs(TypeOrFeature[] aInputs)
Capability
setInputs
in interface Capability
aInputs
- an array of references to Types or Features in this Resource's TypeSystem.org.apache.uima.analysis_engine.metadata.Capability#setInputs(TypeOrFeature[])
public void setOutputs(TypeOrFeature[] aOutputs)
Capability
setOutputs
in interface Capability
aOutputs
- an array of references to Types or Features in this Resource's TypeSystem.org.apache.uima.analysis_engine.metadata.Capability#setOutputs(TypeOrFeature[])
public void setPreconditions(Precondition[] aPreconditions)
Capability
Precondition
s of this Capability
.
setPreconditions
in interface Capability
aPreconditions
- an array of Precondition
objectsorg.apache.uima.analysis_engine.metadata.Capability#setPreconditions(Precondition[])
public void setLanguagesSupported(java.lang.String[] aLanguageIDs)
Capability
Calling this method affects the preconditions of this Capability
. All other
language support preconditions will be removed, but non-language related preconditions will be
unaffected.
setLanguagesSupported
in interface Capability
aLanguageIDs
- an array of ISO language identifiers. An empty array means that the Resource claims to
be language-independent.org.apache.uima.analysis_engine.metadata.Capability#setLanguagesSupported(String[])
public void setMimeTypesSupported(java.lang.String[] aMimeTypes)
Capability
Calling this method affects the preconditions of this Capability
. All other
MIME type preconditions will be removed, but other preconditions will be unaffected.
setMimeTypesSupported
in interface Capability
aMimeTypes
- an array of MIME types. This may be empty if the Resource does not declare MIME type
preconditions.Capability.setMimeTypesSupported(java.lang.String[])
public void addInputType(java.lang.String aTypeName, boolean aAllAnnotatorFeatures)
Capability
addInputType
in interface Capability
aTypeName
- the fully qualified type nameaAllAnnotatorFeatures
- if true, indicates that this Capability requires as input all features of this type
that are specified in the same AnalysisEngine descriptor. If false, features must be
explicitly declared by calling Capability.addInputFeature(String)
.org.apache.uima.analysis_engine.metadata.Capability#addInputType(java.lang.String,
boolean)
public void addInputFeature(java.lang.String aFeatureName)
Capability
addInputFeature
in interface Capability
aFeatureName
- the fully qualified feature nameorg.apache.uima.analysis_engine.metadata.Capability#addInputFeature(java.lang.String)
public void addOutputType(java.lang.String aTypeName, boolean aAllAnnotatorFeatures)
Capability
addOutputType
in interface Capability
aTypeName
- the fully qualified type nameaAllAnnotatorFeatures
- if true, indicates that this Capability declares as output all features of this type
that are specified in the same AnalysisEngine descriptor. If false, features must be
explicitly declared by calling Capability.addOutputFeature(String)
.org.apache.uima.analysis_engine.metadata.Capability#addOutputType(java.lang.String,
boolean)
public void addOutputFeature(java.lang.String aFeatureName)
Capability
addOutputFeature
in interface Capability
aFeatureName
- the fully qualified feature nameorg.apache.uima.analysis_engine.metadata.Capability#addOutputFeature(java.lang.String)
public void addSupportedLanguage(java.lang.String aLanguage)
Capability
addSupportedLanguage
in interface Capability
aLanguage
- the ISO language identifierorg.apache.uima.analysis_engine.metadata.Capability#addSupportedLanguage(java.lang.String)
public void removeSupportedLanguage(java.lang.String aLanguage)
Capability
removeSupportedLanguage
in interface Capability
aLanguage
- the ISO language identifierpublic java.lang.String[] getInputSofas()
Capability
getInputSofas
in interface Capability
public java.lang.String[] getOutputSofas()
Capability
getOutputSofas
in interface Capability
public void setInputSofas(java.lang.String[] aInputSofaNames)
Capability
setInputSofas
in interface Capability
public void setOutputSofas(java.lang.String[] aOutputSofaNames)
Capability
setOutputSofas
in interface Capability
aOutputSofaNames
- an array of strings containing SoFA namepublic void addInputSofa(java.lang.String aSofaName)
Capability
addInputSofa
in interface Capability
public void addOutputSofa(java.lang.String aSofaName)
Capability
addOutputSofa
in interface Capability
protected XmlizationInfo getXmlizationInfo()
MetaDataObject_impl
getXmlizationInfo
in class MetaDataObject_impl
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |