T
- @Internal public abstract class WrappingFunction<T extends Function> extends AbstractRichFunction
Function
.Modifier and Type | Field and Description |
---|---|
protected T |
wrappedFunction |
Modifier | Constructor and Description |
---|---|
protected |
WrappingFunction(T wrappedFunction) |
Modifier and Type | Method and Description |
---|---|
void |
close()
Tear-down method for the user code.
|
T |
getWrappedFunction() |
void |
open(Configuration parameters)
Initialization method for the function.
|
void |
setRuntimeContext(RuntimeContext t)
Sets the function's runtime context.
|
getIterationRuntimeContext, getRuntimeContext
protected WrappingFunction(T wrappedFunction)
public void open(Configuration parameters) throws Exception
RichFunction
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.
open
in interface RichFunction
open
in class AbstractRichFunction
parameters
- The configuration containing the parameters attached to the contract.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.Configuration
public void close() throws Exception
RichFunction
This method can be used for clean up work.
close
in interface RichFunction
close
in class AbstractRichFunction
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.public void setRuntimeContext(RuntimeContext t)
RichFunction
setRuntimeContext
in interface RichFunction
setRuntimeContext
in class AbstractRichFunction
t
- The runtime context.public T getWrappedFunction()
Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.