public abstract class AbstractResultHandler extends Object implements IResultHandler, IWithParameters
Modifier and Type | Field and Description |
---|---|
protected org.apache.logging.log4j.Logger |
log |
protected ParameterList |
paramList |
Constructor and Description |
---|
AbstractResultHandler() |
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 flow s 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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
closeBlock, closeRecordType, finalizeResult, handleResult, isBlockByRecordType, openBlock, openRecordType
getName
getApplicationContext, getName
getConfigurationClassLoader
protected org.apache.logging.log4j.Logger log
protected ParameterList paramList
public void configure() throws ConfigurationException
configure
in interface IConfigurable
ConfigurationException
public void open() throws SenderException
open
in interface IResultHandler
SenderException
public void close() throws SenderException
close
in interface IResultHandler
SenderException
public void openDocument(PipeLineSession session, String streamId) throws Exception
IResultHandler
openDocument
in interface IResultHandler
session
- current PipeLineSessionstreamId
- identification of the original file/stream/messageException
public void closeDocument(PipeLineSession session, String streamId)
closeDocument
in interface IResultHandler
public void addParameter(Parameter p)
addParameter
in interface IWithParameters
public ParameterList getParameterList()
getParameterList
in interface IWithParameters
public void setPipe(AbstractPipe pipe)
setPipe
in interface IResultHandler
public void setName(String string)
INamedObject
setName
in interface INamedObject
@Deprecated public void setPrefix(String string)
public boolean hasPrefix()
hasPrefix
in interface IResultHandler
@Deprecated public void setSuffix(String string)
public void setDefault(boolean isDefault)
true
, this resulthandler is the default for all flow
s that do not have a handler specifiedsetDefault
in interface IResultHandler
public boolean isDefault()
isDefault
in interface IResultHandler
public void setBlockByRecordType(boolean b)
true
(default), every group of records, as indicated by RecordHandler.newRecordType
is handled as a block.Copyright © 2023 Frank!Framework. All rights reserved.