Package org.elasticsearch.search.rescore

Class RescorerBuilder<RB extends RescorerBuilder<RB>>

java.lang.Object

org.elasticsearch.search.rescore.RescorerBuilder<RB>

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, Rewriteable<RescorerBuilder<RB>>

Direct Known Subclasses:

QueryRescorerBuilder

public abstract class RescorerBuilder<RB extends RescorerBuilder<RB>>
extends java.lang.Object
implements NamedWriteable, ToXContentObject, Rewriteable<RescorerBuilder<RB>>

The abstract base builder for instances of RescorerBuilder.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.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 int	DEFAULT_WINDOW_SIZE
protected java.lang.Integer	windowSize

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	RescorerBuilder()	Construct an empty RescoreBuilder.
protected	RescorerBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
RescoreContext	buildContext(QueryShardContext context)	Build the RescoreContext that will be used to actually execute the rescore against a particular shard.
protected abstract void	doWriteTo(StreamOutput out)
protected abstract void	doXContent(XContentBuilder builder, ToXContent.Params params)
boolean	equals(java.lang.Object obj)
int	hashCode()
protected abstract RescoreContext	innerBuildContext(int windowSize, QueryShardContext context)	Extensions override this to build the context that they need for rescoring.
static RescorerBuilder<?>	parseFromXContent(XContentParser parser)
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.Integer	windowSize()
RB	windowSize(int windowSize)
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.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.index.query.Rewriteable

rewrite

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Detail

DEFAULT_WINDOW_SIZE

public static final int DEFAULT_WINDOW_SIZE

See Also:

Constant Field Values

windowSize

protected java.lang.Integer windowSize

Constructor Detail

RescorerBuilder

public RescorerBuilder()

Construct an empty RescoreBuilder.

RescorerBuilder

protected RescorerBuilder(StreamInput in)
                   throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

writeTo

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

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

doWriteTo

protected abstract void doWriteTo(StreamOutput out)
                           throws java.io.IOException

Throws:

java.io.IOException

windowSize

public RB windowSize(int windowSize)

windowSize

public java.lang.Integer windowSize()

parseFromXContent

public static RescorerBuilder<?> parseFromXContent(XContentParser parser)
                                            throws java.io.IOException

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

doXContent

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

Throws:

java.io.IOException

buildContext

public final RescoreContext buildContext(QueryShardContext context)
                                  throws java.io.IOException

Build the RescoreContext that will be used to actually execute the rescore against a particular shard.

Throws:

java.io.IOException

innerBuildContext

protected abstract RescoreContext innerBuildContext(int windowSize,
                                                    QueryShardContext context)
                                             throws java.io.IOException

Extensions override this to build the context that they need for rescoring.

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object