Package org.apache.flink.table.runtime.operators.rank

Class RetractableTopNFunction

java.lang.Object

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

org.apache.flink.streaming.api.functions.KeyedProcessFunction<RowData,RowData,RowData>

org.apache.flink.table.runtime.operators.rank.AbstractTopNFunction

org.apache.flink.table.runtime.operators.rank.RetractableTopNFunction

All Implemented Interfaces:

Serializable, Function, RichFunction

public class RetractableTopNFunction
extends AbstractTopNFunction

A TopN function could handle updating stream.

Input stream can contain any change kind: INSERT, DELETE, UPDATE_BEFORE and UPDATE_AFTER.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.streaming.api.functions.KeyedProcessFunction

KeyedProcessFunction.Context, KeyedProcessFunction.OnTimerContext

Field Summary

Fields inherited from class org.apache.flink.table.runtime.operators.rank.AbstractTopNFunction

hitCount, inputRowType, keyContext, outputRankNumber, rankEnd, requestCount, sortKeyComparator, sortKeySelector, ttlConfig

Constructor Summary

Constructors

Constructor	Description
RetractableTopNFunction(StateTtlConfig ttlConfig, InternalTypeInfo<RowData> inputRowType, ComparableRecordComparator comparableRecordComparator, RowDataKeySelector sortKeySelector, RankType rankType, RankRange rankRange, GeneratedRecordEqualiser generatedEqualiser, boolean generateUpdateBefore, boolean outputRankNumber)

Method Summary

Modifier and Type	Method	Description
void	open(OpenContext openContext)	Initialization method for the function.
void	processElement(RowData input, KeyedProcessFunction.Context ctx, Collector<RowData> out)	Process one element from the input stream.

Methods inherited from class org.apache.flink.table.runtime.operators.rank.AbstractTopNFunction

checkSortKeyInBufferRange, collectDelete, collectDelete, collectInsert, collectInsert, collectUpdateAfter, collectUpdateAfter, collectUpdateBefore, collectUpdateBefore, getDefaultTopNSize, hasOffset, initRankEnd, isInRankEnd, isInRankRange, registerMetric, setKeyContext

Methods inherited from class org.apache.flink.streaming.api.functions.KeyedProcessFunction

onTimer

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

close, getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

RetractableTopNFunction

public RetractableTopNFunction(StateTtlConfig ttlConfig,
                               InternalTypeInfo<RowData> inputRowType,
                               ComparableRecordComparator comparableRecordComparator,
                               RowDataKeySelector sortKeySelector,
                               RankType rankType,
                               RankRange rankRange,
                               GeneratedRecordEqualiser generatedEqualiser,
                               boolean generateUpdateBefore,
                               boolean outputRankNumber)

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

Specified by:

open in interface RichFunction

Overrides:

open in class AbstractTopNFunction

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.

processElement

public void processElement(RowData input,
                           KeyedProcessFunction.Context ctx,
                           Collector<RowData> out)
                    throws Exception

Description copied from class: KeyedProcessFunction

Process one element from the input stream.

This function can output zero or more elements using the Collector parameter and also update internal state or set timers using the KeyedProcessFunction.Context parameter.

Specified by:

processElement in class KeyedProcessFunction<RowData,RowData,RowData>

Parameters:

input - The input value.

ctx - A KeyedProcessFunction.Context that allows querying the timestamp of the element and getting a TimerService for registering timers and querying the time. The context is only valid during the invocation of this method, do not store it.

out - The collector for returning result values.

Throws:

Exception - This method may throw exceptions. Throwing an exception will cause the operation to fail and may trigger recovery.