Package org.apache.solr.client.solrj.response.json

Class NestableJsonFacet

  • Direct Known Subclasses:
    BucketJsonFacet
    public class NestableJsonFacet
extends Object
    Represents the response to a "query" JSON facet. Relies on several other types to represent the variety of JSON facet responses. The parsing of these responses relies partially on the JSON property names. When naming your facets in your request, avoid choosing names that match existing values in the JSON faceting response schema, such as "count", "val", "minX", etc.

    • Constructor Detail

      • NestableJsonFacet

        public NestableJsonFacet​(NamedList<Object> facetNL)

    • Method Detail

      • getCount

        public long getCount()
        The number of records matching the domain of this facet.

      • getQueryFacet

        public NestableJsonFacet getQueryFacet​(String name)
        Retrieve a nested "query" facet by its name

      • getQueryFacetNames

        public Set<String> getQueryFacetNames()
        Returns:
        the names of any "query" facets that are direct descendants of the current facet

      • getBucketBasedFacets

        public BucketBasedJsonFacet getBucketBasedFacets​(String name)
        Retrieve a nested "terms" or "range" facet by its name.

      • getBucketBasedFacetNames

        public Set<String> getBucketBasedFacetNames()
        Returns:
        the names of any "terms" or "range" facets that are direct descendants of this facet

      • getStatFacetValue

        public Number getStatFacetValue​(String name)
        Deprecated.
        this method works only for numeric value stats, instead use getStatValue(String)
        Retrieve the value for a stat or agg facet with the provided name

      • getStatValue

        public Object getStatValue​(String name)
        Retrieve the value for a stat or agg with the provided name

      • getStatFacetNames

        public Set<String> getStatFacetNames()
        Deprecated.
        this method returns only stats names with numeric value, instead use getStatNames()
        Returns:
        the names of any stat or agg facets that are direct descendants of this facet

      • getStatNames

        public Set<String> getStatNames()
        Returns:
        the names of any stat or agg that are direct descendants of this facet

      • getHeatmapFacetByName

        public HeatmapJsonFacet getHeatmapFacetByName​(String name)
        Retrieve a "heatmap" facet by its name

      • getHeatmapFacetNames

        public Set<String> getHeatmapFacetNames()
        Returns:
        the names of any heatmap facets that are direct descendants of this facet

      • getKeysToSkip

        protected Set<String> getKeysToSkip()