Package org.elasticsearch.search.sort

Class FieldSortBuilder

    • Constructor Detail

      • FieldSortBuilder

        public FieldSortBuilder​(FieldSortBuilder template)
        Copy constructor.

      • FieldSortBuilder

        public FieldSortBuilder​(String fieldName)
        Constructs a new sort based on a document field.
        Parameters:
        fieldName - The field name.

    • Method Detail

      • getFieldName

        public String getFieldName()
        Returns the document field this sort should be based on.

      • missing

        public FieldSortBuilder missing​(Object missing)
        Sets the value when a field is missing in a doc. Can also be set to _last or _first to sort missing last or first respectively.

      • missing

        public Object missing()
        Returns the value used when a field is missing in a doc.

      • unmappedType

        public FieldSortBuilder unmappedType​(String type)
        Set the type to use in case the current field is not mapped in an index. Specifying a type tells Elasticsearch what type the sort values should have, which is important for cross-index search, if there are sort fields that exist on some indices only. If the unmapped type is null then query execution will fail if one or more indices don't have a mapping for the current field.

      • unmappedType

        public String unmappedType()
        Returns the type to use in case the current field is not mapped in an index.

      • sortMode

        public FieldSortBuilder sortMode​(SortMode sortMode)
        Defines what values to pick in the case a document contains multiple values for the targeted sort field. Possible values: min, max, sum and avg

        The last two values are only applicable for number based fields.

      • sortMode

        public SortMode sortMode()
        Returns what values to pick in the case a document contains multiple values for the targeted sort field.

      • setNestedSort

        public FieldSortBuilder setNestedSort​(NestedSortBuilder nestedSort)
        Sets the NestedSortBuilder to be used for fields that are inside a nested object. The NestedSortBuilder takes a `path` argument and an optional nested filter that the nested objects should match with in order to be taken into account for sorting.

      • getNumericType

        public String getNumericType()
        Returns the numeric type that values should translated to or null if the original numeric type should be preserved.

      • setNumericType

        public FieldSortBuilder setNumericType​(String numericType)
        Forces the numeric type to use for the field. The query will fail if this option is set on a field that is not mapped as a numeric in some indices. Specifying a numeric type tells Elasticsearch what type the sort values should have, which is important for cross-index search, if a field does not have the same type on all indices. Allowed values are long and double.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getWriteableName

        public String getWriteableName()
        Description copied from interface: NamedWriteable
        Returns the name of the writeable object

      • fromXContent

        public static FieldSortBuilder fromXContent​(XContentParser parser,
                                            String fieldName)
                                     throws IOException
        Creates a new FieldSortBuilder from the query held by the XContentParser in XContent format.
        Parameters:
        parser - the input parser. The state on the parser contained in this context will be changed as a side effect of this method call
        fieldName - 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
        Throws:
        IOException