public abstract class ScoreFunctionBuilder<FB extends ScoreFunctionBuilder<FB>> extends java.lang.Object implements ToXContent, NamedWriteable
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Writeable.Reader<R>
EMPTY_PARAMS
Constructor and Description |
---|
ScoreFunctionBuilder()
Standard empty constructor.
|
ScoreFunctionBuilder(StreamInput in)
Read from a stream.
|
Modifier and Type | Method and Description |
---|---|
protected abstract boolean |
doEquals(FB functionBuilder)
Check that two instances of the same subclass of ScoreFunctionBuilder are equal.
|
protected abstract int |
doHashCode()
Hashcode for fields defined in this subclass of ScoreFunctionBuilder.
|
protected abstract ScoreFunction |
doToFunction(QueryShardContext context)
Build the Lucene ScoreFunction for this builder.
|
protected abstract void |
doWriteTo(StreamOutput out)
Write the subclass's components into the stream.
|
protected abstract void |
doXContent(XContentBuilder builder,
ToXContent.Params params)
Convert this subclass's data into XContent.
|
boolean |
equals(java.lang.Object obj) |
abstract java.lang.String |
getName()
The name of this score function.
|
java.lang.Float |
getWeight()
The weight applied to the function before combining.
|
java.lang.String |
getWriteableName()
Returns the name of the writeable object
|
int |
hashCode() |
FB |
setWeight(float weight)
Set the weight applied to the function before combining.
|
ScoreFunction |
toFunction(QueryShardContext context)
Called on a data node, converts this ScoreFunctionBuilder into its corresponding Lucene function object.
|
XContentBuilder |
toXContent(XContentBuilder builder,
ToXContent.Params params) |
void |
writeTo(StreamOutput out)
Write this into the StreamOutput.
|
public ScoreFunctionBuilder()
public ScoreFunctionBuilder(StreamInput in) throws java.io.IOException
java.io.IOException
public final void writeTo(StreamOutput out) throws java.io.IOException
Writeable
protected abstract void doWriteTo(StreamOutput out) throws java.io.IOException
java.io.IOException
public abstract java.lang.String getName()
public final FB setWeight(float weight)
public final java.lang.Float getWeight()
public final XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
toXContent
in interface ToXContent
java.io.IOException
protected abstract void doXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
java.io.IOException
public final java.lang.String getWriteableName()
NamedWriteable
getWriteableName
in interface NamedWriteable
public final boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
protected abstract boolean doEquals(FB functionBuilder)
public final int hashCode()
hashCode
in class java.lang.Object
protected abstract int doHashCode()
public final ScoreFunction toFunction(QueryShardContext context) throws java.io.IOException
java.io.IOException
protected abstract ScoreFunction doToFunction(QueryShardContext context) throws java.io.IOException
java.io.IOException