gov.va.vinci.leo.listener

Class SimpleCsvListener

java.lang.Object

org.apache.uima.aae.client.UimaAsBaseCallbackListener

gov.va.vinci.leo.listener.BaseListener

gov.va.vinci.leo.listener.BaseCsvListener

gov.va.vinci.leo.listener.SimpleCsvListener

All Implemented Interfaces:

org.apache.uima.aae.client.UimaASStatusCallbackListener

public class SimpleCsvListener
extends BaseCsvListener

Note: This is a very simple gov.va.vinci.leo.listener to output one type of annotation and, optionally, its features. It DOES NOT work well with features of Array type. If you need to output features of Array type, this code simply calls toStringArray on the ArrayFS, and outputs those values.

Author:

vhaislcornir

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	includeFeatures Include features on the annotations or not.

Fields inherited from class gov.va.vinci.leo.listener.BaseCsvListener

includeHeader, writer, writerBuilder

Fields inherited from class gov.va.vinci.leo.listener.BaseListener

annotationTypeFilter, docInfo, exitOnError, inputType, lastException, logErrors, mOutputDir, numReceived, numSent, previousReferenceId, referenceID

Constructor Summary

Constructors

Constructor and Description
SimpleCsvListener(File file) Constructor with File parameter.
SimpleCsvListener(OutputStream stream) Constructor with an OutputStream parameter.
SimpleCsvListener(Writer writer) Constructor with a Writer parameter.

Method Summary

Modifier and Type	Method and Description
protected String[]	getHeaders() Returns the string list of the headers for a row.
protected List<String[]>	getRows(org.apache.uima.cas.CAS aCas) Given a cas, return one or more rows of data.
boolean	isIncludeFeatures() Get the includeFeatures flag value, if true then include feature values in the output.
<T extends SimpleCsvListener> T	setIncludeFeatures(boolean includeFeatures) Set the includeFeatures flag value, if true then include feature values in the output.

Methods inherited from class gov.va.vinci.leo.listener.BaseCsvListener

collectionProcessComplete, entityProcessComplete, getEscapechar, getLineEnd, getQuotechar, getSeparator, initializationComplete, isIncludeHeader, setEscapechar, setIncludeHeader, setLineEnd, setQuotechar, setSeparator, writeHeaders

Methods inherited from class gov.va.vinci.leo.listener.BaseListener

checkForError, entityProcessError, getAnnotationTypeFilter, getInputType, getInputTypesList, getNumReceived, getNumSent, getOutputDir, getReferenceLocation, hasAnnotationsToProcess, hasFilteredAnnotation, isExitOnError, isLogErrors, onBeforeMessageSend, setAnnotationTypeFilter, setExitOnError, setInputType, setLogErrors, setOutputDir

Methods inherited from class org.apache.uima.aae.client.UimaAsBaseCallbackListener

onBeforeProcessCAS, onBeforeProcessMeta, onUimaAsServiceExit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

includeFeatures

protected boolean includeFeatures

Include features on the annotations or not.

Constructor Detail

SimpleCsvListener

public SimpleCsvListener(File file)
                  throws FileNotFoundException

Constructor with File parameter.

Parameters:

file - The printwriter to write to.

Throws:

FileNotFoundException - if the file is not found or can't be written to.

SimpleCsvListener

public SimpleCsvListener(OutputStream stream)

Constructor with an OutputStream parameter.

Parameters:

stream - The stream to write to.

SimpleCsvListener

public SimpleCsvListener(Writer writer)

Constructor with a Writer parameter.

Parameters:

writer - The writerBuilder to use for output

Method Detail

isIncludeFeatures

public boolean isIncludeFeatures()

Get the includeFeatures flag value, if true then include feature values in the output.

Returns:

includeFeatures flag value

setIncludeFeatures

public <T extends SimpleCsvListener> T setIncludeFeatures(boolean includeFeatures)

Set the includeFeatures flag value, if true then include feature values in the output.

Parameters:

includeFeatures - if true include annotation features in output

Returns:

reference to this listener instance

getRows

protected List<String[]> getRows(org.apache.uima.cas.CAS aCas)

Description copied from class: BaseCsvListener

Given a cas, return one or more rows of data.

Specified by:

getRows in class BaseCsvListener

Parameters:

aCas - the document cas to get results from

Returns:

A list of rows of CSV data. Each row is an array of strings. If no data needs to be written for this CAS, you should return an empty list.

getHeaders

protected String[] getHeaders()

Description copied from class: BaseCsvListener

Returns the string list of the headers for a row. ie ("col1", "id", "myValue");

Specified by:

getHeaders in class BaseCsvListener

Returns:

the string list of the headers for a row.