org.kurator.validation.actors.mapstream

Class WorkspaceCsvFileWriter

java.lang.Object

akka.actor.UntypedActor

org.kurator.akka.KuratorActor

org.kurator.validation.actors.mapstream.WorkspaceCsvFileWriter

All Implemented Interfaces:

akka.actor.Actor

public class WorkspaceCsvFileWriter
extends org.kurator.akka.KuratorActor

A workspace aware CSV file writer. Takes the file name/path below the workspace as a parameter and can extract workspace name/path from a dictionary message.

Author:

mole

Nested Class Summary

Nested classes/interfaces inherited from interface akka.actor.Actor

akka.actor.Actor.emptyBehavior$, akka.actor.Actor.ignoringBehavior$

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.csv.CSVPrinter	csvPrinter
protected Writer	outputWriter

Fields inherited from class org.kurator.akka.KuratorActor

configuration, endOnEos, EOL, errStream, id, inputs, inStream, logger, name, needsTrigger, outStream, sendEosOnEnd, settings, state, workflowRef

Constructor Summary

Constructors

Constructor and Description
WorkspaceCsvFileWriter()

Method Summary

Modifier and Type	Method and Description
char	getFieldDelimiter()
String	getFilePath()
String[]	getHeaders()
Writer	getOutputWriter()
char	getQuoteCharacter()
String	getRecordSeparator()
boolean	isQuoteAllValues()
boolean	isQuoteValuesContainingDelimiter()
boolean	isShowHeader()
boolean	isTrimValues()
void	onData(Object data)
void	onEnd()
protected void	onEndOfStream(org.kurator.akka.messages.EndOfStream eos) Implementation of onEndOfStream that waits for all input streams to send end of stream messages before triggering end of stream and stop.
void	onStart()
void	setFieldDelimiter(char fieldDelimiter)
void	setFilePath(String filePath)
void	setHeaders(String[] headers)
void	setNumberOfInputs(int numberOfInputs)
void	setOutputWriter(Writer outputWriter)
void	setQuoteAllValues(boolean quoteAllValues)
void	setQuoteCharacter(char quoteCharacter)
void	setQuoteValuesContainingDelimiter(boolean quoteValuesContainingDelimiter)
void	setRecordSeparator(String recordSeparator)
void	setShowHeader(boolean showHeader)
void	setTrimValues(boolean trimValues)

Methods inherited from class org.kurator.akka.KuratorActor

broadcast, configuration, endStreamAndStop, endStreamAndStop, errorStream, getReceivedWrappedMessage, inputs, inputStream, listeners, logger, metadataReaders, metadataWriters, onFutureComplete, onInitialize, onReceive, onTrigger, outputStream, publishArtifact, publishArtifact, publishArtifacts, publishProduct, publishProduct, publishProducts, reportException, runner, setNeedsTrigger, settings

Methods inherited from class akka.actor.UntypedActor

akka$actor$Actor$_setter_$context_$eq, akka$actor$Actor$_setter_$self_$eq, aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, getContext, getSelf, getSender, postRestart, postStop, preRestart, preStart, receive, self, sender, supervisorStrategy, unhandled

Methods inherited from class java.lang.Object

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

Field Detail

outputWriter

protected Writer outputWriter

csvPrinter

protected org.apache.commons.csv.CSVPrinter csvPrinter

Constructor Detail

WorkspaceCsvFileWriter

public WorkspaceCsvFileWriter()

Method Detail

setNumberOfInputs

public void setNumberOfInputs(int numberOfInputs)

getOutputWriter

public Writer getOutputWriter()

Returns:

the outputWriter

setOutputWriter

public void setOutputWriter(Writer outputWriter)

Parameters:

outputWriter - the outputWriter to set

getFilePath

public String getFilePath()

Returns:

the filePath

setFilePath

public void setFilePath(String filePath)

Parameters:

filePath - the filePath to set

isQuoteValuesContainingDelimiter

public boolean isQuoteValuesContainingDelimiter()

Returns:

the quoteValuesContainingDelimiter

setQuoteValuesContainingDelimiter

public void setQuoteValuesContainingDelimiter(boolean quoteValuesContainingDelimiter)

Parameters:

quoteValuesContainingDelimiter - the quoteValuesContainingDelimiter to set

isQuoteAllValues

public boolean isQuoteAllValues()

Returns:

the quoteAllValues

setQuoteAllValues

public void setQuoteAllValues(boolean quoteAllValues)

Parameters:

quoteAllValues - the quoteAllValues to set

getRecordSeparator

public String getRecordSeparator()

Returns:

the recordSeparator

setRecordSeparator

public void setRecordSeparator(String recordSeparator)

Parameters:

recordSeparator - the recordSeparator to set

isTrimValues

public boolean isTrimValues()

Returns:

the trimValues

setTrimValues

public void setTrimValues(boolean trimValues)

Parameters:

trimValues - the trimValues to set

isShowHeader

public boolean isShowHeader()

Returns:

the showHeader

setShowHeader

public void setShowHeader(boolean showHeader)

Parameters:

showHeader - the showHeader to set

getQuoteCharacter

public char getQuoteCharacter()

Returns:

the quoteCharacter

setQuoteCharacter

public void setQuoteCharacter(char quoteCharacter)

Parameters:

quoteCharacter - the quoteCharacter to set

getFieldDelimiter

public char getFieldDelimiter()

Returns:

the fieldDelimiter

setFieldDelimiter

public void setFieldDelimiter(char fieldDelimiter)

Parameters:

fieldDelimiter - the fieldDelimiter to set

getHeaders

public String[] getHeaders()

Returns:

the headers

setHeaders

public void setHeaders(String[] headers)

Parameters:

headers - the headers to set

onStart

public void onStart()
             throws Exception

Overrides:

onStart in class org.kurator.akka.KuratorActor

Throws:

Exception

onData

public void onData(Object data)
            throws Exception

Overrides:

onData in class org.kurator.akka.KuratorActor

Throws:

Exception

onEndOfStream

protected void onEndOfStream(org.kurator.akka.messages.EndOfStream eos)
                      throws Exception

Implementation of onEndOfStream that waits for all input streams to send end of stream messages before triggering end of stream and stop. Assumes message delivery model of at most once.

Overrides:

onEndOfStream in class org.kurator.akka.KuratorActor

Parameters:

eos - end of stream signal.

Throws:

Exception

onEnd

public void onEnd()
           throws Exception

Overrides:

onEnd in class org.kurator.akka.KuratorActor

Throws:

Exception