nl.nn.adapterframework.batch

Class RecordHandlingFlow

java.lang.Object

nl.nn.adapterframework.batch.RecordHandlingFlow

@FrankDocGroup(name="Batch")
public final class RecordHandlingFlow
extends Object

The flow contains the handlers to handle records of a specific type. Each flow is registered to a manager using the recordHandlerManagerRef.

Author:

John Dekker

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.logging.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
RecordHandlingFlow()

Method Summary

Modifier and Type	Method and Description
void	configure(IRecordHandlerManager manager, Map<String,IRecordHandlerManager> registeredManagers, Map<String,IRecordHandler> registeredRecordHandlers, Map<String,IResultHandler> registeredResultHandlers, IResultHandler defaultHandler)
void	setAutoCloseBlock(boolean b) If true, any open block of this type (and other nested open 'autoClose' block) is closed before a new one of the same type is opened.
void	setCloseBlockAfterLine(String blockName) Instructs the resultHandler to end the specified block after the parsed line is processed
void	setCloseBlockBeforeLine(String blockName) Instructs the resultHandler to end the specified block before the parsed line is processed
void	setNextRecordHandlerManager(IRecordHandlerManager manager)
void	setNextRecordHandlerManagerRef(String nextRecordHandlerManagerName) Name of the manager to be used after handling this record
void	setOpenBlockAfterLine(String blockName) Instructs the resultHandler to start a new block after the parsed line is processed
void	setOpenBlockBeforeLine(String blockName) Instructs the resultHandler to start a new block before the parsed line is processed
void	setOpenBlockBeforeLineNumber(int i) If >0 the openBlockBeforeLine instruction is only performed when the current line number is a multiple of this value
void	setRecordHandler(IRecordHandler handler)
void	setRecordHandlerManagerRef(String recordHandlerManagerName) Name of the manager to which this flow must be added
void	setRecordHandlerRef(String recordHandlerName) Name of the recordHandler to be used to transform records of the type specified in the key (optional)
void	setRecordKey(String recordKey) Key under which this flow is registered in the manager
void	setResultHandler(IResultHandler handler)
void	setResultHandlerRef(String resultHandlerName) Name of the resultHandler to be used to handle the transformed result

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.logging.log4j.Logger log

Constructor Detail

RecordHandlingFlow

public RecordHandlingFlow()

Method Detail

configure

public void configure(IRecordHandlerManager manager,
                      Map<String,IRecordHandlerManager> registeredManagers,
                      Map<String,IRecordHandler> registeredRecordHandlers,
                      Map<String,IResultHandler> registeredResultHandlers,
                      IResultHandler defaultHandler)
               throws ConfigurationException

Throws:

ConfigurationException

setRecordHandler

public void setRecordHandler(IRecordHandler handler)

setResultHandler

public void setResultHandler(IResultHandler handler)

setNextRecordHandlerManager

public void setNextRecordHandlerManager(IRecordHandlerManager manager)

setRecordKey

public void setRecordKey(String recordKey)

Key under which this flow is registered in the manager

setNextRecordHandlerManagerRef

public void setNextRecordHandlerManagerRef(String nextRecordHandlerManagerName)

Name of the manager to be used after handling this record

setRecordHandlerRef

public void setRecordHandlerRef(String recordHandlerName)

Name of the recordHandler to be used to transform records of the type specified in the key (optional)

setRecordHandlerManagerRef

public void setRecordHandlerManagerRef(String recordHandlerManagerName)

Name of the manager to which this flow must be added

setResultHandlerRef

public void setResultHandlerRef(String resultHandlerName)

Name of the resultHandler to be used to handle the transformed result

setOpenBlockBeforeLine

public void setOpenBlockBeforeLine(String blockName)

Instructs the resultHandler to start a new block before the parsed line is processed

setCloseBlockBeforeLine

public void setCloseBlockBeforeLine(String blockName)

Instructs the resultHandler to end the specified block before the parsed line is processed

setOpenBlockAfterLine

public void setOpenBlockAfterLine(String blockName)

Instructs the resultHandler to start a new block after the parsed line is processed

setCloseBlockAfterLine

public void setCloseBlockAfterLine(String blockName)

Instructs the resultHandler to end the specified block after the parsed line is processed

setAutoCloseBlock

public void setAutoCloseBlock(boolean b)

If true, any open block of this type (and other nested open 'autoClose' block) is closed before a new one of the same type is opened. At a forced close, nested blocks are closed too (since 4.9)

Default value

true

setOpenBlockBeforeLineNumber

public void setOpenBlockBeforeLineNumber(int i)

If >0 the openBlockBeforeLine instruction is only performed when the current line number is a multiple of this value

Default value

0