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

Class AppendOnlyTopNFunction

java.lang.Object

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

org.apache.flink.streaming.api.functions.KeyedProcessFunction<K,IN,OUT>

org.apache.flink.table.runtime.functions.KeyedProcessFunctionWithCleanupState<BaseRow,BaseRow,BaseRow>

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

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

All Implemented Interfaces:

Serializable, Function, RichFunction, CleanupState

public class AppendOnlyTopNFunction
extends AbstractTopNFunction

The function could and only could handle append input stream.

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

Fields inherited from class org.apache.flink.table.runtime.functions.KeyedProcessFunctionWithCleanupState

stateCleaningEnabled

Constructor Summary

Constructors

Constructor and Description
AppendOnlyTopNFunction(long minRetentionTime, long maxRetentionTime, BaseRowTypeInfo inputRowType, GeneratedRecordComparator sortKeyGeneratedRecordComparator, BaseRowKeySelector sortKeySelector, RankType rankType, RankRange rankRange, boolean generateRetraction, boolean outputRankNumber, long cacheSize)

Method Summary

Modifier and Type	Method and Description
void	onTimer(long timestamp, KeyedProcessFunction.OnTimerContext ctx, Collector<BaseRow> out) Called when a timer set using TimerService fires.
void	open(Configuration parameters) Initialization method for the function.
void	processElement(BaseRow input, KeyedProcessFunction.Context context, Collector<BaseRow> out) Process one element from the input stream.

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

checkSortKeyInBufferRange, collect, collect, delete, delete, getDefaultTopNSize, hasOffset, initRankEnd, isInRankEnd, isInRankRange, registerMetric, retract, setKeyContext

Methods inherited from class org.apache.flink.table.runtime.functions.KeyedProcessFunctionWithCleanupState

cleanupState, initCleanupTimeState, isProcessingTimeTimer, needToCleanupState, registerProcessingCleanupTimer

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

Methods inherited from interface org.apache.flink.table.runtime.functions.CleanupState

registerProcessingCleanupTimer

Constructor Detail

AppendOnlyTopNFunction

public AppendOnlyTopNFunction(long minRetentionTime,
                              long maxRetentionTime,
                              BaseRowTypeInfo inputRowType,
                              GeneratedRecordComparator sortKeyGeneratedRecordComparator,
                              BaseRowKeySelector sortKeySelector,
                              RankType rankType,
                              RankRange rankRange,
                              boolean generateRetraction,
                              boolean outputRankNumber,
                              long cacheSize)

Method Detail

open

public void open(Configuration parameters)
          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 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.

Specified by:

open in interface RichFunction

Overrides:

open in class AbstractTopNFunction

Parameters:

parameters - The configuration containing the parameters attached to the contract.

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.

See Also:

Configuration

processElement

public void processElement(BaseRow input,
                           KeyedProcessFunction.Context context,
                           Collector<BaseRow> 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<BaseRow,BaseRow,BaseRow>

Parameters:

input - The input value.

context - 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.

onTimer

public void onTimer(long timestamp,
                    KeyedProcessFunction.OnTimerContext ctx,
                    Collector<BaseRow> out)
             throws Exception

Description copied from class: KeyedProcessFunction

Called when a timer set using TimerService fires.

Overrides:

onTimer in class KeyedProcessFunction<BaseRow,BaseRow,BaseRow>

Parameters:

timestamp - The timestamp of the firing timer.

ctx - An KeyedProcessFunction.OnTimerContext that allows querying the timestamp, the TimeDomain, and the key of the firing timer 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.