Module org.elasticsearch.server

Package org.elasticsearch.search.rank

Class RankBuilder

java.lang.Object

org.elasticsearch.search.rank.RankBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, ToXContent, ToXContentObject

public abstract class RankBuilder
extends Object
implements VersionedNamedWriteable, ToXContentObject

RankContextBuilder is used as a base class to manage input, parsing, and subsequent generation of appropriate contexts for handling searches that require multiple queries for global rank relevance.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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	DEFAULT_WINDOW_SIZE
static final ParseField	WINDOW_SIZE_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RankBuilder(int windowSize)
RankBuilder(StreamInput in)

Method Summary

Modifier and Type	Method	Description
abstract RankCoordinatorContext	buildRankCoordinatorContext(int size, int from)	Generates a context used to perform global ranking on the coordinator.
abstract RankShardContext	buildRankShardContext(List<org.apache.lucene.search.Query> queries, int from)	Generates a context used to execute required searches on the shard.
protected abstract boolean	doEquals(RankBuilder other)
protected abstract int	doHashCode()
protected abstract void	doWriteTo(StreamOutput out)
protected abstract void	doXContent(XContentBuilder builder, ToXContent.Params params)
final boolean	equals(Object obj)
final int	hashCode()
String	toString()
final XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
int	windowSize()
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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

getMinimalSupportedVersion, getWriteableName

Field Details

WINDOW_SIZE_FIELD

public static final ParseField WINDOW_SIZE_FIELD

DEFAULT_WINDOW_SIZE

public static final int DEFAULT_WINDOW_SIZE

See Also:

• Constant Field Values

Constructor Details

RankBuilder

public RankBuilder(int windowSize)

RankBuilder

public RankBuilder(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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

doXContent

protected abstract void doXContent(XContentBuilder builder,
 ToXContent.Params params)
                            throws IOException

Throws:

IOException

windowSize

public int windowSize()

buildRankShardContext

public abstract RankShardContext buildRankShardContext(List<org.apache.lucene.search.Query> queries,
 int from)

Generates a context used to execute required searches on the shard.

buildRankCoordinatorContext

public abstract RankCoordinatorContext buildRankCoordinatorContext(int size,
 int from)

Generates a context used to perform global ranking on the coordinator.

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

doEquals

protected abstract boolean doEquals(RankBuilder other)

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

doHashCode

protected abstract int doHashCode()

toString

public String toString()

Overrides:

toString in class Object