Package com.commercetools.api.models.product

Interface FacetRange

All Known Subinterfaces:
FacetResultRange
public interface FacetRange
FacetRange
Example to create an instance using the builder pattern 

     FacetRange facetRange = FacetRange.builder()
             .from(0.3)
             .fromStr("{fromStr}")
             .to(0.3)
             .toStr("{toStr}")
             .count(0.3)
             .total(0.3)
             .min(0.3)
             .max(0.3)
             .mean(0.3)
             .build()

  • Method Details

    • getFrom

      @NotNull @NotNull Double getFrom()

      The range's lower endpoint.

      0 represents -∞.

      Returns:
      from

    • getFromStr

      @NotNull @NotNull String getFromStr()

      The range's lower endpoint.

      An empty string represents -∞.

      Returns:
      fromStr

    • getTo

      @NotNull @NotNull Double getTo()

      The range's upper endpoint.

      0 represents +∞.

      Returns:
      to

    • getToStr

      @NotNull @NotNull String getToStr()

      The range's upper endpoint.

      An empty string represents +∞.

      Returns:
      toStr

    • getCount

      @NotNull @NotNull Long getCount()

      Number of ProductVariants for which the values in a field fall into the specified range.

      Returns:
      count

    • getProductCount

      Long getProductCount()

      Number of Products for which the values in a field fall into the specified range.

      Present only if the counting products extension is enabled.

      Returns:
      productCount

    • getTotal

      @NotNull @NotNull Double getTotal()

      Sum of all values contained in the range.

      Returns:
      total

    • getMin

      @NotNull @NotNull Double getMin()

      Minimum value within the range.

      Returns:
      min

    • getMax

      @NotNull @NotNull Double getMax()

      Maximum value within the range.

      Returns:
      max

    • getMean

      @NotNull @NotNull Double getMean()

      Arithmetic mean of the values within the range.

      Returns:
      mean

    • setFrom

      void setFrom(Double from)

      The range's lower endpoint.

      0 represents -∞.

      Parameters:
      from - value to be set

    • setFromStr

      void setFromStr(String fromStr)

      The range's lower endpoint.

      An empty string represents -∞.

      Parameters:
      fromStr - value to be set

    • setTo

      void setTo(Double to)

      The range's upper endpoint.

      0 represents +∞.

      Parameters:
      to - value to be set

    • setToStr

      void setToStr(String toStr)

      The range's upper endpoint.

      An empty string represents +∞.

      Parameters:
      toStr - value to be set

    • setCount

      void setCount(Long count)

      Number of ProductVariants for which the values in a field fall into the specified range.

      Parameters:
      count - value to be set

    • setProductCount

      void setProductCount(Long productCount)

      Number of Products for which the values in a field fall into the specified range.

      Present only if the counting products extension is enabled.

      Parameters:
      productCount - value to be set

    • setTotal

      void setTotal(Double total)

      Sum of all values contained in the range.

      Parameters:
      total - value to be set

    • setMin

      void setMin(Double min)

      Minimum value within the range.

      Parameters:
      min - value to be set

    • setMax

      void setMax(Double max)

      Maximum value within the range.

      Parameters:
      max - value to be set

    • setMean

      void setMean(Double mean)

      Arithmetic mean of the values within the range.

      Parameters:
      mean - value to be set

    • of

      static FacetRange of()
      factory method
      Returns:
      instance of FacetRange

    • of

      static FacetRange of(FacetRange template)
      factory method to create a shallow copy FacetRange
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      FacetRange copyDeep()

    • deepCopy

      @Nullable static FacetRange deepCopy(@Nullable FacetRange template)
      factory method to create a deep copy of FacetRange
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static FacetRangeBuilder builder()
      builder factory method for FacetRange
      Returns:
      builder

    • builder

      static FacetRangeBuilder builder(FacetRange template)
      create builder for FacetRange instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withFacetRange

      default <T> T withFacetRange(Function<FacetRange,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<FacetRange> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference