Package org.opensearch.index.rankeval

Class RatedSearchHit

java.lang.Object

org.opensearch.index.rankeval.RatedSearchHit

All Implemented Interfaces:

Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

public class RatedSearchHit
extends Object
implements Writeable, org.opensearch.core.xcontent.ToXContentObject

Combines a SearchHit with a document rating.

Nested Class Summary

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

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

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

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RatedSearchHit(SearchHit searchHit, OptionalInt rating)

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object obj)
OptionalInt	getRating()
SearchHit	getSearchHit()
final int	hashCode()
static RatedSearchHit	parse(org.opensearch.core.xcontent.XContentParser parser)
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.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.core.xcontent.ToXContentObject

isFragment

Constructor Details

RatedSearchHit

public RatedSearchHit(SearchHit searchHit,
 OptionalInt rating)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getSearchHit

public SearchHit getSearchHit()

getRating

public OptionalInt getRating()

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

parse

public static RatedSearchHit parse(org.opensearch.core.xcontent.XContentParser parser)
                            throws IOException

Throws:

IOException

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object