org.elasticsearch.search.aggregations.bucket.terms.SignificantTerms Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :distribution:archives:integ-test-zip
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.search.aggregations.bucket.terms;
import org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation;
import java.util.List;
/**
* An aggregation that collects significant terms in comparison to a background set.
*/
public interface SignificantTerms extends MultiBucketsAggregation, Iterable {
interface Bucket extends MultiBucketsAggregation.Bucket {
/**
* @return The significant score for the subset
*/
double getSignificanceScore();
/**
* @return The number of docs in the subset containing a particular term.
* This number is equal to the document count of the bucket.
*/
long getSubsetDf();
/**
* @return The numbers of docs in the subset (also known as "foreground set").
* This number is equal to the document count of the containing aggregation.
*/
long getSubsetSize();
/**
* @return The number of docs in the superset containing a particular term (also
* known as the "background count" of the bucket)
*/
long getSupersetDf();
/**
* @return The numbers of docs in the superset (ordinarily the background count
* of the containing aggregation).
*/
long getSupersetSize();
/**
* @return The key, expressed as a number
*/
Number getKeyAsNumber();
}
@Override
List getBuckets();
/**
* Get the bucket for the given term, or null if there is no such bucket.
*/
Bucket getBucketByKey(String term);
}