Package 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 methodgetDescription()
, which parses the descriptor and returns aCasConsumerDescription
object.
-
-
Field Summary
Fields Modifier and Type Field Description 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.-
Fields inherited from interface org.apache.uima.resource.Resource
PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT
-
-
Constructor Summary
Constructors Constructor Description XCasWriterCasConsumer()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CasConsumerDescription
getDescription()
Parses and returns the descriptor for this collection reader.static java.net.URL
getDescriptorURL()
void
initialize()
This method is called during initialization, and does nothing by default.void
processCas(CAS aCAS)
Processes the CasContainer which was populated by the TextAnalysisEngines.-
Methods inherited from class org.apache.uima.collection.CasConsumer_ImplBase
batchProcessComplete, collectionProcessComplete, destroy, getProcessingResourceMetaData, initialize, isReadOnly, isStateless, processCas, reconfigure, typeSystemInit
-
Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue
-
Methods inherited from class org.apache.uima.resource.Resource_ImplBase
getCasManager, getLogger, getMetaData, getRelativePathResolver, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.uima.resource.ConfigurableResource
getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue
-
Methods inherited from interface org.apache.uima.resource.Resource
getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger
-
-
-
-
Field Detail
-
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
-
-
Method Detail
-
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 classCasConsumer_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()
-
-