nl.nn.adapterframework.batch

Class StreamTransformerPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.batch.StreamTransformerPipe

All Implemented Interfaces:

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

Direct Known Subclasses:

BatchFileTransformerPipe, BatchTransformerPipeBase

public class StreamTransformerPipe
extends FixedForwardPipe

Pipe for transforming a stream with records. Records in the stream must be separated with new line characters. For file 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.

Since:

4.7

Author:

John Dekker / Gerrit van Brakel

Field Summary

Fields

Modifier and Type	Field and Description
static String	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
StreamTransformerPipe()

Method Summary

Modifier and Type	Method and Description
protected void	closeAllBlocks(PipeLineSession session, String streamId, IResultHandler handler, Map<String,Object> blocks)
void	configure() checks for correct configuration of forward
PipeRunResult	doPipe(Message input, PipeLineSession session) Open a reader for the file named according the input messsage and transform it.
protected InputStream	getInputStream(String streamId, Message input, PipeLineSession session)
IRecordHandlerManager	getManager(String name)
protected BufferedReader	getReader(String streamId, Message input, PipeLineSession session)
IRecordHandler	getRecordHandler(String name)
IResultHandler	getResultHandler(String name)
protected String	getStreamId(Message input, PipeLineSession session)
void	registerChild(IRecordHandler handler) Deprecated. please use registerRecordHandler()
void	registerChild(IRecordHandlerManager manager) Deprecated. please use registerManager
void	registerChild(IResultHandler handler) Deprecated. Please use registerResultHandler()
void	registerChild(RecordHandlingFlow flowEl) Deprecated. please use manager.addFlow()
void	registerManager(IRecordHandlerManager manager) Manager determines which handlers are to be used for the current line.
void	registerRecordHandler(IRecordHandler handler) Handler for transforming records of a specific type
void	registerResultHandler(IResultHandler handler) Handler for processing transformed records
void	setCharset(String string) Characterset used for reading file or inputstream"
void	setCloseInputstreamOnExit(boolean b) If set to false, the inputstream is not closed after it has been used.
void	setReaderFactory(IReaderFactory factory) Factory for the reader.
void	setStoreOriginalBlock(boolean b) If set true the original block is stored under the session key originalBlock.
void	start() Perform necessary action to start the pipe.
void	stop() Perform necessary actions to stop the Pipe. For instance, closing JMS connections, DBMS connections etc.

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

doInitialPipe, getParameterValue, setIfParam, setIfValue, setSkipOnEmptyInput

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

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getLogPrefix, getOutSizeStatDummyObject, getParameterList, 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

Field Detail

originalBlockKey

public static final String originalBlockKey

See Also:

Constant Field Values

Constructor Detail

StreamTransformerPipe

public StreamTransformerPipe()

Method Detail

getStreamId

protected String getStreamId(Message input,
                             PipeLineSession session)

getInputStream

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

Throws:

PipeRunException

getReader

protected BufferedReader getReader(String streamId,
                                   Message input,
                                   PipeLineSession session)
                            throws PipeRunException

Throws:

PipeRunException

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

start

public void start()
           throws PipeStartException

Description copied from interface: IPipe

Perform necessary action to start the pipe. This method is executed after the IPipe.configure() method, for each start and stop command of the adapter.

Specified by:

start in interface IPipe

Overrides:

start in class AbstractPipe

Throws:

PipeStartException

stop

public void stop()

Description copied from interface: IPipe

Perform necessary actions to stop the Pipe.
For instance, closing JMS connections, DBMS connections etc.

Specified by:

stop in interface IPipe

Overrides:

stop in class AbstractPipe

registerChild

@Deprecated
public void registerChild(IRecordHandlerManager manager)
                               throws Exception

Deprecated. please use registerManager

Register a uniquely named manager.

Throws:

Exception

registerManager

public void registerManager(IRecordHandlerManager manager)
                     throws Exception

Manager determines which handlers are to be used for the current line. If no manager is specified, a default manager and flow are created. The default manager always uses the default flow. The default flow always uses the first registered recordHandler (if available) and the first registered resultHandler (if available).

Throws:

Exception

getManager

public IRecordHandlerManager getManager(String name)

registerChild

@Deprecated
public void registerChild(RecordHandlingFlow flowEl)
                               throws Exception

Deprecated. please use manager.addFlow()

Register a flow element that contains the handlers for a specific record type (key)

Throws:

Exception

registerChild

@Deprecated
public void registerChild(IRecordHandler handler)
                               throws Exception

Deprecated. please use registerRecordHandler()

Register a uniquely named record manager.

Throws:

Exception

registerRecordHandler

public void registerRecordHandler(IRecordHandler handler)
                           throws Exception

Handler for transforming records of a specific type

Throws:

Exception

getRecordHandler

public IRecordHandler getRecordHandler(String name)

registerChild

@Deprecated
public void registerChild(IResultHandler handler)
                               throws Exception

Deprecated. Please use registerResultHandler()

Register a uniquely named result manager.

Throws:

Exception

registerResultHandler

public void registerResultHandler(IResultHandler handler)
                           throws Exception

Handler for processing transformed records

Throws:

Exception

getResultHandler

public IResultHandler getResultHandler(String name)

doPipe

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

Open a reader for the file named according the input messsage 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

Specified by:

doPipe in class AbstractPipe

Throws:

PipeRunException

See Also:

IPipe.doPipe(Message, PipeLineSession)

closeAllBlocks

protected void closeAllBlocks(PipeLineSession session,
                              String streamId,
                              IResultHandler handler,
                              Map<String,Object> blocks)
                       throws Exception

Throws:

Exception

setStoreOriginalBlock

public void setStoreOriginalBlock(boolean b)

If set true the original block is stored under the session key originalBlock.

Default value

false

setCloseInputstreamOnExit

public void setCloseInputstreamOnExit(boolean b)

If set to false, the inputstream is not closed after it has been used.

Default value

true

setCharset

public void setCharset(String string)

Characterset used for reading file or inputstream"

Default value

UTF-8

setReaderFactory

public void setReaderFactory(IReaderFactory factory)

Factory for the reader. The default implementation InputStreamReaderFactory converts using the specified character set.