org.apache.ctakes.core.cc.pretty.plaintext

Class PrettyTextWriterFit

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.AbstractOutputFileWriter

org.apache.ctakes.core.cc.pretty.plaintext.PrettyTextWriterFit

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

@PipeBitInfo(name="Pretty Text Writer",
             description="Writes text files with document text and simple markups (POS, Semantic Group, CUI, Negation).",
             role=WRITER,
             dependencies={DOCUMENT_ID,SENTENCE,BASE_TOKEN},
             usables={DOCUMENT_ID_PREFIX,IDENTIFIED_ANNOTATION,EVENT,TIMEX,TEMPORAL_RELATION})
public final class PrettyTextWriterFit
extends AbstractOutputFileWriter

Writes Document text, pos, semantic types and cuis. Each Sentence starts a new series of pretty text lines. This version can be used in the UimaFit style with ConfigurationParameter It cannot be used in the old Uima CPE style (e.g. the Uima CPE Gui) as the Uima CPE has problems with Fit Consumers. There is a version that can be used with the CPE GUI: PrettyTextWriterUima

Since:

7/8/2015

Version:

%I%

Author:

SPF , chip-nlp

See Also:

PrettyTextWriter

Constructor Summary

Constructors

Constructor and Description
PrettyTextWriterFit()

Method Summary

Modifier and Type	Method and Description
void	initialize(org.apache.uima.UimaContext uimaContext)
void	writeFile(org.apache.uima.jcas.JCas jCas, String outputDir, String documentId, String fileName) Write information into a file named based upon the document id and located based upon the document id prefix.

Methods inherited from class org.apache.ctakes.core.cc.AbstractOutputFileWriter

getOutputDirectory, getSourceFileName, getSourceFilePath, getSubdirectory, process

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

Constructor Detail

PrettyTextWriterFit

public PrettyTextWriterFit()

Method Detail

writeFile

public void writeFile(org.apache.uima.jcas.JCas jCas,
                      String outputDir,
                      String documentId,
                      String fileName)
               throws IOException

Write information into a file named based upon the document id and located based upon the document id prefix.

Specified by:

writeFile in class AbstractOutputFileWriter

Parameters:

jCas - ye olde

outputDir - output directory

documentId - some id for the cas document

fileName - name for the output file

Throws:

IOException - if anything goes wrong

initialize

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

Specified by:

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

Overrides:

initialize in class AbstractOutputFileWriter

Throws:

org.apache.uima.resource.ResourceInitializationException