com.ibm.watson.discovery.v2.model

Class QueryTermAggregationResult

java.lang.Object

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

com.ibm.watson.discovery.v2.model.QueryTermAggregationResult

All Implemented Interfaces:

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

public class QueryTermAggregationResult
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Top value result for the term aggregation.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<QueryAggregation>	aggregations
protected java.lang.Long	estimatedMatchingDocuments
protected java.lang.String	key
protected java.lang.Long	matchingResults
protected java.lang.Double	relevancy
protected java.lang.Long	totalMatchingDocuments

Constructor Summary

Constructors

Constructor and Description
QueryTermAggregationResult()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<QueryAggregation>	getAggregations() Gets the aggregations.
java.lang.Long	getEstimatedMatchingDocuments() Gets the estimatedMatchingDocuments.
java.lang.String	getKey() Gets the key.
java.lang.Long	getMatchingResults() Gets the matchingResults.
java.lang.Double	getRelevancy() Gets the relevancy.
java.lang.Long	getTotalMatchingDocuments() Gets the totalMatchingDocuments.

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

key

protected java.lang.String key

matchingResults

@SerializedName(value="matching_results")
protected java.lang.Long matchingResults

relevancy

protected java.lang.Double relevancy

totalMatchingDocuments

@SerializedName(value="total_matching_documents")
protected java.lang.Long totalMatchingDocuments

estimatedMatchingDocuments

@SerializedName(value="estimated_matching_documents")
protected java.lang.Long estimatedMatchingDocuments

aggregations

protected java.util.List<QueryAggregation> aggregations

Constructor Detail

QueryTermAggregationResult

public QueryTermAggregationResult()

Method Detail

getKey

public java.lang.String getKey()

Gets the key.

Value of the field with a non-zero frequency in the document set.

Returns:

the key

getMatchingResults

public java.lang.Long getMatchingResults()

Gets the matchingResults.

Number of documents containing the 'key'.

Returns:

the matchingResults

getRelevancy

public java.lang.Double getRelevancy()

Gets the relevancy.

The relevancy for this term.

Returns:

the relevancy

getTotalMatchingDocuments

public java.lang.Long getTotalMatchingDocuments()

Gets the totalMatchingDocuments.

The number of documents which have the term as the value of specified field in the whole set of documents in this collection. Returned only when the `relevancy` parameter is set to `true`.

Returns:

the totalMatchingDocuments

getEstimatedMatchingDocuments

public java.lang.Long getEstimatedMatchingDocuments()

Gets the estimatedMatchingDocuments.

The estimated number of documents which would match the query and also meet the condition. Returned only when the `relevancy` parameter is set to `true`.

Returns:

the estimatedMatchingDocuments

getAggregations

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

Gets the aggregations.

An array of sub aggregations.

Returns:

the aggregations