nl.nn.adapterframework.batch

Class AbstractResultHandler

java.lang.Object

nl.nn.adapterframework.batch.AbstractResultHandler

All Implemented Interfaces:

IResultHandler, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, IWithParameters, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

ResultWriter

public abstract class AbstractResultHandler
extends Object
implements IResultHandler, IWithParameters

Abstract class for resulthandlers (handler that handles the transformed record).

Author:

John Dekker

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AbstractResultHandler()

Method Summary

Modifier and Type	Method and Description
void	addParameter(Parameter p)
void	close()
void	closeDocument(PipeLineSession session, String streamId)
void	configure()
ParameterList	getParameterList()
boolean	hasPrefix()
boolean	isDefault()
void	open()
void	openDocument(PipeLineSession session, String streamId) Called once, before the first record of a stream is presented to handleResult.
void	setBlockByRecordType(boolean b) When set true(default), every group of records, as indicated by RecordHandler.newRecordType is handled as a block.
void	setDefault(boolean isDefault) if set true, this resulthandler is the default for all flows that do not have a handler specified
void	setName(String string) The functional name of the object.
void	setPipe(AbstractPipe pipe)
void	setPrefix(String string) Deprecated.
void	setSuffix(String string) Deprecated.

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.batch.IResultHandler

closeBlock, closeRecordType, finalizeResult, handleResult, isBlockByRecordType, openBlock, openRecordType

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 org.springframework.context.ApplicationContextAware

setApplicationContext

Field Detail

log

protected org.apache.logging.log4j.Logger log

paramList

protected ParameterList paramList

Constructor Detail

AbstractResultHandler

public AbstractResultHandler()

Method Detail

configure

public void configure()
               throws ConfigurationException

Specified by:

configure in interface IConfigurable

Throws:

ConfigurationException

open

public void open()
          throws SenderException

Specified by:

open in interface IResultHandler

Throws:

SenderException

close

public void close()
           throws SenderException

Specified by:

close in interface IResultHandler

Throws:

SenderException

openDocument

public void openDocument(PipeLineSession session,
                         String streamId)
                  throws Exception

Description copied from interface: IResultHandler

Called once, before the first record of a stream is presented to handleResult.

Specified by:

openDocument in interface IResultHandler

Parameters:

session - current PipeLineSession

streamId - identification of the original file/stream/message

Throws:

Exception

closeDocument

public void closeDocument(PipeLineSession session,
                          String streamId)

Specified by:

closeDocument in interface IResultHandler

addParameter

public void addParameter(Parameter p)

Specified by:

addParameter in interface IWithParameters

getParameterList

public ParameterList getParameterList()

Specified by:

getParameterList in interface IWithParameters

setPipe

public void setPipe(AbstractPipe pipe)

Specified by:

setPipe in interface IResultHandler

setName

public void setName(String string)

Description copied from interface: INamedObject

The functional name of the object.

Specified by:

setName in interface INamedObject

setPrefix

@Deprecated
public void setPrefix(String string)

Deprecated.

Prefix that has to be written before each record, if the record is in another block than the previous record

hasPrefix

public boolean hasPrefix()

Specified by:

hasPrefix in interface IResultHandler

setSuffix

@Deprecated
public void setSuffix(String string)

Deprecated.

deprecated suffix that has to be written after the record, if the record is in another block than the next record.
n.b. if a suffix is set without a prefix, it is only used at the end of processing (i.e. at the end of the file) as a final close

setDefault

public void setDefault(boolean isDefault)

if set true, this resulthandler is the default for all flows that do not have a handler specified

Specified by:

setDefault in interface IResultHandler

Default value

false

isDefault

public boolean isDefault()

Specified by:

isDefault in interface IResultHandler

Returns:

true if this resulthandler should be used for all flows if no resulthandler is specified for that flow

setBlockByRecordType

public void setBlockByRecordType(boolean b)

When set true(default), every group of records, as indicated by RecordHandler.newRecordType is handled as a block.

Default value

true