Module org.elasticsearch.server

Package org.elasticsearch.search.rank

Class RankDoc

java.lang.Object

org.apache.lucene.search.ScoreDoc

org.elasticsearch.search.rank.RankDoc

All Implemented Interfaces:

Writeable

public abstract class RankDoc
extends org.apache.lucene.search.ScoreDoc
implements Writeable

RankDoc is the base class for all ranked results. Subclasses should extend this with additional information required for their global ranking method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RankDoc.RankKey

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	NO_RANK
int	rank	If this document has been ranked, this is its final rrf ranking from all the result sets.

Fields inherited from class org.apache.lucene.search.ScoreDoc

doc, score, shardIndex

Constructor Summary

Constructors

Modifier	Constructor	Description
	RankDoc(int doc, float score, int shardIndex)
protected	RankDoc(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	doEquals(RankDoc rd)
protected abstract int	doHashCode()
protected abstract void	doWriteTo(StreamOutput out)
final boolean	equals(Object o)
final int	hashCode()
String	toString()
final void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Field Details

NO_RANK

public static final int NO_RANK

See Also:

• Constant Field Values

rank

public int rank

If this document has been ranked, this is its final rrf ranking from all the result sets.

Constructor Details

RankDoc

public RankDoc(int doc,
 float score,
 int shardIndex)

RankDoc

protected RankDoc(StreamInput in)
           throws IOException

Throws:

IOException

Method Details

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

doWriteTo

protected abstract void doWriteTo(StreamOutput out)
                           throws IOException

Throws:

IOException

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

doEquals

protected abstract boolean doEquals(RankDoc rd)

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

doHashCode

protected abstract int doHashCode()

toString

public String toString()

Overrides:

toString in class org.apache.lucene.search.ScoreDoc