Class FacetRequest

    • Constructor Detail

      • FacetRequest

        public FacetRequest()
    • Method Detail

      • parse

        public static FacetRequest parse​(SolrQueryRequest req,
                                         Map<String,​Object> params)
        Factory method to parse a facet request tree. The outer keys are arbitrary labels and their values are facet request specifications. Will throw a SolrException if it fails to parse.
        Parameters:
        req - the overall request
        params - a typed parameter structure (unlike SolrParams which are all string values).
      • parseOneFacetReq

        public static FacetRequest parseOneFacetReq​(SolrQueryRequest req,
                                                    Map<String,​Object> params)
        Factory method to parse out a rooted facet request tree that would normally go one level below a label. The params must contain a "type". This is intended to be useful externally, such as by SimpleFacets.
        Parameters:
        req - the overall request
        params - a typed parameter structure (unlike SolrParams which are all string values).
      • doRefine

        public boolean doRefine()
      • returnsPartial

        public boolean returnsPartial()
        Returns true if this facet can return just some of the facet buckets that match all the criteria. This is normally true only for facets with a limit.
      • canProduceFromEmpty

        public boolean canProduceFromEmpty()
        Returns true if this facet, or any sub-facets can produce results from an empty domain.
      • createFacetMerger

        public abstract FacetMerger createFacetMerger​(Object prototype)
      • getFacetDescription

        public abstract Map<String,​Object> getFacetDescription()