|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.analysis_component.AnalysisComponent_ImplBase
org.apache.uima.analysis_component.Annotator_ImplBase
org.apache.uima.analysis_component.CasAnnotator_ImplBase
org.apache.uima.tools.components.XmlDetagger
public class XmlDetagger
A multi-sofa annotator that does XML detagging. Reads XML data from the input Sofa (named "xmlDocument"); this data can be stored in the CAS as a string or array, or it can be a URI to a remote file. The XML is parsed using the JVM's default parser, and the plain-text content is written to a new sofa called "plainTextDocument".
Field Summary | |
---|---|
static java.lang.String |
PARAM_TEXT_TAG
Name of optional configuration parameter that contains the name of an XML tag that appears in the input file. |
Constructor Summary | |
---|---|
XmlDetagger()
|
Method Summary | |
---|---|
static AnalysisEngineDescription |
getDescription()
Parses and returns the descriptor for this Analysis Gnein. |
static java.net.URL |
getDescriptorURL()
|
void |
initialize(UimaContext aContext)
Performs any startup tasks required by this component. |
void |
process(CAS aCAS)
Inputs a CAS to the AnalysisComponent. |
void |
typeSystemInit(TypeSystem aTypeSystem)
Informs this annotator that the CAS TypeSystem has changed. |
Methods inherited from class org.apache.uima.analysis_component.CasAnnotator_ImplBase |
---|
getRequiredCasInterface, process |
Methods inherited from class org.apache.uima.analysis_component.Annotator_ImplBase |
---|
getCasInstancesRequired, hasNext, next |
Methods inherited from class org.apache.uima.analysis_component.AnalysisComponent_ImplBase |
---|
batchProcessComplete, collectionProcessComplete, destroy, getContext, getResultSpecification, reconfigure, setResultSpecification |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PARAM_TEXT_TAG
Constructor Detail |
---|
public XmlDetagger()
Method Detail |
---|
public void initialize(UimaContext aContext) throws ResourceInitializationException
AnalysisComponent
The framework supplies this AnalysisComponent with a reference to the UimaContext
that
it will use, for example to access configuration settings or resources. This AnalysisComponent
should store a reference to its the UimaContext
for later use.
initialize
in interface AnalysisComponent
initialize
in class AnalysisComponent_ImplBase
aContext
- Provides access to services and resources managed by the framework. This includes
configuration parameters, logging, and access to external resources.
ResourceInitializationException
- if this AnalysisComponent cannot initialize successfully.public void typeSystemInit(TypeSystem aTypeSystem) throws AnalysisEngineProcessException
CasAnnotator_ImplBase
AnalysisComponent_ImplBase.initialize(org.apache.uima.UimaContext)
, and will call
it again whenever the CAS TypeSystem changes.
In this method, the Annotator should use the TypeSystem
to resolve the names of Type
and Features to the actual Type
and
Feature
objects, which can then be used during processing.
typeSystemInit
in class CasAnnotator_ImplBase
AnalysisEngineProcessException
- if the provided type system is missing types or features required by this annotatorpublic void process(CAS aCAS) throws AnalysisEngineProcessException
CasAnnotator_ImplBase
process
in class CasAnnotator_ImplBase
aCAS
- A CAS that this AnalysisComponent should process.
AnalysisEngineProcessException
- if a problem occurs during processingpublic static AnalysisEngineDescription getDescription() throws InvalidXMLException
InvalidXMLException
- if the descriptor is invalid or missingpublic static java.net.URL getDescriptorURL()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |