Package org.opensearch.index.rankeval

Class RatedSearchHit

java.lang.Object

org.opensearch.index.rankeval.RatedSearchHit

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class RatedSearchHit
extends java.lang.Object
implements Writeable, ToXContentObject

Combines a SearchHit with a document rating.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RatedSearchHit(SearchHit searchHit, java.util.OptionalInt rating)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.util.OptionalInt	getRating()
SearchHit	getSearchHit()
int	hashCode()
static RatedSearchHit	parse(XContentParser parser)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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.opensearch.common.xcontent.ToXContentObject

isFragment

Constructor Detail

RatedSearchHit

public RatedSearchHit(SearchHit searchHit,
                      java.util.OptionalInt rating)

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

getSearchHit

public SearchHit getSearchHit()

getRating

public java.util.OptionalInt getRating()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

parse

public static RatedSearchHit parse(XContentParser parser)
                            throws java.io.IOException

Throws:

java.io.IOException

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object