org.apache.flink.table.planner.functions.aggfunctions

Class AvgAggFunction

java.lang.Object

org.apache.flink.table.functions.UserDefinedFunction

org.apache.flink.table.planner.functions.aggfunctions.DeclarativeAggregateFunction

org.apache.flink.table.planner.functions.aggfunctions.AvgAggFunction

All Implemented Interfaces:

Serializable, org.apache.flink.table.functions.FunctionDefinition

Direct Known Subclasses:

AvgAggFunction.ByteAvgAggFunction, AvgAggFunction.DecimalAvgAggFunction, AvgAggFunction.DoubleAvgAggFunction, AvgAggFunction.FloatAvgAggFunction, AvgAggFunction.IntAvgAggFunction, AvgAggFunction.LongAvgAggFunction, AvgAggFunction.ShortAvgAggFunction

public abstract class AvgAggFunction
extends DeclarativeAggregateFunction

built-in avg aggregate function.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AvgAggFunction.ByteAvgAggFunction Built-in Byte Avg aggregate function.
static class	AvgAggFunction.DecimalAvgAggFunction Built-in Decimal Avg aggregate function.
static class	AvgAggFunction.DoubleAvgAggFunction Built-in Double Avg aggregate function.
static class	AvgAggFunction.FloatAvgAggFunction Built-in Float Avg aggregate function.
static class	AvgAggFunction.IntAvgAggFunction Built-in Integer Avg aggregate function.
static class	AvgAggFunction.LongAvgAggFunction Built-in Long Avg aggregate function.
static class	AvgAggFunction.ShortAvgAggFunction Built-in Short Avg aggregate function.

Constructor Summary

Constructors

Constructor and Description
AvgAggFunction()

Method Summary

Modifier and Type	Method and Description
org.apache.flink.table.expressions.Expression[]	accumulateExpressions() Expressions for accumulating the mutable aggregation buffer based on an input row.
org.apache.flink.table.expressions.UnresolvedReferenceExpression[]	aggBufferAttributes() All fields of the aggregate buffer.
org.apache.flink.table.types.DataType[]	getAggBufferTypes() All types of the aggregate buffer.
abstract org.apache.flink.table.types.DataType	getSumType()
org.apache.flink.table.expressions.Expression	getValueExpression() If all input are nulls, count will be 0 and we will get null after the division.
org.apache.flink.table.expressions.Expression[]	initialValuesExpressions() Expressions for initializing empty aggregation buffers.
org.apache.flink.table.expressions.Expression[]	mergeExpressions() A sequence of expressions for merging two aggregation buffers together.
int	operandCount() How many operands your function will deal with.
org.apache.flink.table.expressions.Expression[]	retractExpressions() Expressions for retracting the mutable aggregation buffer based on an input row.

Methods inherited from class org.apache.flink.table.planner.functions.aggfunctions.DeclarativeAggregateFunction

getKind, getResultType, getTypeInference, mergeOperand, mergeOperands, operand, operands

Methods inherited from class org.apache.flink.table.functions.UserDefinedFunction

close, functionIdentifier, open, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.functions.FunctionDefinition

getRequirements, isDeterministic

Constructor Detail

AvgAggFunction

public AvgAggFunction()

Method Detail

getSumType

public abstract org.apache.flink.table.types.DataType getSumType()

operandCount

public int operandCount()

Description copied from class: DeclarativeAggregateFunction

How many operands your function will deal with.

Specified by:

operandCount in class DeclarativeAggregateFunction

aggBufferAttributes

public org.apache.flink.table.expressions.UnresolvedReferenceExpression[] aggBufferAttributes()

Description copied from class: DeclarativeAggregateFunction

All fields of the aggregate buffer.

Specified by:

aggBufferAttributes in class DeclarativeAggregateFunction

getAggBufferTypes

public org.apache.flink.table.types.DataType[] getAggBufferTypes()

Description copied from class: DeclarativeAggregateFunction

All types of the aggregate buffer.

Specified by:

getAggBufferTypes in class DeclarativeAggregateFunction

initialValuesExpressions

public org.apache.flink.table.expressions.Expression[] initialValuesExpressions()

Description copied from class: DeclarativeAggregateFunction

Expressions for initializing empty aggregation buffers.

Specified by:

initialValuesExpressions in class DeclarativeAggregateFunction

accumulateExpressions

public org.apache.flink.table.expressions.Expression[] accumulateExpressions()

Description copied from class: DeclarativeAggregateFunction

Expressions for accumulating the mutable aggregation buffer based on an input row.

Specified by:

accumulateExpressions in class DeclarativeAggregateFunction

retractExpressions

public org.apache.flink.table.expressions.Expression[] retractExpressions()

Description copied from class: DeclarativeAggregateFunction

Expressions for retracting the mutable aggregation buffer based on an input row.

Specified by:

retractExpressions in class DeclarativeAggregateFunction

mergeExpressions

public org.apache.flink.table.expressions.Expression[] mergeExpressions()

Description copied from class: DeclarativeAggregateFunction

A sequence of expressions for merging two aggregation buffers together. When defining these expressions, you can use the syntax attributeName and mergeOperand(attributeName) to refer to the attributes corresponding to each of the buffers being merged.

Specified by:

mergeExpressions in class DeclarativeAggregateFunction

getValueExpression

public org.apache.flink.table.expressions.Expression getValueExpression()

If all input are nulls, count will be 0 and we will get null after the division.

Specified by:

getValueExpression in class DeclarativeAggregateFunction