com.ibm.watson.developer_cloud.discovery.v1.model

Class QueryAggregation

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.discovery.v1.model.QueryAggregation

All Implemented Interfaces:

ObjectModel

Direct Known Subclasses:

Calculation, Histogram, Term

public class QueryAggregation
extends GenericModel

An aggregation produced by the Discovery service to analyze the input provided.

Constructor Summary

Constructors

Constructor and Description
QueryAggregation()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<QueryAggregation>	getAggregations() Gets the aggregations.
java.lang.String	getField() Gets the field.
java.lang.String	getMatch() Gets the match.
java.lang.Long	getMatchingResults() Gets the matchingResults.
java.util.List<AggregationResult>	getResults() Gets the results.
java.lang.String	getType() Gets the type.
void	setAggregations(java.util.List<QueryAggregation> aggregations) Sets the aggregations.
void	setField(java.lang.String field) Sets the field.
void	setMatch(java.lang.String match) Sets the match.
void	setMatchingResults(long matchingResults) Sets the matchingResults.
void	setResults(java.util.List<AggregationResult> results) Sets the results.
void	setType(java.lang.String type) Sets the type.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryAggregation

public QueryAggregation()

Method Detail

getType

public java.lang.String getType()

Gets the type. The type of aggregation command used. For example: term, filter, max, min, etc.

Returns:

the type

getField

public java.lang.String getField()

Gets the field. The field where the aggregation is located in the document.

Returns:

the field

getResults

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

Gets the results.

Returns:

the results

getMatch

public java.lang.String getMatch()

Gets the match. The match the aggregated results queried for.

Returns:

the match

getMatchingResults

public java.lang.Long getMatchingResults()

Gets the matchingResults. Number of matching results.

Returns:

the matchingResults

getAggregations

public java.util.List<QueryAggregation> getAggregations()

Gets the aggregations. Aggregations returned by the Discovery service.

Returns:

the aggregations

setType

public void setType(java.lang.String type)

Sets the type.

Parameters:

type - the new type

setField

public void setField(java.lang.String field)

Sets the field.

Parameters:

field - the new field

setResults

public void setResults(java.util.List<AggregationResult> results)

Sets the results.

Parameters:

results - the new results

setMatch

public void setMatch(java.lang.String match)

Sets the match.

Parameters:

match - the new match

setMatchingResults

public void setMatchingResults(long matchingResults)

Sets the matchingResults.

Parameters:

matchingResults - the new matchingResults

setAggregations

public void setAggregations(java.util.List<QueryAggregation> aggregations)

Sets the aggregations.

Parameters:

aggregations - the new aggregations