Interface TermFacetResult

All Superinterfaces:
FacetResult

public interface TermFacetResult extends FacetResult
TermFacetResult
Example to create an instance using the builder pattern

     TermFacetResult termFacetResult = TermFacetResult.builder()
             .dataType(TermFacetResultType.TEXT)
             .missing(0.3)
             .total(0.3)
             .other(0.3)
             .plusTerms(termsBuilder -> termsBuilder)
             .build()
 
  • Field Details

  • Method Details

    • getDataType

      @NotNull @NotNull TermFacetResultType getDataType()
      Returns:
      dataType
    • getMissing

      @NotNull @NotNull Long getMissing()
      Returns:
      missing
    • getTotal

      @NotNull @NotNull Long getTotal()
      Returns:
      total
    • getOther

      @NotNull @NotNull Long getOther()
      Returns:
      other
    • getTerms

      @NotNull @Valid @NotNull @Valid List<FacetTerm> getTerms()
      Returns:
      terms
    • setDataType

      void setDataType(TermFacetResultType dataType)
      set dataType
      Parameters:
      dataType - value to be set
    • setMissing

      void setMissing(Long missing)
      set missing
      Parameters:
      missing - value to be set
    • setTotal

      void setTotal(Long total)
      set total
      Parameters:
      total - value to be set
    • setOther

      void setOther(Long other)
      set other
      Parameters:
      other - value to be set
    • setTerms

      void setTerms(FacetTerm... terms)
      set terms
      Parameters:
      terms - values to be set
    • setTerms

      void setTerms(List<FacetTerm> terms)
      set terms
      Parameters:
      terms - values to be set
    • of

      static TermFacetResult of()
      factory method
      Returns:
      instance of TermFacetResult
    • of

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

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

      static TermFacetResultBuilder builder()
      builder factory method for TermFacetResult
      Returns:
      builder
    • builder

      static TermFacetResultBuilder builder(TermFacetResult template)
      create builder for TermFacetResult instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder
    • withTermFacetResult

      default <T> T withTermFacetResult(Function<TermFacetResult,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<TermFacetResult> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference