Package ddf.catalog.operation.impl

Class TermFacetPropertiesImpl

java.lang.Object
ddf.catalog.operation.impl.TermFacetPropertiesImpl
All Implemented Interfaces:
ddf.catalog.operation.TermFacetProperties, Serializable
public class TermFacetPropertiesImpl extends Object implements ddf.catalog.operation.TermFacetProperties
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from interface ddf.catalog.operation.TermFacetProperties

    ddf.catalog.operation.TermFacetProperties.SortFacetsBy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_FACET_LIMIT
     
    static final int
    DEFAULT_MIN_FACET_COUNT
     
    static final ddf.catalog.operation.TermFacetProperties.SortFacetsBy
    DEFAULT_SORT_KEY
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    TermFacetPropertiesImpl(Set<String> facetAttributes)
    Creates a TermFacetPropertiesImpl object using default parameters to facet on the provided attributes.
    TermFacetPropertiesImpl(Set<String> facetAttributes, ddf.catalog.operation.TermFacetProperties.SortFacetsBy sortKey)
    Creates a TermFacetPropertiesImpl object using default parameters to facet on the provided attributes, returning results sorted by the provided key.
    TermFacetPropertiesImpl(Set<String> facetAttributes, ddf.catalog.operation.TermFacetProperties.SortFacetsBy sortKey, int facetLimit, int minFacetCount)
    Creates a TermFacetPropertiesImpl object using the supplied parameters to facet on the provided attributes, returning results sorted by the provided key.

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<String>
    getFacetAttributes()
     
    int
    getFacetLimit()
     
    int
    getMinFacetCount()
     
    ddf.catalog.operation.TermFacetProperties.SortFacetsBy
    getSortKey()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • DEFAULT_FACET_LIMIT

      public static final int DEFAULT_FACET_LIMIT
      See Also:

    • DEFAULT_MIN_FACET_COUNT

      public static final int DEFAULT_MIN_FACET_COUNT
      See Also:

    • DEFAULT_SORT_KEY

      public static final ddf.catalog.operation.TermFacetProperties.SortFacetsBy DEFAULT_SORT_KEY

  • Constructor Details

    • TermFacetPropertiesImpl

      public TermFacetPropertiesImpl(Set<String> facetAttributes)
      Creates a TermFacetPropertiesImpl object using default parameters to facet on the provided attributes.
      Parameters:
      facetAttributes - A set of attributes to facet on

    • TermFacetPropertiesImpl

      public TermFacetPropertiesImpl(Set<String> facetAttributes, ddf.catalog.operation.TermFacetProperties.SortFacetsBy sortKey)
      Creates a TermFacetPropertiesImpl object using default parameters to facet on the provided attributes, returning results sorted by the provided key. Valid sortKey values are INDEX and COUNT.
      Parameters:
      facetAttributes - A set of fields to facet on
      sortKey - The key used to sort results - INDEX or COUNT

    • TermFacetPropertiesImpl

      public TermFacetPropertiesImpl(Set<String> facetAttributes, ddf.catalog.operation.TermFacetProperties.SortFacetsBy sortKey, int facetLimit, int minFacetCount)
      Creates a TermFacetPropertiesImpl object using the supplied parameters to facet on the provided attributes, returning results sorted by the provided key.
      Parameters:
      facetAttributes - A set of fields to facet on
      sortKey - The key used to sort results - INDEX or COUNT
      facetLimit - The maximum number of returned facet values (Default is 100)
      minFacetCount - The minimum count required for a facet value to be included in results (Default is 0)

  • Method Details

    • getFacetAttributes

      public Set<String> getFacetAttributes()
      Specified by:
      getFacetAttributes in interface ddf.catalog.operation.TermFacetProperties

    • getSortKey

      public ddf.catalog.operation.TermFacetProperties.SortFacetsBy getSortKey()
      Specified by:
      getSortKey in interface ddf.catalog.operation.TermFacetProperties

    • getFacetLimit

      public int getFacetLimit()
      Specified by:
      getFacetLimit in interface ddf.catalog.operation.TermFacetProperties

    • getMinFacetCount

      public int getMinFacetCount()
      Specified by:
      getMinFacetCount in interface ddf.catalog.operation.TermFacetProperties