Package org.frankframework.pipes

Class CsvParserPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.pipes.CsvParserPipe

All Implemented Interfaces:

HasTransactionAttribute, IConfigurable, IConfigurationAware, IForwardTarget, INamedObject, IPipe, IScopeProvider, IWithParameters, EventThrowing, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@EnterpriseIntegrationPattern(TRANSLATOR)
public class CsvParserPipe
extends FixedForwardPipe

Reads a message in CSV format, and turns it into XML.

Author:

Gerrit van Brakel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CsvParserPipe.HeaderCase

Field Summary

Fields inherited from class org.frankframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class org.frankframework.core.TransactionAttributes

log

Fields inherited from interface org.frankframework.core.IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
CsvParserPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	checks for correct configuration of forward
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
String	getFieldNames()
String	getFieldSeparator()
Boolean	getFileContainsHeader()
CsvParserPipe.HeaderCase	getHeaderCase()
boolean	isPrettyPrint()
void	setFieldNames(String fieldNames)	Comma separated list of header names.
void	setFieldSeparator(String fieldSeparator)	Character that separates fields
void	setFileContainsHeader(Boolean fileContainsHeader)	Specifies if the first line should be treated as header or as data
void	setHeaderCase(CsvParserPipe.HeaderCase headerCase)	When set, character casing will be changed for the header
void	setPrettyPrint(boolean prettyPrint)	Format the XML output in easy legible way
void	setUseControlCodes(boolean useControlCodes)	Enables the ASCII (RS) Record Separator and (US) Unit Separator Control Code field delimiters.

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

getIfParam, getIfValue, getOnlyIfSessionKey, getOnlyIfValue, getParameterValue, getSuccessForward, getUnlessSessionKey, getUnlessValue, isSkipOnEmptyInput, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getApplicationContext, getChompCharSize, getConfigurationClassLoader, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getEventSourceName, getForwards, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getName, getParameterList, getPipeLine, getSecLogSessionKeys, getStoreResultInSessionKey, hasRegisteredForward, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setEventPublisher, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPipeLine, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, getTransactionAttribute, getTransactionTimeout, getTxDef, isTransacted, isTransacted, setTransacted, setTransactionAttribute, setTransactionTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.frankframework.core.IPipe

throwEvent

Constructor Details

CsvParserPipe

public CsvParserPipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

checks for correct configuration of forward

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class FixedForwardPipe

Throws:

ConfigurationException

doPipe

public PipeRunResult doPipe(Message message,
 PipeLineSession session)
                     throws PipeRunException

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.

Throws:

PipeRunException

setFileContainsHeader

public void setFileContainsHeader(Boolean fileContainsHeader)

Specifies if the first line should be treated as header or as data

Default value

true

setFieldNames

public void setFieldNames(String fieldNames)

Comma separated list of header names. If set, then fileContainsHeader defaults to false. If not set, headers are taken from the first line

setFieldSeparator

public void setFieldSeparator(String fieldSeparator)

Character that separates fields

Default value

,

setHeaderCase

public void setHeaderCase(CsvParserPipe.HeaderCase headerCase)

When set, character casing will be changed for the header

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

Format the XML output in easy legible way

setUseControlCodes

public void setUseControlCodes(boolean useControlCodes)

Enables the ASCII (RS) Record Separator and (US) Unit Separator Control Code field delimiters. May not be used in combination with attribute fieldSeparator. See WIKI Control Codes.

getFileContainsHeader

public Boolean getFileContainsHeader()

getFieldNames

public String getFieldNames()

getFieldSeparator

public String getFieldSeparator()

getHeaderCase

public CsvParserPipe.HeaderCase getHeaderCase()

isPrettyPrint

public boolean isPrettyPrint()