com.exalead.searchapi.xmlv10.client

Interface AggregationFunction

All Known Implementing Classes:

AggregationFunctionImpl, AggregationFunctionImpl

public interface AggregationFunction

The AggregationFunction class is used to manipulate aggregation function results. Each CategoryGroup can hold several such AggregationFunctions. The value an aggregation function for a given Category can be retrieved by passing the corresponding AggregationFunction to Category.getAggregationValue().

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AggregationFunction.ValueType

Field Summary

Fields

Modifier and Type	Field and Description
static long	UNDEFINED_VALUE

Method Summary

Modifier and Type	Method and Description
CategoryGroup	getCategoryGroup() Get the category group of this AggregationFunction.
java.lang.String	getFunctionName() Get the function name for the aggregation function, e.g.
java.lang.String	getId() Get the id of the AggregationFunction.
int	getIdx() Get the idx of the AggregationFunction.
AggregationFunction.ValueType	getValueType() Get the value type of this AggregationFunction.
java.lang.String	getVirtualExpr() Get the virtual expression for the aggregation function.

Field Detail

UNDEFINED_VALUE

static final long UNDEFINED_VALUE

See Also:

Constant Field Values

Method Detail

getFunctionName

java.lang.String getFunctionName()

Get the function name for the aggregation function, e.g. 'AVG'

getVirtualExpr

java.lang.String getVirtualExpr()

Get the virtual expression for the aggregation function.

getId

java.lang.String getId()

Get the id of the AggregationFunction.

getCategoryGroup

CategoryGroup getCategoryGroup()

Get the category group of this AggregationFunction.

getValueType

AggregationFunction.ValueType getValueType()

Get the value type of this AggregationFunction.

getIdx

int getIdx()

Get the idx of the AggregationFunction. For internal use.