Package org.apache.flink.cep.functions.adaptors

Class PatternTimeoutFlatSelectAdapter<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.PatternFlatSelectAdapter<IN,OUT>

org.apache.flink.cep.functions.adaptors.PatternTimeoutFlatSelectAdapter<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 PatternTimeoutFlatSelectAdapter<IN,OUT,T>
extends PatternFlatSelectAdapter<IN,OUT>
implements TimedOutPartialMatchHandler<IN>

Adapter that expresses combination of PatternFlatSelectFunction 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	Description
PatternTimeoutFlatSelectAdapter(PatternFlatSelectFunction<IN,OUT> flatSelectFunction, PatternFlatTimeoutFunction<IN,T> flatTimeoutFunction, org.apache.flink.util.OutputTag<T> timedOutPartialMatchesTag)

Method Summary

Modifier and Type	Method	Description
void	close()
void	open(org.apache.flink.api.common.functions.OpenContext openContext)
void	processTimedOutMatch(Map<String,List<IN>> match, PatternProcessFunction.Context ctx)	Called for every timed out partial match (due to Pattern.within(Duration)).

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

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 Details

PatternTimeoutFlatSelectAdapter

public PatternTimeoutFlatSelectAdapter(PatternFlatSelectFunction<IN,OUT> flatSelectFunction,
 PatternFlatTimeoutFunction<IN,T> flatTimeoutFunction,
 org.apache.flink.util.OutputTag<T> timedOutPartialMatchesTag)

Method Details

open

public void open(org.apache.flink.api.common.functions.OpenContext openContext)
          throws Exception

Specified by:

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

Overrides:

open in class PatternFlatSelectAdapter<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 PatternFlatSelectAdapter<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(Duration)). It enables custom handling, e.g. one can emit the timed out results through a side output:

 private final OutputTag<T> timedOutPartialMatchesTag = ...

 private class MyFunction extends PatternProcessFunction<IN, OUT> implements TimedOutPartialMatchHandler<IN> {

     @Override
     public void processMatch(Map<String, List<IN>> match, Context ctx, Collector<OUT> out) throws Exception {
          ...
     }

     @Override
     void processTimedOutMatch(Map<String, List<IN>> match, PatternProcessFunction.Context ctx) throws Exception {
          ctx.output(timedOutPartialMatchesTag, match);
     }
 }
 

TimeContext.timestamp() in this case returns the minimal time in which we can say that the partial match will not become a match, which is effectively the timestamp of the first element assigned to the partial match plus the value of within.

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.