org.elasticsearch.search.aggregations.bucket.significant.heuristics

Class SignificanceHeuristic

java.lang.Object

org.elasticsearch.search.aggregations.bucket.significant.heuristics.SignificanceHeuristic

Direct Known Subclasses:

JLHScore, NXYSignificanceHeuristic, PercentageScore, ScriptHeuristic

public abstract class SignificanceHeuristic
extends Object

Constructor Summary

Constructors

Constructor and Description
SignificanceHeuristic()

Method Summary

Modifier and Type	Method and Description
protected void	checkFrequencyValidity(long subsetFreq, long subsetSize, long supersetFreq, long supersetSize, String scoreFunctionName)
abstract double	getScore(long subsetFreq, long subsetSize, long supersetFreq, long supersetSize)
void	initialize(InternalAggregation.ReduceContext reduceContext)
abstract void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SignificanceHeuristic

public SignificanceHeuristic()

Method Detail

getScore

public abstract double getScore(long subsetFreq,
                                long subsetSize,
                                long supersetFreq,
                                long supersetSize)

Parameters:

subsetFreq - The frequency of the term in the selected sample

subsetSize - The size of the selected sample (typically number of docs)

supersetFreq - The frequency of the term in the superset from which the sample was taken

supersetSize - The size of the superset from which the sample was taken (typically number of docs)

Returns:

a "significance" score

writeTo

public abstract void writeTo(StreamOutput out)
                      throws IOException

Throws:

IOException

checkFrequencyValidity

protected void checkFrequencyValidity(long subsetFreq,
                                      long subsetSize,
                                      long supersetFreq,
                                      long supersetSize,
                                      String scoreFunctionName)

initialize

public void initialize(InternalAggregation.ReduceContext reduceContext)