ddf.catalog.operation.faceting

Class FacetProperties

java.lang.Object

ddf.catalog.operation.faceting.FacetProperties

All Implemented Interfaces:

Serializable

public class FacetProperties
extends Object
implements Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FacetProperties.SortFacetsBy

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FACET_LIMIT
static int	DEFAULT_MIN_FACET_COUNT
static FacetProperties.SortFacetsBy	DEFAULT_SORT_KEY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Set<String>	getFacetAttributes()
int	getFacetLimit()
int	getMinFacetCount()
FacetProperties.SortFacetsBy	getSortKey()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FACET_LIMIT

public static final int DEFAULT_FACET_LIMIT

See Also:

Constant Field Values

DEFAULT_MIN_FACET_COUNT

public static final int DEFAULT_MIN_FACET_COUNT

See Also:

Constant Field Values

DEFAULT_SORT_KEY

public static final FacetProperties.SortFacetsBy DEFAULT_SORT_KEY

Constructor Detail

FacetProperties

public FacetProperties(Set<String> facetAttributes)

Creates a FacetProperties object using default parameters to facet on the provided attributes.

Parameters:

facetAttributes - A set of attributes to facet on

FacetProperties

public FacetProperties(Set<String> facetAttributes,
                       FacetProperties.SortFacetsBy sortKey)

Creates a FacetProperties 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

FacetProperties

public FacetProperties(Set<String> facetAttributes,
                       FacetProperties.SortFacetsBy sortKey,
                       int facetLimit,
                       int minFacetCount)

Creates a FacetProperties 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 Detail

getFacetAttributes

public Set<String> getFacetAttributes()

getSortKey

public FacetProperties.SortFacetsBy getSortKey()

getFacetLimit

public int getFacetLimit()

getMinFacetCount

public int getMinFacetCount()