Package org.elasticsearch.search.sort
Class ScoreSortBuilder
java.lang.Object
org.elasticsearch.search.sort.SortBuilder<ScoreSortBuilder>
org.elasticsearch.search.sort.ScoreSortBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,Rewriteable<SortBuilder<?>>
public class ScoreSortBuilder extends SortBuilder<ScoreSortBuilder>
A sort builder allowing to sort by score.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 java.lang.String
NAME
Fields inherited from class org.elasticsearch.search.sort.SortBuilder
NESTED_FILTER_FIELD, NESTED_PATH_FIELD, order, ORDER_FIELD
-
Constructor Summary
Constructors Constructor Description ScoreSortBuilder()
Build a ScoreSortBuilder default to descending sort order.ScoreSortBuilder(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description SortFieldAndFormat
build(QueryShardContext context)
Create a SortFieldAndFormat from this builder.BucketedSort
buildBucketedSort(QueryShardContext context, int bucketSize, BucketedSort.ExtraData extra)
Create a BucketedSort which is useful for sorting inside of aggregations.boolean
equals(java.lang.Object object)
static ScoreSortBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser, java.lang.String fieldName)
java.lang.String
getWriteableName()
Returns the name of the writeable objectint
hashCode()
ScoreSortBuilder
rewrite(QueryRewriteContext ctx)
Rewrites this instance based on the provided context.org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.search.sort.SortBuilder
buildSort, fromXContent, order, order, parseNestedFilter, resolveNested, resolveNested, toString
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
-
Constructor Details
-
ScoreSortBuilder
public ScoreSortBuilder()Build a ScoreSortBuilder default to descending sort order. -
ScoreSortBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Throws:
java.io.IOException
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Throws:
java.io.IOException
-
fromXContent
public static ScoreSortBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser, java.lang.String fieldName)- Parameters:
parser
- the input parser. The state on the parser contained in this context will be changed as a side effect of this method callfieldName
- in some sort syntax variations the field name precedes the xContent object that specifies further parameters, e.g. in '{ "foo": { "order" : "asc"} }'. When parsing the inner object, the field name can be passed in via this argument
-
build
Description copied from class:SortBuilder
Create a SortFieldAndFormat from this builder.- Specified by:
build
in classSortBuilder<ScoreSortBuilder>
-
buildBucketedSort
public BucketedSort buildBucketedSort(QueryShardContext context, int bucketSize, BucketedSort.ExtraData extra) throws java.io.IOExceptionDescription copied from class:SortBuilder
Create a BucketedSort which is useful for sorting inside of aggregations.- Specified by:
buildBucketedSort
in classSortBuilder<ScoreSortBuilder>
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object object)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object -
rewrite
Description copied from interface:Rewriteable
Rewrites this instance based on the provided context. The returned objects will be the same instance as this if no changes during the rewrite were applied.- Throws:
java.io.IOException
-