com.ibm.watson.discovery.v2.model

Class QueryHistogramAggregation

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.discovery.v2.model.QueryAggregation

com.ibm.watson.discovery.v2.model.QueryHistogramAggregation

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class QueryHistogramAggregation
extends QueryAggregation

Numeric interval segments to categorize documents by using field values from a single numeric field to describe the category.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	field
protected java.lang.Long	interval
protected java.lang.String	name
protected java.util.List<QueryHistogramAggregationResult>	results

Fields inherited from class com.ibm.watson.discovery.v2.model.QueryAggregation

discriminatorMapping, discriminatorPropertyName, type

Constructor Summary

Constructors

Constructor and Description
QueryHistogramAggregation()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getField() Gets the field.
java.lang.Long	getInterval() Gets the interval.
java.lang.String	getName() Gets the name.
java.util.List<QueryHistogramAggregationResult>	getResults() Gets the results.

Methods inherited from class com.ibm.watson.discovery.v2.model.QueryAggregation

getType

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

field

protected java.lang.String field

interval

protected java.lang.Long interval

name

protected java.lang.String name

results

protected java.util.List<QueryHistogramAggregationResult> results

Constructor Detail

QueryHistogramAggregation

public QueryHistogramAggregation()

Method Detail

getField

public java.lang.String getField()

Gets the field.

The numeric field name used to create the histogram.

Returns:

the field

getInterval

public java.lang.Long getInterval()

Gets the interval.

The size of the sections the results are split into.

Returns:

the interval

getName

public java.lang.String getName()

Gets the name.

Identifier specified in the query request of this aggregation.

Returns:

the name

getResults

public java.util.List<QueryHistogramAggregationResult> getResults()

Gets the results.

Array of numeric intervals.

Returns:

the results