Package org.frankframework.pipes

Class RegExPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.RegExPipe

All Implemented Interfaces:

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

@Forward(name="then",description="When a match is found.") @Forward(name="else",description="When no match is found.")
@ElementType(ROUTER)
public class RegExPipe
extends AbstractPipe

Tries to match the input against the provided regex.

 	<RegExPipe name="regExPipe" regex="^(.*?)(name!)$" flags="CASE_INSENSITIVE">
 		<Forward name="then" path="EXIT" />
 		<Forward name="else" path="EXIT" />
 	</RegExPipe>
 

Input:

 	Hello name!
 

Output:

  <matches>
 		<match index="1" value="Hello name!">
 			<group index="1">Hello </group>
 			<group index="2">name!</group>
 		</match>
  </matches>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RegExPipe.RegExFlag

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ELSE_FORWARD
protected static final String	THEN_FORWARD

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
RegExPipe()

Method Summary

Modifier and Type	Method	Description
void	configure()	configure() is called after the Pipeline is registered at the Adapter.
PipeRunResult	doPipe(Message message, PipeLineSession session)	This is where the action takes place.
void	setFlags(RegExPipe.RegExFlag... flags)	Comma seperated list of flags, which changes the behavior of the regex expression.
void	setRegex(String regex)	The regex expression to match against the input.

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getApplicationContext, getChompCharSize, getConfigurationClassLoader, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getEventSourceName, getForwards, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getName, getParameterList, getPipeLine, getSecLogSessionKeys, getStoreResultInSessionKey, hasRegisteredForward, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, registerEvent, 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

THEN_FORWARD

protected static final String THEN_FORWARD

See Also:

• Constant Field Values

ELSE_FORWARD

protected static final String ELSE_FORWARD

See Also:

• Constant Field Values

Constructor Details

RegExPipe

public RegExPipe()

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

setRegex

@Mandatory
public void setRegex(String regex)

The regex expression to match against the input.

setFlags

public void setFlags(RegExPipe.RegExFlag... flags)

Comma seperated list of flags, which changes the behavior of the regex expression.