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

类 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<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData>

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

所有已实现的接口:

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

直接已知子类:

AppendOnlyTopNFunction, RetractableTopNFunction, UpdatableTopNFunction

public abstract class AbstractTopNFunction
extends KeyedProcessFunctionWithCleanupState<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData>

Base class for TopN Function.

另请参阅:

序列化表格

嵌套类概要

从类继承的嵌套类/接口 org.apache.flink.streaming.api.functions.KeyedProcessFunction

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

字段概要

字段

限定符和类型	字段和说明
protected long	hitCount
protected RowDataTypeInfo	inputRowType
protected org.apache.flink.streaming.api.operators.KeyContext	keyContext
protected boolean	outputRankNumber
protected long	rankEnd
protected long	requestCount
protected Comparator<org.apache.flink.table.data.RowData>	sortKeyComparator
protected org.apache.flink.api.java.functions.KeySelector<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData>	sortKeySelector

从类继承的字段 org.apache.flink.table.runtime.functions.KeyedProcessFunctionWithCleanupState

stateCleaningEnabled

方法概要

限定符和类型	方法和说明
protected boolean	checkSortKeyInBufferRange(org.apache.flink.table.data.RowData sortKey, org.apache.flink.table.runtime.operators.rank.TopNBuffer buffer) Checks whether the record should be put into the buffer.
protected void	collectDelete(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out, org.apache.flink.table.data.RowData inputRow)
protected void	collectDelete(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out, org.apache.flink.table.data.RowData inputRow, long rank)
protected void	collectInsert(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out, org.apache.flink.table.data.RowData inputRow)
protected void	collectInsert(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out, org.apache.flink.table.data.RowData inputRow, long rank)
protected void	collectUpdateAfter(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out, org.apache.flink.table.data.RowData inputRow)
protected void	collectUpdateAfter(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out, org.apache.flink.table.data.RowData inputRow, long rank)
protected void	collectUpdateBefore(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out, org.apache.flink.table.data.RowData inputRow)
protected void	collectUpdateBefore(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out, org.apache.flink.table.data.RowData inputRow, long rank)
protected long	getDefaultTopNSize() Gets default topN size.
protected boolean	hasOffset()
protected long	initRankEnd(org.apache.flink.table.data.RowData 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)
void	setKeyContext(org.apache.flink.streaming.api.operators.KeyContext keyContext) Sets keyContext to RankFunction.

从类继承的方法 org.apache.flink.table.runtime.functions.KeyedProcessFunctionWithCleanupState

cleanupState, initCleanupTimeState, isProcessingTimeTimer, needToCleanupState, registerProcessingCleanupTimer

从类继承的方法 org.apache.flink.streaming.api.functions.KeyedProcessFunction

onTimer, processElement

从类继承的方法 org.apache.flink.api.common.functions.AbstractRichFunction

close, getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.flink.table.runtime.functions.CleanupState

registerProcessingCleanupTimer

字段详细资料

sortKeyComparator

protected Comparator<org.apache.flink.table.data.RowData> sortKeyComparator

outputRankNumber

protected final boolean outputRankNumber

inputRowType

protected final RowDataTypeInfo inputRowType

sortKeySelector

protected final org.apache.flink.api.java.functions.KeySelector<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData> sortKeySelector

keyContext

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

rankEnd

protected long rankEnd

hitCount

protected long hitCount

requestCount

protected long requestCount

方法详细资料

open

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

指定者:

open 在接口中 org.apache.flink.api.common.functions.RichFunction

覆盖:

open 在类中 org.apache.flink.api.common.functions.AbstractRichFunction

抛出:

Exception

getDefaultTopNSize

protected long getDefaultTopNSize()

Gets default topN size.

返回:

default topN size

initRankEnd

protected long initRankEnd(org.apache.flink.table.data.RowData row)
                    throws Exception

Initialize rank end.

参数:

row - input record

返回:

rank end

抛出:

Exception

checkSortKeyInBufferRange

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

Checks whether the record should be put into the buffer.

参数:

sortKey - sortKey to test

buffer - buffer to add

返回:

true if the record should be put into the buffer.

registerMetric

protected void registerMetric(long heapSize)

collectInsert

protected void collectInsert(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out,
                             org.apache.flink.table.data.RowData inputRow,
                             long rank)

collectInsert

protected void collectInsert(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out,
                             org.apache.flink.table.data.RowData inputRow)

collectDelete

protected void collectDelete(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out,
                             org.apache.flink.table.data.RowData inputRow,
                             long rank)

collectDelete

protected void collectDelete(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out,
                             org.apache.flink.table.data.RowData inputRow)

collectUpdateAfter

protected void collectUpdateAfter(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out,
                                  org.apache.flink.table.data.RowData inputRow,
                                  long rank)

collectUpdateAfter

protected void collectUpdateAfter(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out,
                                  org.apache.flink.table.data.RowData inputRow)

collectUpdateBefore

protected void collectUpdateBefore(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out,
                                   org.apache.flink.table.data.RowData inputRow,
                                   long rank)

collectUpdateBefore

protected void collectUpdateBefore(org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> out,
                                   org.apache.flink.table.data.RowData inputRow)

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.

参数:

keyContext - keyContext of current function.