com.exalead.search.v30

Class AggregationFunction

java.lang.Object

com.exalead.search.v30.AggregationFunction

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class AggregationFunction
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	expr
java.lang.String	functionName
java.lang.String	id

Constructor Summary

Constructors

Constructor and Description
AggregationFunction()
AggregationFunction(AggregationFunction o) Copy constructor
AggregationFunction(java.lang.String id, java.lang.String expr, java.lang.String functionName)

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AggregationFunction.
static AggregationFunction	fromString(java.lang.String s) String representation of this AggregationFunction.
java.lang.String	getExpr() The expression on which to perform the synthesis.
java.lang.String	getFunctionName() Aggregation function name.
java.lang.String	getId() Unique identifier of this function.
AggregationFunction	makeCopy() Creates and returns a deep copy of this AggregationFunction.
static AggregationFunction	readFrom(java.io.InputStream is) Read this AggregationFunction from an XML fragment.
void	setExpr(java.lang.String expr) The expression on which to perform the synthesis.
void	setFunctionName(java.lang.String functionName) Aggregation function name.
void	setId(java.lang.String id) Unique identifier of this function.
java.lang.String	toString() String representation of this AggregationFunction.
AggregationFunction	withExpr(java.lang.String expr)
AggregationFunction	withFunctionName(java.lang.String functionName)
AggregationFunction	withId(java.lang.String id)
void	writeTo(java.io.OutputStream os) Write this AggregationFunction as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

id

public java.lang.String id

expr

public java.lang.String expr

functionName

public java.lang.String functionName

Constructor Detail

AggregationFunction

public AggregationFunction()

AggregationFunction

public AggregationFunction(java.lang.String id,
                           java.lang.String expr,
                           java.lang.String functionName)

AggregationFunction

public AggregationFunction(AggregationFunction o)

Copy constructor

Method Detail

setId

public void setId(java.lang.String id)

Unique identifier of this function.

getId

public java.lang.String getId()

Unique identifier of this function.

withId

public AggregationFunction withId(java.lang.String id)

setExpr

public void setExpr(java.lang.String expr)

The expression on which to perform the synthesis. It can reference fields or virtual fields.

getExpr

public java.lang.String getExpr()

The expression on which to perform the synthesis. It can reference fields or virtual fields.

withExpr

public AggregationFunction withExpr(java.lang.String expr)

setFunctionName

public void setFunctionName(java.lang.String functionName)

Aggregation function name. We support the following aggregation functions:

• AVG: average field value
• MAX: maximum field value
• MIN: minimum field value
• SUM: sum of field values
• COUNT: number of values
• STDDEV: standard deviation of field values
• CENTILE(X): X-centile of field values. X is a double between 0.0 and 100.0.
• MAXDATE(format): maximum field value. The expression must be an index time. The output is parsed according to the specified format
• MINDATE(format): minimum field value. The expression must be an index time. The output is parsed according to the specified format

getFunctionName

public java.lang.String getFunctionName()

Aggregation function name. We support the following aggregation functions:

• AVG: average field value
• MAX: maximum field value
• MIN: minimum field value
• SUM: sum of field values
• COUNT: number of values
• STDDEV: standard deviation of field values
• CENTILE(X): X-centile of field values. X is a double between 0.0 and 100.0.
• MAXDATE(format): maximum field value. The expression must be an index time. The output is parsed according to the specified format
• MINDATE(format): minimum field value. The expression must be an index time. The output is parsed according to the specified format

withFunctionName

public AggregationFunction withFunctionName(java.lang.String functionName)

makeCopy

public AggregationFunction makeCopy()

Creates and returns a deep copy of this AggregationFunction.

readFrom

public static AggregationFunction readFrom(java.io.InputStream is)
                                    throws javax.xml.bind.JAXBException

Read this AggregationFunction 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 AggregationFunction as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static AggregationFunction fromString(java.lang.String s)
                                      throws javax.xml.bind.JAXBException,
                                             java.io.UnsupportedEncodingException

String representation of this AggregationFunction.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AggregationFunction.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this AggregationFunction.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException