Package org.elasticsearch.index.rankeval

Class DiscountedCumulativeGain.Detail

java.lang.Object

org.elasticsearch.index.rankeval.DiscountedCumulativeGain.Detail

All Implemented Interfaces:

NamedWriteable, Writeable, MetricDetail, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

Enclosing class:

DiscountedCumulativeGain

public static final class DiscountedCumulativeGain.Detail
extends Object
implements MetricDetail

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static DiscountedCumulativeGain.Detail	fromXContent(org.elasticsearch.xcontent.XContentParser parser)
double	getDCG()
double	getIDCG()
String	getMetricName()
double	getNDCG()
Object	getUnratedDocs()
String	getWriteableName()
int	hashCode()
org.elasticsearch.xcontent.XContentBuilder	innerToXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)	Implementations should write their own fields to the XContentBuilder passed in.
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.rankeval.MetricDetail

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Method Details

getMetricName

public String getMetricName()

Specified by:

getMetricName in interface MetricDetail

innerToXContent

public org.elasticsearch.xcontent.XContentBuilder innerToXContent(org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.ToXContent.Params params)
                                                           throws IOException

Description copied from interface: MetricDetail

Implementations should write their own fields to the XContentBuilder passed in.

Specified by:

innerToXContent in interface MetricDetail

Throws:

IOException

fromXContent

public static DiscountedCumulativeGain.Detail fromXContent(org.elasticsearch.xcontent.XContentParser parser)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

getDCG

public double getDCG()

Returns:

the discounted cumulative gain

getIDCG

public double getIDCG()

Returns:

the ideal discounted cumulative gain, can be 0 if nothing was computed, e.g. because no normalization was required

getNDCG

public double getNDCG()

Returns:

the normalized discounted cumulative gain, can be 0 if nothing was computed, e.g. because no normalization was required

getUnratedDocs

public Object getUnratedDocs()

Returns:

the number of unrated documents in the search results

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object