org.apache.flink.api.java.operators.translation

Class WrappingFunction<T extends Function>

java.lang.Object

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

org.apache.flink.api.java.operators.translation.WrappingFunction<T>

Type Parameters:

T -

All Implemented Interfaces:

Serializable, Function, RichFunction

Direct Known Subclasses:

AggregateApplyAllWindowFunction, AggregateApplyWindowFunction, InternalAggregateProcessAllWindowFunction, InternalAggregateProcessWindowFunction, InternalIterableAllWindowFunction, InternalIterableProcessAllWindowFunction, InternalIterableProcessWindowFunction, InternalIterableWindowFunction, InternalSingleValueAllWindowFunction, InternalSingleValueProcessAllWindowFunction, InternalSingleValueProcessWindowFunction, InternalSingleValueWindowFunction, JoinConditionWithNullFilters, JoinOperator.DefaultJoin.WrappingFlatJoinFunction, PlanFilterOperator.FlatMapFilter, ReduceApplyAllWindowFunction, ReduceApplyWindowFunction, TupleLeftUnwrappingJoiner, TupleRightUnwrappingJoiner, TupleUnwrappingJoiner

@Internal
public abstract class WrappingFunction<T extends Function>
extends AbstractRichFunction

Wrapper around Function.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected T	wrappedFunction

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WrappingFunction(T wrappedFunction)

Method Summary

Modifier and Type	Method and Description
void	close() Tear-down method for the user code.
T	getWrappedFunction()
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.api.common.functions.AbstractRichFunction

getIterationRuntimeContext, getRuntimeContext, open

Methods inherited from class java.lang.Object

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

Field Detail

wrappedFunction

protected T extends Function wrappedFunction

Constructor Detail

WrappingFunction

protected WrappingFunction(T wrappedFunction)

Method Detail

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);
     }
 }
 

By default, this method does nothing.

1. If you implement open(OpenContext openContext), the open(OpenContext openContext) will be invoked and the open(Configuration parameters) won't be invoked. 2. If you don't implement open(OpenContext openContext), the open(Configuration parameters) will be invoked in the default implementation of the open(OpenContext openContext).

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 AbstractRichFunction

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.

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 AbstractRichFunction

Parameters:

t - The runtime context.

getWrappedFunction

public T getWrappedFunction()