org.apache.flink.cep.functions.adaptors

Class PatternTimeoutSelectAdapter<IN,OUT,T>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.cep.functions.PatternProcessFunction<IN,OUT>

org.apache.flink.cep.functions.adaptors.PatternSelectAdapter<IN,OUT>

org.apache.flink.cep.functions.adaptors.PatternTimeoutSelectAdapter<IN,OUT,T>

All Implemented Interfaces:

Serializable, Function, RichFunction, TimedOutPartialMatchHandler<IN>

@Internal
public class PatternTimeoutSelectAdapter<IN,OUT,T>
extends PatternSelectAdapter<IN,OUT>
implements TimedOutPartialMatchHandler<IN>

Adapter that expresses combination of PatternSelectFunction and PatternTimeoutFlatSelectAdapter with PatternProcessFunction.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.cep.functions.PatternProcessFunction

PatternProcessFunction.Context

Constructor Summary

Constructors

Constructor and Description
PatternTimeoutSelectAdapter(PatternSelectFunction<IN,OUT> selectFunction, PatternTimeoutFunction<IN,T> timeoutFunction, OutputTag<T> timedOutPartialMatchesTag)

Method Summary

Modifier and Type	Method and Description
void	close() Tear-down method for the user code.
void	open(Configuration parameters) Initialization method for the function.
void	processTimedOutMatch(Map<String,List<IN>> match, PatternProcessFunction.Context ctx) Called for every timed out partial match (due to Pattern.within(Time)).

Methods inherited from class org.apache.flink.cep.functions.adaptors.PatternSelectAdapter

processMatch

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternTimeoutSelectAdapter

public PatternTimeoutSelectAdapter(PatternSelectFunction<IN,OUT> selectFunction,
                                   PatternTimeoutFunction<IN,T> timeoutFunction,
                                   OutputTag<T> timedOutPartialMatchesTag)

Method Detail

open

public void open(Configuration parameters)
          throws Exception

Description copied from interface: RichFunction

Initialization method for the function. It is called before the actual working methods (like map or join) and thus suitable for one time setup work. For functions that are part of an iteration, this method will be invoked at the beginning of each iteration superstep.

The configuration object passed to the function can be used for configuration and initialization. The configuration contains all parameters that were configured on the function in the program composition.

 public class MyFilter extends RichFilterFunction<String> {

     private String searchString;

     public void open(Configuration parameters) {
         this.searchString = parameters.getString("foo");
     }

     public boolean filter(String value) {
         return value.equals(searchString);
     }
 }
 

By default, this method does nothing.

Specified by:

open in interface RichFunction

Overrides:

open in class PatternSelectAdapter<IN,OUT>

Parameters:

parameters - The configuration containing the parameters attached to the contract.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

See Also:

Configuration

close

public void close()
           throws Exception

Description copied from interface: RichFunction

Tear-down method for the user code. It is called after the last call to the main working methods (e.g. map or join). For functions that are part of an iteration, this method will be invoked after each iteration superstep.

This method can be used for clean up work.

Specified by:

close in interface RichFunction

Overrides:

close in class PatternSelectAdapter<IN,OUT>

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

processTimedOutMatch

public void processTimedOutMatch(Map<String,List<IN>> match,
                                 PatternProcessFunction.Context ctx)
                          throws Exception

Description copied from interface: TimedOutPartialMatchHandler

Called for every timed out partial match (due to Pattern.within(Time)). It enables custom handling, e.g. one can emit the timed out results through a side output:

{@code
 private final OutputTag timedOutPartialMatchesTag = ...

 private class MyFunction extends PatternProcessFunction implements TimedOutPartialMatchHandler {

Specified by:

processTimedOutMatch in interface TimedOutPartialMatchHandler<IN>

Parameters:

match - map containing the timed out partial match. Events are identified by their names.

ctx - enables access to time features and emitting results through side outputs

Throws:

Exception - This method may throw exceptions. Throwing an exception will cause the operation to fail and may trigger recovery.