Package com.attivio.sdk.search.facet

Class FilterBasedFacetRequest

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.util.Map.Entry<java.lang.String,​Query>>
    public class FilterBasedFacetRequest
extends FacetRequest
implements java.lang.Iterable<java.util.Map.Entry<java.lang.String,​Query>>
    A FacetRequest whose buckets are defined by Queries.

    Each query that is added to this request will generate a hit count that would occur if this query were applied to the QueryRequest. This hit count will be the bucket count in the returned facet response.

    See Also:
    Serialized Form

    • Constructor Detail

      • FilterBasedFacetRequest

        public FilterBasedFacetRequest()

      • FilterBasedFacetRequest

        public FilterBasedFacetRequest​(java.lang.String name)

    • Method Detail

      • isFacetFinder

        public final boolean isFacetFinder()
        true if the facet finder can replace this FacetRequest with a suggested FacetRequest.

        This will replace a FacetRequest for a numeric field with a RangeFacetRequest when facet finder runs.

        Overrides:
        isFacetFinder in class FacetRequest

      • setFacetFinder

        public final void setFacetFinder​(boolean value)
        Set if FacetFinder is allowed to provide a suggestion for this FacetRequest.
        Overrides:
        setFacetFinder in class FacetRequest

      • getFilter

        public Query getFilter​(java.lang.String label)

      • getFilters

        public java.util.Map<java.lang.String,​Query> getFilters()

      • setFilters

        public void setFilters​(java.util.Map<java.lang.String,​Query> value)

      • add

        public void add​(java.lang.String label,
                Query filter)
        Request that a Bucket for filter will be returned.

      • iterator

        public java.util.Iterator<java.util.Map.Entry<java.lang.String,​Query>> iterator()
        Get an iterator over all filters.
        Specified by:
        iterator in interface java.lang.Iterable<java.util.Map.Entry<java.lang.String,​Query>>

      • filters

        public java.util.Collection<Query> filters()
        Get the filters for this FilterBasedFacetRequest.

      • addParameters

        protected int addParameters​(java.lang.StringBuilder buffer,
                            int index)
        Overrides:
        addParameters in class FacetRequest

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class FacetRequest

      • valueOf

        public static FacetRequest valueOf​(java.lang.String value)
        Parse a FacetRequest from a string.