Package org.frankframework.pipes

Class RegExPipe

java.lang.Object
org.frankframework.core.TransactionAttributes
org.frankframework.pipes.AbstractPipe
org.frankframework.pipes.RegExPipe
All Implemented Interfaces:
FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle
@Forward(name="then",description="When a match is found.") @Forward(name="else",description="When no match is found.") @EnterpriseIntegrationPattern(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>

  • Field Details

  • 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. The purpose of this method is to reduce creating connections to databases, etc. in the doPipe() method. As much as possible, class instantiation should take place in the configure() method to improve performance.
      Specified by:
      configure in interface IConfigurable
      Overrides:
      configure in class AbstractPipe
      Throws:
      ConfigurationException - in case it was not able to configure the component.

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