Package org.apache.flink.table.runtime.functions.aggregate

Class JsonObjectAggFunction

java.lang.Object

org.apache.flink.table.functions.UserDefinedFunction

org.apache.flink.table.functions.ImperativeAggregateFunction<T,ACC>

org.apache.flink.table.functions.AggregateFunction<T,ACC>

org.apache.flink.table.runtime.functions.aggregate.BuiltInAggregateFunction<String,JsonObjectAggFunction.Accumulator>

org.apache.flink.table.runtime.functions.aggregate.JsonObjectAggFunction

All Implemented Interfaces:

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

@Internal
public class JsonObjectAggFunction
extends BuiltInAggregateFunction<String,JsonObjectAggFunction.Accumulator>

Implementation for BuiltInFunctionDefinitions.JSON_OBJECTAGG_NULL_ON_NULL / BuiltInFunctionDefinitions.JSON_OBJECTAGG_ABSENT_ON_NULL.

Note that this function only ever receives strings to accumulate because WrapJsonAggFunctionArgumentsRule wraps arguments into BuiltInFunctionDefinitions.JSON_STRING.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonObjectAggFunction.Accumulator	Accumulator for JsonObjectAggFunction.

Constructor Summary

Constructors

Constructor	Description
JsonObjectAggFunction(org.apache.flink.table.types.logical.LogicalType[] argumentTypes, boolean skipNulls)

Method Summary

Modifier and Type	Method	Description
void	accumulate(JsonObjectAggFunction.Accumulator acc, org.apache.flink.table.data.StringData keyData, org.apache.flink.table.data.StringData valueData)
JsonObjectAggFunction.Accumulator	createAccumulator()
org.apache.flink.table.types.DataType	getAccumulatorDataType()
List<org.apache.flink.table.types.DataType>	getArgumentDataTypes()
org.apache.flink.table.types.DataType	getOutputDataType()
String	getValue(JsonObjectAggFunction.Accumulator acc)
void	merge(JsonObjectAggFunction.Accumulator acc, Iterable<JsonObjectAggFunction.Accumulator> others)
void	resetAccumulator(JsonObjectAggFunction.Accumulator acc)
void	retract(JsonObjectAggFunction.Accumulator acc, org.apache.flink.table.data.StringData keyData, org.apache.flink.table.data.StringData valueData)

Methods inherited from class org.apache.flink.table.runtime.functions.aggregate.BuiltInAggregateFunction

getRequirements, getTypeInference, isDeterministic

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

getKind

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

getAccumulatorType, getResultType

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

supportsConstantFolding

Constructor Detail

JsonObjectAggFunction

public JsonObjectAggFunction(org.apache.flink.table.types.logical.LogicalType[] argumentTypes,
                             boolean skipNulls)

Method Detail

getArgumentDataTypes

public List<org.apache.flink.table.types.DataType> getArgumentDataTypes()

Overrides:

getArgumentDataTypes in class BuiltInAggregateFunction<String,JsonObjectAggFunction.Accumulator>

getOutputDataType

public org.apache.flink.table.types.DataType getOutputDataType()

Overrides:

getOutputDataType in class BuiltInAggregateFunction<String,JsonObjectAggFunction.Accumulator>

getAccumulatorDataType

public org.apache.flink.table.types.DataType getAccumulatorDataType()

Overrides:

getAccumulatorDataType in class BuiltInAggregateFunction<String,JsonObjectAggFunction.Accumulator>

createAccumulator

public JsonObjectAggFunction.Accumulator createAccumulator()

Specified by:

createAccumulator in class org.apache.flink.table.functions.ImperativeAggregateFunction<String,JsonObjectAggFunction.Accumulator>

resetAccumulator

public void resetAccumulator(JsonObjectAggFunction.Accumulator acc)

accumulate

public void accumulate(JsonObjectAggFunction.Accumulator acc,
                       org.apache.flink.table.data.StringData keyData,
                       @Nullable
                       org.apache.flink.table.data.StringData valueData)
                throws Exception

Throws:

Exception

retract

public void retract(JsonObjectAggFunction.Accumulator acc,
                    org.apache.flink.table.data.StringData keyData,
                    @Nullable
                    org.apache.flink.table.data.StringData valueData)
             throws Exception

Throws:

Exception

merge

public void merge(JsonObjectAggFunction.Accumulator acc,
                  Iterable<JsonObjectAggFunction.Accumulator> others)
           throws Exception

Throws:

Exception

getValue

public String getValue(JsonObjectAggFunction.Accumulator acc)

Specified by:

getValue in class org.apache.flink.table.functions.AggregateFunction<String,JsonObjectAggFunction.Accumulator>