nl.nn.adapterframework.batch

Class BatchFileTransformerPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.batch.StreamTransformerPipe

nl.nn.adapterframework.batch.BatchFileTransformerPipe

All Implemented Interfaces:

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

public class BatchFileTransformerPipe
extends StreamTransformerPipe

Pipe for transforming a (batch)file with records. Records in the file must be separated with new line characters. You can use the <child> tag to register RecordHandlers, RecordHandlerManagers, ResultHandlers and RecordHandlingFlow elements. This is deprecated, however. Since 4.7 one should use <manager>, <recordHandler>, <resultHandler> and <flow> For files containing only a single type of lines, a simpler configuration without managers and flows can be specified. A single recordHandler with key="*" and (optional) a single resultHandler need to be specified. Each line will be handled by this recordHandler and resultHandler.

Author:

John Dekker

Field Summary

Fields inherited from class nl.nn.adapterframework.batch.StreamTransformerPipe

originalBlockKey

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
BatchFileTransformerPipe()

Method Summary

Modifier and Type	Method and Description
PipeRunResult	doPipe(Message input, PipeLineSession session) Open a reader for the file named according the input message and transform it.
protected InputStream	getInputStream(String streamId, Message input, PipeLineSession session)
protected String	getStreamId(Message input, PipeLineSession session)
void	setDelete(boolean b) If set true, the file processed will deleted after being processed, and not stored
void	setMove2dirAfterError(String errorDir) Directory to which the inputfile is moved in case an error occurs
void	setMove2dirAfterTransform(String readyDir) Directory in which the transformed file(s) is stored
void	setNumberOfBackups(int i) Number of copies held of a file with the same name.
void	setOverwrite(boolean b) If set true, the destination file will be deleted if it already exists

Methods inherited from class nl.nn.adapterframework.batch.StreamTransformerPipe

closeAllBlocks, configure, getManager, getReader, getRecordHandler, getResultHandler, registerChild, registerChild, registerChild, registerChild, registerManager, registerRecordHandler, registerResultHandler, setCharset, setCloseInputstreamOnExit, setReaderFactory, setStoreOriginalBlock, start, stop

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

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

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, throwEvent

Methods inherited from class nl.nn.adapterframework.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 nl.nn.adapterframework.core.IExtendedPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine

Methods inherited from interface nl.nn.adapterframework.core.IPipe

getMaxThreads

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface nl.nn.adapterframework.core.IForwardTarget

getName

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

BatchFileTransformerPipe

public BatchFileTransformerPipe()

Method Detail

getStreamId

protected String getStreamId(Message input,
                             PipeLineSession session)

Overrides:

getStreamId in class StreamTransformerPipe

getInputStream

protected InputStream getInputStream(String streamId,
                                     Message input,
                                     PipeLineSession session)
                              throws PipeRunException

Overrides:

getInputStream in class StreamTransformerPipe

Throws:

PipeRunException

doPipe

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

Open a reader for the file named according the input message and transform it. Move the input file to a done directory when transformation is finished and return the names of the generated files.

Specified by:

doPipe in interface IPipe

Overrides:

doPipe in class StreamTransformerPipe

Throws:

PipeRunException

See Also:

IPipe.doPipe(Message, PipeLineSession)

setMove2dirAfterTransform

public void setMove2dirAfterTransform(String readyDir)

Directory in which the transformed file(s) is stored

setMove2dirAfterError

public void setMove2dirAfterError(String errorDir)

Directory to which the inputfile is moved in case an error occurs

setNumberOfBackups

public void setNumberOfBackups(int i)

Number of copies held of a file with the same name. Backup files have a dot and a number suffixed to their name. If set to 0, no backups will be kept.

Default value

5

setOverwrite

public void setOverwrite(boolean b)

If set true, the destination file will be deleted if it already exists

Default value

false

setDelete

public void setDelete(boolean b)

If set true, the file processed will deleted after being processed, and not stored

Default value

false