org.apache.ctakes.core.cc

Class TextSpanWriter

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

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

@PipeBitInfo(name="Text Span Writer",
             description="Writes BSV files with original text for extracted annotations and their span offsets.",
             role=WRITER,
             dependencies=IDENTIFIED_ANNOTATION)
public class TextSpanWriter
extends org.apache.uima.fit.component.CasConsumer_ImplBase

Since:

9/28/2015

Version:

%I%

Author:

SPF , chip-nlp

Constructor Summary

Constructors

Constructor and Description
TextSpanWriter()

Method Summary

Modifier and Type	Method and Description
void	initialize(org.apache.uima.UimaContext uimaContext)
void	process(org.apache.uima.cas.CAS aCAS)
void	process(org.apache.uima.jcas.JCas jcas) Process the jcas and write pretty sentences to file.
void	setOutputDirectory(String outputDirectoryPath)
static void	writeAnnotation(org.apache.uima.cas.text.AnnotationFS annotation, Writer writer) Write a sentence from the document text

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

TextSpanWriter

public TextSpanWriter()

Method Detail

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

Specified by:

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

Throws:

org.apache.uima.analysis_engine.AnalysisEngineProcessException

setOutputDirectory

public void setOutputDirectory(String outputDirectoryPath)
                        throws IllegalArgumentException,
                               SecurityException

Parameters:

outputDirectoryPath - may be empty or null, in which case the current working directory is used

Throws:

IllegalArgumentException - if the provided path points to a File and not a Directory

SecurityException - if the File System has issues

process

public void process(org.apache.uima.jcas.JCas jcas)

Process the jcas and write pretty sentences to file. Filename is based upon the document id stored in the cas

Parameters:

jcas - ye olde ...

writeAnnotation

public static void writeAnnotation(org.apache.uima.cas.text.AnnotationFS annotation,
                                   Writer writer)
                            throws IOException

Write a sentence from the document text

Parameters:

annotation - annotation containing the sentence

writer - writer to which pretty text for the sentence should be written

Throws:

IOException - if the writer has issues