Module org.elasticsearch.server

Package org.elasticsearch.search

Class SearchSortValues

java.lang.Object

org.elasticsearch.search.SearchSortValues

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public class SearchSortValues
extends Object
implements ToXContentFragment, Writeable

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 inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SearchSortValues(Object[] rawSortValues, DocValueFormat[] sortValueFormats)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static SearchSortValues	fromFormattedAndRaw(Object[] formattedSortValues, Object[] rawSortValues)	Build sort values from pre-formatted and raw arrays.
Object[]	getFormattedSortValues()	Returns the formatted version of the values that sorting was performed against
Object[]	getRawSortValues()	Returns the raw version of the values that sorting was performed against
int	hashCode()
static SearchSortValues	readFrom(StreamInput in)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

SearchSortValues

public SearchSortValues(Object[] rawSortValues,
 DocValueFormat[] sortValueFormats)

Method Details

readFrom

public static SearchSortValues readFrom(StreamInput in)
                                 throws IOException

Throws:

IOException

fromFormattedAndRaw

public static SearchSortValues fromFormattedAndRaw(Object[] formattedSortValues,
 Object[] rawSortValues)

Build sort values from pre-formatted and raw arrays. Use this when the formatted values were produced with the correct per-field format (e.g. from a shard hit) and must not be re-formatted with a single format like RAW, which would fail for non-UTF-8 BytesRefs (e.g. version field).

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getFormattedSortValues

public Object[] getFormattedSortValues()

Returns the formatted version of the values that sorting was performed against

getRawSortValues

public Object[] getRawSortValues()

Returns the raw version of the values that sorting was performed against

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object