Package org.frankframework.batch

Interface IResultHandler

All Superinterfaces:

org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.Aware, FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, NameAware

All Known Implementing Classes:

AbstractResultHandler, Result2BlobWriter, Result2ClobWriter, Result2Filewriter, Result2LobWriterBase, Result2StringWriter, ResultBlock2Sender, ResultWriter

@FrankDocGroup(BATCH)
public interface IResultHandler
extends IConfigurable, FrankElement, NameAware

Interface for handling a transformed record.

Author:

John Dekker

Method Summary

Modifier and Type	Method	Description
void	close()
void	closeBlock(PipeLineSession session, String streamId, String blockName, Map<String,Object> blocks)
void	closeDocument(PipeLineSession session, String streamId)
void	closeRecordType(PipeLineSession session, String streamId)
String	finalizeResult(PipeLineSession session, String streamId, boolean error)	Called when all records in the original file are handled.
void	handleResult(PipeLineSession session, String streamId, String recordKey, String result)	write a result record.
boolean	hasPrefix()
boolean	isBlockByRecordType()
boolean	isDefault()
void	open()
void	openBlock(PipeLineSession session, String streamId, String blockName, Map<String,Object> blocks)
void	openDocument(PipeLineSession session, String streamId)	Called once, before the first record of a stream is presented to handleResult.
void	openRecordType(PipeLineSession session, String streamId)
void	setDefault(boolean isDefault)
void	setPipe(AbstractPipe pipe)

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

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.IConfigurable

configure

Methods inherited from interface org.frankframework.core.NameAware

setName

Method Details

setPipe

void setPipe(AbstractPipe pipe)

open

void open()
   throws SenderException

Throws:

SenderException

close

void close()
    throws SenderException

Throws:

SenderException

openDocument

void openDocument(PipeLineSession session,
 String streamId)
           throws Exception

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

Parameters:

session - current PipeLineSession

streamId - identification of the original file/stream/message

Throws:

Exception

closeDocument

void closeDocument(PipeLineSession session,
 String streamId)

handleResult

void handleResult(PipeLineSession session,
 String streamId,
 String recordKey,
 String result)
           throws Exception

write a result record.

Parameters:

session - current PipeLineSession

streamId - identification of the original file/stream/message containing the untransformed records

recordKey - key of the record (describes the record type)

result - transformed record

Throws:

Exception

finalizeResult

String finalizeResult(PipeLineSession session,
 String streamId,
 boolean error)
               throws Exception

Called when all records in the original file are handled.

Parameters:

session - current PipeLineSession

streamId - identification of the original file/stream/message containing the untransformed records

Returns:

the name or names of the output files

Throws:

Exception

openRecordType

void openRecordType(PipeLineSession session,
 String streamId)
             throws Exception

Parameters:

session - current PipeLineSession

streamId - identification of the original file/stream/message containing the untransformed records

Throws:

Exception

closeRecordType

void closeRecordType(PipeLineSession session,
 String streamId)
              throws Exception

Parameters:

session - current PipeLineSession

streamId - identification of the original file/stream/message containing the untransformed records

Throws:

Exception

openBlock

void openBlock(PipeLineSession session,
 String streamId,
 String blockName,
 Map<String,Object> blocks)
        throws Exception

Throws:

Exception

closeBlock

void closeBlock(PipeLineSession session,
 String streamId,
 String blockName,
 Map<String,Object> blocks)
         throws Exception

Throws:

Exception

isDefault

boolean isDefault()

Returns:

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

setDefault

void setDefault(boolean isDefault)

hasPrefix

boolean hasPrefix()

isBlockByRecordType

boolean isBlockByRecordType()

Returns:

true causes groups of identical records, indicated by newRecordType to appear in a block.