FacetOptions (Google App Engine API for Java)


Class FacetOptions

  • java.lang.Object
    • com.google.appengine.api.search.FacetOptions

  • public final class FacetOptions
    extends java.lang.Object
    A FacetOptions represents facet options such as the number of facets to discover (discoveryLimit), the number of values to be included in each discovered facet (discoveryValueLimit), and the depth of the results to check (depth). Note that discovery is disabled when discoveryLimit is zero.

    For example, to discover 10 facets with 5 values each over 1000 extended results:

       FacetOptions facetOption = FacetOptions.newBuilder()

    • Method Detail

      • getDiscoveryLimit

        public java.lang.Integer getDiscoveryLimit()
        Returns the number of facets to be discovered or null if unset.
      • getDiscoveryValueLimit

        public java.lang.Integer getDiscoveryValueLimit()
        Returns the maximum number of values for each discovered facet or null if unset.
      • getDepth

        public java.lang.Integer getDepth()
        Returns the number of documents from the search result to be analyzed for facet discovery or null if unset.
      • newBuilder

        public static FacetOptions.Builder newBuilder(FacetOptions options)
        Creates and returns a FacetOptions.Builder that reflects the given options.
        options - the options that the returned builder will reflect.
        a new builder with values set from the given options.
      • toString

        public java.lang.String toString()
        toString in class java.lang.Object