org.apache.ctakes.core.cc

Class FilesInDirectoryCasConsumer

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.resource.ConfigurableResource_ImplBase

org.apache.uima.collection.CasConsumer_ImplBase

org.apache.ctakes.core.cc.FilesInDirectoryCasConsumer

All Implemented Interfaces:

org.apache.uima.collection.base_cpm.CasObjectProcessor, org.apache.uima.collection.base_cpm.CasProcessor, org.apache.uima.collection.CasConsumer, org.apache.uima.resource.ConfigurableResource, org.apache.uima.resource.Resource

@PipeBitInfo(name="Document Text Writer",
             description="Writes Text files with original text from the document.",
             role=WRITER,
             dependencies=DOCUMENT_ID)
public class FilesInDirectoryCasConsumer
extends org.apache.uima.collection.CasConsumer_ImplBase

For each CAS a local file with the document text is written to a directory specifed by a parameter. This CAS consumer does not make use of any annotation information in the cas except for the document id specified the CommonTypeSystem.xml descriptor. The document id will be the name of the file written for each CAS.

This CAS consumer may be useful if you want to write the results of a collection reader and/or CAS initializer to the local file system. For example, a JDBC Collection Reader may read XML documents from a database and a specialized cas initializer may convert the XML to plain text. The FilesInDirectoryCasConsumer can now be used to write the plain text to local plain text files.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_OUTPUTDIR

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 and Description
FilesInDirectoryCasConsumer()

Method Summary

Modifier and Type	Method and Description
void	initialize()
void	processCas(org.apache.uima.cas.CAS cas)

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, 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 String PARAM_OUTPUTDIR

See Also:

Constant Field Values

Constructor Detail

FilesInDirectoryCasConsumer

public FilesInDirectoryCasConsumer()

Method Detail

initialize

public void initialize()
                throws org.apache.uima.resource.ResourceInitializationException

Overrides:

initialize in class org.apache.uima.collection.CasConsumer_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

processCas

public void processCas(org.apache.uima.cas.CAS cas)
                throws org.apache.uima.resource.ResourceProcessException

Throws:

org.apache.uima.resource.ResourceProcessException