Package org.apache.flink.cep.pattern.conditions

Class RichCompositeIterativeCondition<T>

java.lang.Object

org.apache.flink.cep.pattern.conditions.IterativeCondition<T>

org.apache.flink.cep.pattern.conditions.RichIterativeCondition<T>

org.apache.flink.cep.pattern.conditions.RichCompositeIterativeCondition<T>

Type Parameters:

T - Type of the element to filter

All Implemented Interfaces:

Serializable, Function, RichFunction

Direct Known Subclasses:

RichAndCondition, RichNotCondition, RichOrCondition

public abstract class RichCompositeIterativeCondition<T>
extends RichIterativeCondition<T>

A base class of composite IterativeCondition conditions such as RichAndCondition, RichOrCondition and RichNotCondition, etc. It handles the open, close and setRuntimeContext for the nested IterativeCondition conditions.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.cep.pattern.conditions.IterativeCondition

IterativeCondition.Context<T>

Constructor Summary

Constructors

Constructor	Description
RichCompositeIterativeCondition(IterativeCondition<T>... nestedConditions)

Method Summary

Modifier and Type	Method	Description
void	close()	Tear-down method for the user code.
IterativeCondition<T>[]	getNestedConditions()
void	open(OpenContext openContext)	Initialization method for the function.
void	setRuntimeContext(RuntimeContext t)	Sets the function's runtime context.

Methods inherited from class org.apache.flink.cep.pattern.conditions.RichIterativeCondition

getIterationRuntimeContext, getRuntimeContext

Methods inherited from class org.apache.flink.cep.pattern.conditions.IterativeCondition

filter

Methods inherited from class java.lang.Object

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

Constructor Detail

RichCompositeIterativeCondition

@SafeVarargs
public RichCompositeIterativeCondition(IterativeCondition<T>... nestedConditions)

Method Detail

getNestedConditions

public IterativeCondition<T>[] getNestedConditions()

setRuntimeContext

public void setRuntimeContext(RuntimeContext t)

Description copied from interface: RichFunction

Sets the function's runtime context. Called by the framework when creating a parallel instance of the function.

Specified by:

setRuntimeContext in interface RichFunction

Overrides:

setRuntimeContext in class RichIterativeCondition<T>

Parameters:

t - The runtime context.

open

public void open(OpenContext openContext)
          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 openContext object passed to the function can be used for configuration and initialization. The openContext contains some necessary information that were configured on the function in the program composition.

 public class MyFilter extends RichFilterFunction<String> {

     private String searchString;

     public void open(OpenContext openContext) {
         // initialize the value of searchString
     }

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

Specified by:

open in interface RichFunction

Overrides:

open in class RichIterativeCondition<T>

Parameters:

openContext - The context containing information about the context in which the function is opened.

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.

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 RichIterativeCondition<T>

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.