com.ibm.watson.discovery.query

Enum AggregationType

java.lang.Object

java.lang.Enum<AggregationType>

com.ibm.watson.discovery.query.AggregationType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AggregationType>

public enum AggregationType
extends java.lang.Enum<AggregationType>

Aggregation types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVERAGE The average.
FILTER The filter.
HISTOGRAM The histogram.
MAX The max.
MIN The min.
NESTED The nested.
SUM The sum.
TERM The term.
TIMESLICE The timeslice.
TOP_HITS The top hits.
UNIQUE_COUNT The unique count.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Gets the name.
java.lang.String	toString() To string.
static AggregationType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AggregationType	valueOfIgnoreCase(java.lang.String value) Value of ignore case.
static AggregationType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TERM

public static final AggregationType TERM

The term.

FILTER

public static final AggregationType FILTER

The filter.

NESTED

public static final AggregationType NESTED

The nested.

HISTOGRAM

public static final AggregationType HISTOGRAM

The histogram.

TIMESLICE

public static final AggregationType TIMESLICE

The timeslice.

TOP_HITS

public static final AggregationType TOP_HITS

The top hits.

UNIQUE_COUNT

public static final AggregationType UNIQUE_COUNT

The unique count.

MAX

public static final AggregationType MAX

The max.

MIN

public static final AggregationType MIN

The min.

AVERAGE

public static final AggregationType AVERAGE

The average.

SUM

public static final AggregationType SUM

The sum.

Method Detail

values

public static AggregationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AggregationType c : AggregationType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AggregationType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getName

public java.lang.String getName()

Gets the name.

Returns:

the name

valueOfIgnoreCase

public static AggregationType valueOfIgnoreCase(java.lang.String value)
                                         throws java.lang.IllegalArgumentException

Value of ignore case.

Parameters:

value - the value

Returns:

the aggregation type

Throws:

java.lang.IllegalArgumentException - the illegal argument exception

toString

public java.lang.String toString()

To string.

Overrides:

toString in class java.lang.Enum<AggregationType>

Returns:

the string