Package org.frankframework.pipes

Class CompareIntegerPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.CompareIntegerPipe

All Implemented Interfaces:

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

@Category("Basic")
@ElementType(ROUTER)
public class CompareIntegerPipe
extends AbstractPipe

Pipe that compares the two integer values. If one of the parameters is missing then the input message will be used as the missing operand. This pipe can be used in combination with IncreaseIntegerPipe to construct loops.

Author:

Richard Punt / Gerrit van Brakel

Specific parameters

operand1 The first operand, holds v1., operand2 The second operand, holds v2.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	OPERAND1
protected static final String	OPERAND2

Fields inherited from class org.frankframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class org.frankframework.core.TransactionAttributes

log

Fields inherited from interface org.frankframework.core.IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
CompareIntegerPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	configure() is called after the Pipeline is registered at the Adapter.
boolean	consumesSessionVariable(String sessionKey)	returns true if the pipe or one of its children use the named session variable.
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.

Methods inherited from class org.frankframework.pipes.AbstractPipe

addParameter, createBean, findForward, getAdapter, getApplicationContext, getChompCharSize, getConfigurationClassLoader, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getEventSourceName, getForwards, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getName, getParameterList, getPipeLine, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setEventPublisher, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPipeLine, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent

Methods inherited from class org.frankframework.core.TransactionAttributes

configureTransactionAttributes, getTransactionAttribute, getTransactionTimeout, getTxDef, isTransacted, isTransacted, setTransacted, setTransactionAttribute, setTransactionTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.frankframework.core.IPipe

throwEvent

Field Details

OPERAND1

protected static final String OPERAND1

See Also:

• Constant Field Values

OPERAND2

protected static final String OPERAND2

See Also:

• Constant Field Values

Constructor Details

CompareIntegerPipe

public CompareIntegerPipe()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from class: AbstractPipe

configure() is called after the Pipeline is registered at the Adapter. Purpose of this method is to reduce creating connections to databases etc. in the doPipe() method. As much as possible class-instantiating should take place in the configure() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class AbstractPipe

Throws:

ConfigurationException

doPipe

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

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.

Throws:

PipeRunException

consumesSessionVariable

public boolean consumesSessionVariable(String sessionKey)

Description copied from interface: IPipe

returns true if the pipe or one of its children use the named session variable. Callers can use this to determine if a message needs to be preserved.

Specified by:

consumesSessionVariable in interface IPipe

Overrides:

consumesSessionVariable in class AbstractPipe