nl.nn.adapterframework.pipes

Class CompareStringPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.CompareStringPipe

All Implemented Interfaces:

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

@Category(value="Basic")
 @ElementType(value=ROUTER)
public class CompareStringPipe
extends AbstractPipe

Pipe that compares lexicographically two strings.

Author:

Peter Leeuwenburgh

Specific parameters

operand1 The first operand, holds v1. Defaults to input message, operand2 The second operand, holds v2. Defaults to input message, ignorepatterns (optional) contains a xml table with references to substrings which have to be ignored during the comparison. This xml table has the following layout:

        <ignores>
                <ignore>
                        <after>...</after>
                        <before>...</before>
                </ignore>
                <ignore>
                        <after>...</after>
                        <before>...</before>
                </ignore>
        </ignores>
 

Substrings between "after" and "before" are ignored

Field Summary

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
CompareStringPipe()

Method Summary

Modifier and Type	Method and 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.
String	getSessionKey1()
String	getSessionKey2()
boolean	isXml()
void	setSessionKey1(String string) Deprecated.
void	setSessionKey2(String string) Deprecated.
void	setXml(boolean b) when set true the string values to compare are considered to be xml strings and before the actual compare both xml strings are transformed to a canonical form

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

addParameter, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, start, stop, throwEvent

Methods inherited from class nl.nn.adapterframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

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.core.IExtendedPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine

Methods inherited from interface nl.nn.adapterframework.core.IPipe

getMaxThreads

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 nl.nn.adapterframework.core.IForwardTarget

getName

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

CompareStringPipe

public CompareStringPipe()

Method Detail

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 class: AbstractPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object.

Specified by:

doPipe in interface IPipe

Specified by:

doPipe in class AbstractPipe

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

setSessionKey1

@Deprecated
 @ConfigurationWarning(value="Please use the parameter operand1")
public void setSessionKey1(String string)

Deprecated.

reference to one of the session variables to be compared. Do not use, but use Parameter operand1 instead

getSessionKey1

public String getSessionKey1()

setSessionKey2

@Deprecated
 @ConfigurationWarning(value="Please use the parameter operand2")
public void setSessionKey2(String string)

Deprecated.

reference to the other session variables to be compared. Do not use, but use Parameter operand2 instead

getSessionKey2

public String getSessionKey2()

isXml

public boolean isXml()

setXml

public void setXml(boolean b)

when set true the string values to compare are considered to be xml strings and before the actual compare both xml strings are transformed to a canonical form

Default value

false