org.apache.uima.tools.components
Class XCasWriterCasConsumer
java.lang.Object
org.apache.uima.resource.Resource_ImplBase
org.apache.uima.resource.ConfigurableResource_ImplBase
org.apache.uima.collection.CasConsumer_ImplBase
org.apache.uima.tools.components.XCasWriterCasConsumer
- All Implemented Interfaces:
- CasObjectProcessor, CasProcessor, CasConsumer, ConfigurableResource, Resource
public class XCasWriterCasConsumer
- extends CasConsumer_ImplBase
A simple CAS consumer that generates XCAS (XML representation of the CAS) files in the
filesystem. The output files are written using the UTF-8 charset.
This CAS Consumer takes one parameters:
OutputDirectory
- path to directory into which output files will be written
The XML descriptor for this collection reader is stored in the uima.jar file as
org/apache/uima/util/XCasWriterCasConsumer.xml
. It can be accessed via the static
method getDescription()
, which parses the descriptor and returns a
CasConsumerDescription
object.
Field Summary |
static java.lang.String |
PARAM_OUTPUTDIR
Name of configuration parameter that must be set to the path of a directory into which the
output files will be written. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PARAM_OUTPUTDIR
public static final java.lang.String PARAM_OUTPUTDIR
- Name of configuration parameter that must be set to the path of a directory into which the
output files will be written.
- See Also:
- Constant Field Values
XCasWriterCasConsumer
public XCasWriterCasConsumer()
initialize
public void initialize()
throws ResourceInitializationException
- Description copied from class:
CasConsumer_ImplBase
- This method is called during initialization, and does nothing by default. Subclasses should
override it to perform one-time startup logic.
- Overrides:
initialize
in class CasConsumer_ImplBase
- Throws:
ResourceInitializationException
- if a failure occurs during initialization.
processCas
public void processCas(CAS aCAS)
throws ResourceProcessException
- Processes the CasContainer which was populated by the TextAnalysisEngines.
In this case, the CAS is converted to XML and written into the output file .
- Parameters:
aCAS
- a CAS which has been populated by the Analysis Engines
- Throws:
ResourceProcessException
- if there is an error in processing the Resource- See Also:
CasObjectProcessor.processCas(org.apache.uima.cas.CAS)
getDescription
public static CasConsumerDescription getDescription()
throws InvalidXMLException
- Parses and returns the descriptor for this collection reader. The descriptor is stored in the
uima.jar file and located using the ClassLoader.
- Returns:
- an object containing all of the information parsed from the descriptor.
- Throws:
InvalidXMLException
- if the descriptor is invalid or missing
getDescriptorURL
public static java.net.URL getDescriptorURL()
Copyright © 2013. All Rights Reserved.