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:

FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

@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.
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 a 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 an easily legible way.
void	setTrimWhitespace(boolean trimWhitespace)	When set to true, whitespace is trimmed from the beginning and end of each header and field value.
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

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, 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.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.IPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, 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

Overrides:

configure in class FixedForwardPipe

Throws:

ConfigurationException - in case it was not able to configure the component.

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.

Throws:

PipeRunException

setFileContainsHeader

public void setFileContainsHeader(Boolean fileContainsHeader)

Specifies if the first line should be treated as a 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 an easily legible way.

setUseControlCodes

public void setUseControlCodes(boolean useControlCodes)

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

setTrimWhitespace

public void setTrimWhitespace(boolean trimWhitespace)

When set to true, whitespace is trimmed from the beginning and end of each header and field value.

Default value

false