Aggregation (EXALEAD CloudView Custom code SDK)

java.lang.Object
- com.exalead.search.v30.Aggregation

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class Aggregation
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
```
Combines the values of the specified expr for all the hits of the group and output the value to the specified meta. For example, if you have hits:
- H1 with values: sort_field=100, group_field=12, value_field=57
- H2 with values: sort_field=50, group_field=12, value_field=23
With a sort by sort_field and a group by group_field, the GroupBy will only keep the hit H1 because its sort_field has the best value.
- with a function on value_field of type "MIN", the value of value_field in the grouped hit will be 23 (minimum value over grouped hits)
- with a function on value_field of type "MAX", the value of value_field in the grouped hit will be 57 (maximum value over grouped hits)
- with a function on value_field of type "SUM", the value of value_field in the grouped hit will be 80 (sum of values for grouped hits)
- with a function on value_field of type "AVG", the value of value_field in the grouped hit will be 40 (average of values for grouped hits)
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Aggregation.Function

Nested Classes
Modifier and Type	Class and Description
`static class`	`Aggregation.Function`

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`aggregationField`
`static java.lang.String`	`DEFAULT_FUNCTION`
`java.lang.String`	`expr`
`java.lang.String`	`function`
`java.lang.String`	`separator`

Constructor Summary

Constructors
Constructor and Description

Aggregation()

Aggregation(Aggregation o)
Copy constructor

Constructors
Constructor and Description
`Aggregation()`
`Aggregation(Aggregation o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this Aggregation.
`static Aggregation`	`fromString(java.lang.String s)` String representation of this Aggregation.
`java.lang.String`	`getAggregationField()`
`java.lang.String`	`getExpr()` Field to compute on the grouped hits.
`java.lang.String`	`getFunction()` Aggregation function to apply on the specified expression.
`Aggregation.Function`	`getFunctionAsEnum()` Aggregation function to apply on the specified expression.
`java.lang.String`	`getSeparator()` Character to separate concatenated strings.
`static boolean`	`isA(java.lang.String str, Aggregation.Function item)`
`static boolean`	`isOneOf(java.lang.String str, Aggregation.Function... items)`
`Aggregation`	`makeCopy()` Creates and returns a deep copy of this Aggregation.
`static Aggregation`	`readFrom(java.io.InputStream is)` Read this Aggregation from an XML fragment.
`void`	`setAggregationField(java.lang.String aggregationField)`
`void`	`setExpr(java.lang.String expr)` Field to compute on the grouped hits.
`void`	`setFunction(Aggregation.Function item)` Aggregation function to apply on the specified expression.
`void`	`setFunction(java.lang.String function)` Aggregation function to apply on the specified expression.
`void`	`setSeparator(java.lang.String separator)` Character to separate concatenated strings.
`java.lang.String`	`toString()` String representation of this Aggregation.
`Aggregation`	`withAggregationField(java.lang.String aggregationField)`
`Aggregation`	`withExpr(java.lang.String expr)`
`Aggregation`	`withFunction(java.lang.String function)`
`Aggregation`	`withSeparator(java.lang.String separator)`
`void`	`writeTo(java.io.OutputStream os)` Write this Aggregation as an XML fragment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - expr
```
public java.lang.String expr
```
  - aggregationField
```
public java.lang.String aggregationField
```
  - function
```
public java.lang.String function
```
  - DEFAULT_FUNCTION
```
public static final java.lang.String DEFAULT_FUNCTION
```
    See Also:
    
    Constant Field Values
  - separator
```
public java.lang.String separator
```
- Constructor Detail
  - Aggregation
```
public Aggregation()
```
  - Aggregation
```
public Aggregation(Aggregation o)
```
    Copy constructor
- Method Detail
  - isA
```
public static boolean isA(java.lang.String str,
                          Aggregation.Function item)
```
  - isOneOf
```
public static boolean isOneOf(java.lang.String str,
                              Aggregation.Function... items)
```
  - setFunction
```
public void setFunction(Aggregation.Function item)
```
    Aggregation function to apply on the specified expression.
    - MIN/MAX use the lowest/highest value of all hits in the group
    - SUM adds the values of all hits in the group
    - AVG calculates the mean of values of all hits in the group
    - STDDEV calculates the standard deviation of values of all hits in the group
    - CONCAT joins all the values from all the hits in the group. Only works with alphanumerical values.
  - getFunctionAsEnum
```
public Aggregation.Function getFunctionAsEnum()
```
    Aggregation function to apply on the specified expression.
    - MIN/MAX use the lowest/highest value of all hits in the group
    - SUM adds the values of all hits in the group
    - AVG calculates the mean of values of all hits in the group
    - STDDEV calculates the standard deviation of values of all hits in the group
    - CONCAT joins all the values from all the hits in the group. Only works with alphanumerical values.
  - setExpr
```
public void setExpr(java.lang.String expr)
```
    Field to compute on the grouped hits.
  - getExpr
```
public java.lang.String getExpr()
```
    Field to compute on the grouped hits.
  - withExpr
```
public Aggregation withExpr(java.lang.String expr)
```
  - setAggregationField
```
public void setAggregationField(java.lang.String aggregationField)
```
  - getAggregationField
```
public java.lang.String getAggregationField()
```
  - withAggregationField
```
public Aggregation withAggregationField(java.lang.String aggregationField)
```
  - setFunction
```
public void setFunction(java.lang.String function)
```
    Aggregation function to apply on the specified expression.
    - MIN/MAX use the lowest/highest value of all hits in the group
    - SUM adds the values of all hits in the group
    - AVG calculates the mean of values of all hits in the group
    - STDDEV calculates the standard deviation of values of all hits in the group
    - CONCAT joins all the values from all the hits in the group. Only works with alphanumerical values.
  - getFunction
```
public java.lang.String getFunction()
```
    Aggregation function to apply on the specified expression.
    - MIN/MAX use the lowest/highest value of all hits in the group
    - SUM adds the values of all hits in the group
    - AVG calculates the mean of values of all hits in the group
    - STDDEV calculates the standard deviation of values of all hits in the group
    - CONCAT joins all the values from all the hits in the group. Only works with alphanumerical values.
  - withFunction
```
public Aggregation withFunction(java.lang.String function)
```
  - setSeparator
```
public void setSeparator(java.lang.String separator)
```
    Character to separate concatenated strings.
  - getSeparator
```
public java.lang.String getSeparator()
```
    Character to separate concatenated strings.
  - withSeparator
```
public Aggregation withSeparator(java.lang.String separator)
```
  - makeCopy
```
public Aggregation makeCopy()
```
    Creates and returns a deep copy of this Aggregation.
  - readFrom
```
public static Aggregation readFrom(java.io.InputStream is)
                            throws javax.xml.bind.JAXBException
```
    Read this Aggregation from an XML fragment.
    
    Throws:
    
    javax.xml.bind.JAXBException
  - writeTo
```
public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException
```
    Write this Aggregation as an XML fragment
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static Aggregation fromString(java.lang.String s)
                              throws javax.xml.bind.JAXBException,
                                     java.io.UnsupportedEncodingException
```
    String representation of this Aggregation.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this Aggregation.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this Aggregation.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class Aggregation

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

expr

aggregationField

function

DEFAULT_FUNCTION

separator

Constructor Detail

Aggregation

Aggregation

Method Detail

isA

isOneOf

setFunction

getFunctionAsEnum

setExpr

getExpr

withExpr

setAggregationField

getAggregationField

withAggregationField

setFunction

getFunction

withFunction

setSeparator

getSeparator

withSeparator

makeCopy

readFrom

writeTo

fromString

toString

check