org.apache.metamodel.query

Interface AggregateFunction

All Superinterfaces:

FunctionType, Serializable

All Known Implementing Classes:

AverageAggregateFunction, CountAggregateFunction, DefaultAggregateFunction, FirstAggregateFunction, LastAggregateFunction, LegacyDeserializationObjectInputStream.LegacyFunctionType, MaxAggregateFunction, MinAggregateFunction, RandomAggregateFunction, SumAggregateFunction

public interface AggregateFunction
extends FunctionType

Interface that contains the aggregation specific methods related to the AggregateBuilder.

Field Summary

Fields inherited from interface org.apache.metamodel.query.FunctionType

AVG, COUNT, FIRST, JAVA_SUBSTRING, LAST, MAP_VALUE, MAX, MIN, RANDOM, SUBSTRING, SUM, TO_BOOLEAN, TO_DATE, TO_NUMBER, TO_STRING

Method Summary

Modifier and Type	Method and Description
AggregateBuilder<?>	createAggregateBuilder() Creates a specific aggregate builder.
Object	evaluate(Object... values) Shorthand for creating an aggregate builder, adding all the values and then calculating the value.
ColumnType	getExpectedColumnType(ColumnType type) Returns the function ColumnType.

Methods inherited from interface org.apache.metamodel.query.FunctionType

getFunctionName

Method Detail

createAggregateBuilder

AggregateBuilder<?> createAggregateBuilder()

Creates a specific aggregate builder.

Returns:

an AggregateBuilder instance

evaluate

Object evaluate(Object... values)

Shorthand for creating an aggregate builder, adding all the values and then calculating the value.

Parameters:

values -

Returns:

the aggregated value

getExpectedColumnType

ColumnType getExpectedColumnType(ColumnType type)

Returns the function ColumnType.

Specified by:

getExpectedColumnType in interface FunctionType

Parameters:

type -

Returns:

the ColumnType