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, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.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, org.apache.flink.util.OutputTag<T> timedOutPartialMatchesTag)

Method Summary

Modifier and Type	Method and Description
void	close()
void	open(org.apache.flink.configuration.Configuration parameters)
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,
                                   org.apache.flink.util.OutputTag<T> timedOutPartialMatchesTag)

Method Detail

open

public void open(org.apache.flink.configuration.Configuration parameters)
          throws Exception

Specified by:

open in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

open in class PatternSelectAdapter<IN,OUT>

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

close in class PatternSelectAdapter<IN,OUT>

Throws:

Exception

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.