org.apache.ctakes.core.cc

Class XmiWriterCasConsumerCtakes

java.lang.Object

org.apache.uima.analysis_component.AnalysisComponent_ImplBase

org.apache.uima.analysis_component.Annotator_ImplBase

org.apache.uima.analysis_component.CasAnnotator_ImplBase

org.apache.uima.fit.component.CasConsumer_ImplBase

org.apache.ctakes.core.cc.XmiWriterCasConsumerCtakes

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

@PipeBitInfo(name="XMI Writer",
             description="Writes XMI files with full representation of input text and all extracted information.",
             role=WRITER,
             dependencies=DOCUMENT_ID)
public class XmiWriterCasConsumerCtakes
extends org.apache.uima.fit.component.CasConsumer_ImplBase

A simple CAS consumer that writes the CAS to XMI format.

This CAS Consumer takes one parameter:

• OutputDirectory - path to directory into which output files will be written

Field Summary

Fields

Modifier and Type	Field and Description
static 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.

Constructor Summary

Constructors

Constructor and Description
XmiWriterCasConsumerCtakes()

Method Summary

Modifier and Type	Method and Description
static org.apache.uima.collection.CasConsumerDescription	getDescription() Parses and returns the descriptor for this collection reader.
static URL	getDescriptorURL()
void	initialize(org.apache.uima.UimaContext context)
void	process(org.apache.uima.cas.CAS aCAS) Processes the CAS which was populated by the TextAnalysisEngines.

Methods inherited from class org.apache.uima.fit.component.CasConsumer_ImplBase

getLogger

Methods inherited from class org.apache.uima.analysis_component.CasAnnotator_ImplBase

getRequiredCasInterface, process, typeSystemInit

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

PARAM_OUTPUTDIR

public static final 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

Constructor Detail

XmiWriterCasConsumerCtakes

public XmiWriterCasConsumerCtakes()

Method Detail

initialize

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

Specified by:

initialize in interface org.apache.uima.analysis_component.AnalysisComponent

Overrides:

initialize in class org.apache.uima.fit.component.CasConsumer_ImplBase

Throws:

org.apache.uima.resource.ResourceInitializationException

process

public void process(org.apache.uima.cas.CAS aCAS)
             throws org.apache.uima.analysis_engine.AnalysisEngineProcessException

Processes the CAS which was populated by the TextAnalysisEngines.
In this case, the CAS is converted to XMI and written into the output file .

Specified by:

process in class org.apache.uima.analysis_component.CasAnnotator_ImplBase

Parameters:

aCAS - a CAS which has been populated by the TAEs

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

See Also:

CasObjectProcessor.processCas(org.apache.uima.cas.CAS)

getDescription

public static org.apache.uima.collection.CasConsumerDescription getDescription()
                                                                        throws org.apache.uima.util.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:

org.apache.uima.util.InvalidXMLException - if the descriptor is invalid or missing

getDescriptorURL

public static URL getDescriptorURL()