gov.va.vinci.leo.listener

Class BaseCsvListener

java.lang.Object

org.apache.uima.aae.client.UimaAsBaseCallbackListener

gov.va.vinci.leo.listener.BaseListener

gov.va.vinci.leo.listener.BaseCsvListener

All Implemented Interfaces:

org.apache.uima.aae.client.UimaASStatusCallbackListener

Direct Known Subclasses:

SimpleCsvListener

public abstract class BaseCsvListener
extends BaseListener

Base gov.va.vinci.leo.listener for creating CSV output. Implementing classes need to implement getHeaders() and getRows().

If not overridden in the constructors, the default separator is a comma (,), the default quote character is a quote("), the default escape character is a backslash (\), and the default line ending is a newline (\n)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	includeHeader Include a header row at the start of the output file.
protected au.com.bytecode.opencsv.CSVWriter	writer CSVWriter that will format and write the output.
protected CSVWriterBuilder	writerBuilder CSVWriterBuilder used to create the CSVWriter.

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
BaseCsvListener(File file) Constructor with File parameter.
BaseCsvListener(OutputStream stream) Constructor with an OutputStream parameter.
BaseCsvListener(Writer writer) Constructor with a Writer parameter.

Method Summary

Modifier and Type	Method and Description
void	collectionProcessComplete(org.apache.uima.collection.EntityProcessStatus aStatus)
void	entityProcessComplete(org.apache.uima.cas.CAS aCas, org.apache.uima.collection.EntityProcessStatus aStatus) Called with a completely processed CAS.
char	getEscapechar() Get the escape character.
protected abstract String[]	getHeaders() Returns the string list of the headers for a row.
String	getLineEnd() Get the line ending string.
char	getQuotechar() Get the quote character.
protected abstract List<String[]>	getRows(org.apache.uima.cas.CAS cas) Given a cas, return one or more rows of data.
char	getSeparator() Get the separator character.
void	initializationComplete(org.apache.uima.collection.EntityProcessStatus aStatus) Called once client initialization is complete.
boolean	isIncludeHeader() Return the flag value that if true will cause the listener to include a header row, defaults false.
<T extends BaseCsvListener> T	setEscapechar(char escapechar) Set the escape character.
<T extends BaseCsvListener> T	setIncludeHeader(boolean includeHeader) Set the boolean flag that if true will cause the listener to include a header row.
<T extends BaseCsvListener> T	setLineEnd(String lineEnd) Set the line ending.
<T extends BaseCsvListener> T	setQuotechar(char quotechar) Set the quote character.
<T extends BaseCsvListener> T	setSeparator(char separator) Set the separator character.
void	writeHeaders() Write out headers to the writerBuilder for this gov.va.vinci.leo.listener.

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

writerBuilder

protected CSVWriterBuilder writerBuilder

CSVWriterBuilder used to create the CSVWriter.

writer

protected au.com.bytecode.opencsv.CSVWriter writer

CSVWriter that will format and write the output.

includeHeader

protected boolean includeHeader

Include a header row at the start of the output file.

Constructor Detail

BaseCsvListener

public BaseCsvListener(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.

BaseCsvListener

public BaseCsvListener(OutputStream stream)

Constructor with an OutputStream parameter.

Parameters:

stream - The stream to write to.

BaseCsvListener

public BaseCsvListener(Writer writer)

Constructor with a Writer parameter.

Parameters:

writer - The writer to use for output

Method Detail

getRows

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

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

Parameters:

cas - 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 abstract String[] getHeaders()

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

Returns:

the string list of the headers for a row.

getSeparator

public char getSeparator()

Get the separator character.

Returns:

separator character

setSeparator

public <T extends BaseCsvListener> T setSeparator(char separator)

Set the separator character.

Parameters:

separator - separator charactor

Returns:

reference to this listener instance

getQuotechar

public char getQuotechar()

Get the quote character.

Returns:

quote character

setQuotechar

public <T extends BaseCsvListener> T setQuotechar(char quotechar)

Set the quote character.

Parameters:

quotechar - quote character

Returns:

reference to this listener instance

getEscapechar

public char getEscapechar()

Get the escape character.

Returns:

escape character

setEscapechar

public <T extends BaseCsvListener> T setEscapechar(char escapechar)

Set the escape character.

Parameters:

escapechar - escape character

Returns:

reference to this listener instance

getLineEnd

public String getLineEnd()

Get the line ending string.

Returns:

line ending string

setLineEnd

public <T extends BaseCsvListener> T setLineEnd(String lineEnd)

Set the line ending.

Parameters:

lineEnd - line ending

Returns:

reference to this listener instance

isIncludeHeader

public boolean isIncludeHeader()

Return the flag value that if true will cause the listener to include a header row, defaults false.

Returns:

include header boolean

setIncludeHeader

public <T extends BaseCsvListener> T setIncludeHeader(boolean includeHeader)

Set the boolean flag that if true will cause the listener to include a header row.

Parameters:

includeHeader - boolean flag for header row

Returns:

reference to this listener instance

writeHeaders

public void writeHeaders()
                  throws IOException

Write out headers to the writerBuilder for this gov.va.vinci.leo.listener. The idea being this might be called once before the process is started to write out column headers to the csv file.

Throws:

IOException - if the headers cannot be written.

initializationComplete

public void initializationComplete(org.apache.uima.collection.EntityProcessStatus aStatus)

Called once client initialization is complete.

Specified by:

initializationComplete in interface org.apache.uima.aae.client.UimaASStatusCallbackListener

Overrides:

initializationComplete in class BaseListener

Parameters:

aStatus - the status of the processing.

See Also:

UimaAsBaseCallbackListener.initializationComplete(EntityProcessStatus)

entityProcessComplete

public void entityProcessComplete(org.apache.uima.cas.CAS aCas,
                                  org.apache.uima.collection.EntityProcessStatus aStatus)

Called with a completely processed CAS.

Specified by:

entityProcessComplete in interface org.apache.uima.aae.client.UimaASStatusCallbackListener

Overrides:

entityProcessComplete in class BaseListener

Parameters:

aCas - the returned cas.

aStatus - the status of the processing. This object contains a record of any Exception that occurred, as well as timing information.

See Also:

UimaAsBaseCallbackListener.entityProcessComplete(org.apache.uima.cas.CAS, org.apache.uima.collection.EntityProcessStatus)

collectionProcessComplete

public void collectionProcessComplete(org.apache.uima.collection.EntityProcessStatus aStatus)

Specified by:

collectionProcessComplete in interface org.apache.uima.aae.client.UimaASStatusCallbackListener

Overrides:

collectionProcessComplete in class BaseListener

Parameters:

aStatus - the status of the processing. This object contains a record of any Exception that occurred, as well as timing information.

See Also:

UimaAsBaseCallbackListener.collectionProcessComplete(org.apache.uima.collection.EntityProcessStatus)