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

Class AbstractTopNFunction

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<RowData,RowData,RowData>

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

All Implemented Interfaces:

Serializable, Function, RichFunction, CleanupState

Direct Known Subclasses:

AppendOnlyTopNFunction, RetractableTopNFunction, UpdatableTopNFunction

public abstract class AbstractTopNFunction
extends KeyedProcessFunctionWithCleanupState<RowData,RowData,RowData>

Base class for TopN Function.

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

Modifier and Type	Field and Description
protected long	hitCount
protected RowDataTypeInfo	inputRowType
protected KeyContext	keyContext
protected boolean	outputRankNumber
protected long	rankEnd
protected long	requestCount
protected Comparator<RowData>	sortKeyComparator
protected KeySelector<RowData,RowData>	sortKeySelector

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

stateCleaningEnabled

Method Summary

Modifier and Type	Method and Description
protected boolean	checkSortKeyInBufferRange(RowData sortKey, org.apache.flink.table.runtime.operators.rank.TopNBuffer buffer) Checks whether the record should be put into the buffer.
protected void	collectDelete(Collector<RowData> out, RowData inputRow)
protected void	collectDelete(Collector<RowData> out, RowData inputRow, long rank)
protected void	collectInsert(Collector<RowData> out, RowData inputRow)
protected void	collectInsert(Collector<RowData> out, RowData inputRow, long rank)
protected void	collectUpdateAfter(Collector<RowData> out, RowData inputRow)
protected void	collectUpdateAfter(Collector<RowData> out, RowData inputRow, long rank)
protected void	collectUpdateBefore(Collector<RowData> out, RowData inputRow)
protected void	collectUpdateBefore(Collector<RowData> out, RowData inputRow, long rank)
protected long	getDefaultTopNSize() Gets default topN size.
protected boolean	hasOffset()
protected long	initRankEnd(RowData row) Initialize rank end.
protected boolean	isInRankEnd(long rank)
protected boolean	isInRankRange(long rank)
void	open(Configuration parameters) Initialization method for the function.
protected void	registerMetric(long heapSize)
void	setKeyContext(KeyContext keyContext) Sets keyContext to RankFunction.

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

cleanupState, initCleanupTimeState, isProcessingTimeTimer, needToCleanupState, registerProcessingCleanupTimer

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

onTimer, processElement

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

Field Detail

sortKeyComparator

protected Comparator<RowData> sortKeyComparator

outputRankNumber

protected final boolean outputRankNumber

inputRowType

protected final RowDataTypeInfo inputRowType

sortKeySelector

protected final KeySelector<RowData,RowData> sortKeySelector

keyContext

protected KeyContext keyContext

rankEnd

protected long rankEnd

hitCount

protected long hitCount

requestCount

protected long requestCount

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 AbstractRichFunction

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

getDefaultTopNSize

protected long getDefaultTopNSize()

Gets default topN size.

Returns:

default topN size

initRankEnd

protected long initRankEnd(RowData row)
                    throws Exception

Initialize rank end.

Parameters:

row - input record

Returns:

rank end

Throws:

Exception

checkSortKeyInBufferRange

protected boolean checkSortKeyInBufferRange(RowData sortKey,
                                            org.apache.flink.table.runtime.operators.rank.TopNBuffer buffer)

Checks whether the record should be put into the buffer.

Parameters:

sortKey - sortKey to test

buffer - buffer to add

Returns:

true if the record should be put into the buffer.

registerMetric

protected void registerMetric(long heapSize)

collectInsert

protected void collectInsert(Collector<RowData> out,
                             RowData inputRow,
                             long rank)

collectInsert

protected void collectInsert(Collector<RowData> out,
                             RowData inputRow)

collectDelete

protected void collectDelete(Collector<RowData> out,
                             RowData inputRow,
                             long rank)

collectDelete

protected void collectDelete(Collector<RowData> out,
                             RowData inputRow)

collectUpdateAfter

protected void collectUpdateAfter(Collector<RowData> out,
                                  RowData inputRow,
                                  long rank)

collectUpdateAfter

protected void collectUpdateAfter(Collector<RowData> out,
                                  RowData inputRow)

collectUpdateBefore

protected void collectUpdateBefore(Collector<RowData> out,
                                   RowData inputRow,
                                   long rank)

collectUpdateBefore

protected void collectUpdateBefore(Collector<RowData> out,
                                   RowData inputRow)

isInRankEnd

protected boolean isInRankEnd(long rank)

isInRankRange

protected boolean isInRankRange(long rank)

hasOffset

protected boolean hasOffset()

setKeyContext

public void setKeyContext(KeyContext keyContext)

Sets keyContext to RankFunction.

Parameters:

keyContext - keyContext of current function.