Package co.elasticsearch.enterprisesearch.client.model.request.search.facet

Class SearchRangeFacet

  • All Implemented Interfaces:
    Facet
    public class SearchRangeFacet
extends Object
implements Facet
    Represents a Search Facet on a range

    • Constructor Detail

      • SearchRangeFacet

        public SearchRangeFacet()
        Create an empty range facet

      • SearchRangeFacet

        public SearchRangeFacet​(String fieldName)
        Create a range facet with a name and empty range
        Parameters:
        fieldName - The name of the field to facet on

    • Method Detail

      • getType

        public FacetType getType()
        Description copied from interface: Facet
        Type of facet
        Specified by:
        getType in interface Facet
        Returns:
        The facet type

      • center

        public BigDecimal[] center()
        In the case of a Geolocation facet range, this is the center point of the range
        Returns:
        An array containing [longitude,latitude] of the center point

      • getFieldName

        public String getFieldName()
        The field name of the facet
        Specified by:
        getFieldName in interface Facet
        Returns:
        the field name

      • getName

        public String getName()
        Name given to facet
        Specified by:
        getName in interface Facet
        Returns:
        the name

      • getCenter

        public Geolocation getCenter()
        The mode of the distribution, specified as a latitude-longitude pair
        Returns:
        the center

      • getUnit

        public Geolocation.Unit getUnit()
        The base unit of measurement
        Returns:
        the unit

      • getRanges

        public List<Range> getRanges()
        An array of range objects
        Returns:
        The ranges

      • setFieldName

        public SearchRangeFacet setFieldName​(String fieldName)
        The field name of the facet
        Specified by:
        setFieldName in interface Facet
        Parameters:
        fieldName - the field name
        Returns:
        this.

      • setName

        public SearchRangeFacet setName​(String name)
        Name given to facet
        Parameters:
        name - The name
        Returns:
        this.

      • setCenter

        public SearchRangeFacet setCenter​(Geolocation center)
        The mode of the distribution, specified as a latitude-longitude pair
        Parameters:
        center - the center
        Returns:
        this.

      • setRanges

        public SearchRangeFacet setRanges​(List<Range> ranges)
        An array of range objects
        Parameters:
        ranges - The ranges
        Returns:
        this.

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object