org.apache.ctakes.core.cc

Class AbstractOutputFileWriter

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

All Implemented Interfaces:

org.apache.uima.analysis_component.AnalysisComponent

Direct Known Subclasses:

FileTreeXmiWriter, PrettyTextWriterFit

public abstract class AbstractOutputFileWriter
extends org.apache.uima.fit.component.CasConsumer_ImplBase

Since:

9/16/2016

Version:

%I%

Author:

SPF , chip-nlp

Constructor Summary

Constructors

Constructor and Description
AbstractOutputFileWriter()

Method Summary

Modifier and Type	Method and Description
protected String	getOutputDirectory(org.apache.uima.jcas.JCas jcas, String rootPath, String documentId)
protected String	getSourceFileName(org.apache.uima.jcas.JCas jcas, String documentId)
protected String	getSourceFilePath(org.apache.uima.jcas.JCas jCas)
protected String	getSubdirectory(org.apache.uima.jcas.JCas jCas, String documentId)
void	initialize(org.apache.uima.UimaContext context)
void	process(org.apache.uima.cas.CAS cas)
abstract 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.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

AbstractOutputFileWriter

public AbstractOutputFileWriter()

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

writeFile

public abstract 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.

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

getOutputDirectory

protected String getOutputDirectory(org.apache.uima.jcas.JCas jcas,
                                    String rootPath,
                                    String documentId)

Parameters:

jcas - ye olde

rootPath - the root path for all output subdirectories and files

documentId - some id for the cas document

Returns:

the full output path up to but not including the fileName

getSubdirectory

protected String getSubdirectory(org.apache.uima.jcas.JCas jCas,
                                 String documentId)

Parameters:

jCas - ye olde

documentId - some id for the cas document

Returns:

a subdirectory based upon the DocumentIdPrefix stored in the cas, or none if none

getSourceFilePath

protected String getSourceFilePath(org.apache.uima.jcas.JCas jCas)

Parameters:

jCas - ye olde

Returns:

the full path to the file containing the processed text, or an empty string ("") if unknown

getSourceFileName

protected String getSourceFileName(org.apache.uima.jcas.JCas jcas,
                                   String documentId)

Parameters:

jcas - ye olde

documentId - some id for the cas document

Returns:

a filename based upon the documentId