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

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

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, CleanupState

Direct Known Subclasses:

AppendOnlyTopNFunction, RetractableTopNFunction, UpdatableTopNFunction

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

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

org.apache.flink.streaming.api.functions.KeyedProcessFunction.Context, org.apache.flink.streaming.api.functions.KeyedProcessFunction.OnTimerContext

Field Summary

Fields

Modifier and Type	Field and Description
protected long	hitCount
protected BaseRowTypeInfo	inputRowType
protected org.apache.flink.streaming.api.operators.KeyContext	keyContext
protected boolean	outputRankNumber
protected long	rankEnd
protected long	requestCount
protected Comparator<BaseRow>	sortKeyComparator
protected org.apache.flink.api.java.functions.KeySelector<BaseRow,BaseRow>	sortKeySelector

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

stateCleaningEnabled

Method Summary

Modifier and Type	Method and Description
protected boolean	checkSortKeyInBufferRange(BaseRow sortKey, org.apache.flink.table.runtime.operators.rank.TopNBuffer buffer) Checks whether the record should be put into the buffer.
protected void	collect(org.apache.flink.util.Collector<BaseRow> out, BaseRow inputRow)
protected void	collect(org.apache.flink.util.Collector<BaseRow> out, BaseRow inputRow, long rank)
protected void	delete(org.apache.flink.util.Collector<BaseRow> out, BaseRow inputRow) This is similar to [[retract()]] but always send retraction message regardless of generateRetraction is true or not.
protected void	delete(org.apache.flink.util.Collector<BaseRow> out, BaseRow inputRow, long rank) This is with-row-number version of above delete() method.
protected long	getDefaultTopNSize() Gets default topN size.
protected boolean	hasOffset()
protected long	initRankEnd(BaseRow row) Initialize rank end.
protected boolean	isInRankEnd(long rank)
protected boolean	isInRankRange(long rank)
void	open(org.apache.flink.configuration.Configuration parameters)
protected void	registerMetric(long heapSize)
protected void	retract(org.apache.flink.util.Collector<BaseRow> out, BaseRow inputRow, long rank)
void	setKeyContext(org.apache.flink.streaming.api.operators.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<BaseRow> sortKeyComparator

outputRankNumber

protected final boolean outputRankNumber

inputRowType

protected final BaseRowTypeInfo inputRowType

sortKeySelector

protected final org.apache.flink.api.java.functions.KeySelector<BaseRow,BaseRow> sortKeySelector

keyContext

protected org.apache.flink.streaming.api.operators.KeyContext keyContext

rankEnd

protected long rankEnd

hitCount

protected long hitCount

requestCount

protected long requestCount

Method Detail

open

public void open(org.apache.flink.configuration.Configuration parameters)
          throws Exception

Specified by:

open in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

open in class org.apache.flink.api.common.functions.AbstractRichFunction

Throws:

Exception

getDefaultTopNSize

protected long getDefaultTopNSize()

Gets default topN size.

Returns:

default topN size

initRankEnd

protected long initRankEnd(BaseRow row)
                    throws Exception

Initialize rank end.

Parameters:

row - input record

Returns:

rank end

Throws:

Exception

checkSortKeyInBufferRange

protected boolean checkSortKeyInBufferRange(BaseRow 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)

collect

protected void collect(org.apache.flink.util.Collector<BaseRow> out,
                       BaseRow inputRow)

delete

protected void delete(org.apache.flink.util.Collector<BaseRow> out,
                      BaseRow inputRow)

This is similar to [[retract()]] but always send retraction message regardless of generateRetraction is true or not.

delete

protected void delete(org.apache.flink.util.Collector<BaseRow> out,
                      BaseRow inputRow,
                      long rank)

This is with-row-number version of above delete() method.

collect

protected void collect(org.apache.flink.util.Collector<BaseRow> out,
                       BaseRow inputRow,
                       long rank)

retract

protected void retract(org.apache.flink.util.Collector<BaseRow> out,
                       BaseRow inputRow,
                       long rank)

isInRankEnd

protected boolean isInRankEnd(long rank)

isInRankRange

protected boolean isInRankRange(long rank)

hasOffset

protected boolean hasOffset()

setKeyContext

public void setKeyContext(org.apache.flink.streaming.api.operators.KeyContext keyContext)

Sets keyContext to RankFunction.

Parameters:

keyContext - keyContext of current function.