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

Class BucketBasedJsonFacet

  • public class BucketBasedJsonFacet
extends Object
    Represents the top-level response for a bucket-based JSON facet (i.e. "terms" or "range") Allows access to JSON like: 
       {
     "numBuckets": 2,
     "buckets": [
       {...},
       {...}
     ]
   }

    Allows access to all top-level "terms" and "range" response properties (e.g. allBuckets, numBuckets, before, etc.)

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int UNSET_FLAG  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      int getAfter()
      Deprecated.
      this method can trigger ClassCastException's if the returned value is a long.
      long getAfterCount()
      The count of all records whose field value follows the end of this "range" facet This value is only present if the user has specifically requested it with the other option.
      long getAllBuckets()
      The sum cardinality of all buckets in the "terms" facet.
      int getBefore()
      Deprecated.
      this method can trigger ClassCastException's if the returned value is a long.
      long getBeforeCount()
      The count of all records whose field value precedes the start of this "range" facet This value is only present if the user has specifically requested it with the other option.
      int getBetween()
      Deprecated.
      this method can trigger ClassCastException's if the returned value is a long.
      long getBetweenCount()
      The count of all records whose field value falls between start and end.
      List<BucketJsonFacet> getBuckets()
      Retrieves the facet buckets returned by the server.
      int getNumBuckets()
      Deprecated.
      this method can trigger ClassCastException's if the returned value is a long.
      long getNumBucketsCount()
      The total number of buckets found in the domain (of which the returned buckets are only a part).

    • Constructor Detail

      • BucketBasedJsonFacet

        public BucketBasedJsonFacet​(NamedList<Object> bucketBasedFacet)

    • Method Detail

      • getBuckets

        public List<BucketJsonFacet> getBuckets()
        Retrieves the facet buckets returned by the server.

      • getNumBuckets

        public int getNumBuckets()
        Deprecated.
        this method can trigger ClassCastException's if the returned value is a long. In the future it will return a 'long' instead to avoid this problem. Until then, use getNumBucketsCount() instead.
        The total number of buckets found in the domain (of which the returned buckets are only a part). This value can only be computed on "terms" facets where the user has specifically requested it with the numBuckets option. UNSET_FLAG is returned if this is a "range" facet or numBuckets computation was not requested in the intiial request.

      • getNumBucketsCount

        public long getNumBucketsCount()
        The total number of buckets found in the domain (of which the returned buckets are only a part). This value can only be computed on "terms" facets where the user has specifically requested it with the numBuckets option. UNSET_FLAG is returned if this is a "range" facet or numBuckets computation was not requested in the intiial request.

      • getAllBuckets

        public long getAllBuckets()
        The sum cardinality of all buckets in the "terms" facet. Note that for facets on multi-valued fields, documents may belong to multiple buckets, making getAllBuckets() return a result greater than the number of documents in the domain.

        This value is only present if the user has specifically requested it with the allBuckets option. UNSET_FLAG is returned if this is not the case.

      • getBefore

        public int getBefore()
        Deprecated.
        this method can trigger ClassCastException's if the returned value is a long. In the future it will return a 'long' instead to avoid this problem. Until then, use getBeforeCount() instead.
        The count of all records whose field value precedes the start of this "range" facet This value is only present if the user has specifically requested it with the other option. UNSET_FLAG is returned if this is not the case.

      • getBeforeCount

        public long getBeforeCount()
        The count of all records whose field value precedes the start of this "range" facet This value is only present if the user has specifically requested it with the other option. UNSET_FLAG is returned if this is not the case.

      • getAfter

        public int getAfter()
        Deprecated.
        this method can trigger ClassCastException's if the returned value is a long. In the future it will return a 'long' instead to avoid this problem. Until then, use getAfterCount() instead.
        The count of all records whose field value follows the end of this "range" facet This value is only present if the user has specifically requested it with the other option. UNSET_FLAG is returned if this is not the case.

      • getAfterCount

        public long getAfterCount()
        The count of all records whose field value follows the end of this "range" facet This value is only present if the user has specifically requested it with the other option. UNSET_FLAG is returned if this is not the case.

      • getBetween

        public int getBetween()
        Deprecated.
        this method can trigger ClassCastException's if the returned value is a long. In the future it will return a 'long' instead to avoid this problem. Until then, use getBetweenCount() instead.
        The count of all records whose field value falls between start and end. This value is only present if the user has specifically requested it with the other option. UNSET_FLAG is returned if this is not the case.

      • getBetweenCount

        public long getBetweenCount()
        The count of all records whose field value falls between start and end. This value is only present if the user has specifically requested it with the other option. UNSET_FLAG is returned if this is not the case.