org.apache.lucene.facet.search.params

Class FacetSearchParams

java.lang.Object

org.apache.lucene.facet.search.params.FacetSearchParams

public class FacetSearchParams
extends Object

Defines parameters that are needed for faceted search. The list of facet requests denotes the facets for which aggregated should be done.

One can pass FacetIndexingParams in order to tell the search code how to read the facets information. Note that you must use the same FacetIndexingParams that were used for indexing.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<FacetRequest>	facetRequests
protected FacetIndexingParams	indexingParams

Constructor Summary

Constructors

Constructor and Description
FacetSearchParams(FacetRequest... facetRequests) Initializes with the given requests and default FacetIndexingParams.ALL_PARENTS.
FacetSearchParams(List<FacetRequest> facetRequests) Initializes with the given requests and default FacetIndexingParams.ALL_PARENTS.
FacetSearchParams(List<FacetRequest> facetRequests, FacetIndexingParams indexingParams) Initilizes with the given requests and FacetIndexingParams.

Method Summary

Methods

Modifier and Type	Method and Description
CategoryListCache	getCategoryListCache() Returns the CategoryListCache.
FacetIndexingParams	getFacetIndexingParams() Returns the FacetIndexingParams that were passed to the constructor.
List<FacetRequest>	getFacetRequests() Returns the list of facet requests that were passed to the constructor.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

indexingParams

protected final FacetIndexingParams indexingParams

facetRequests

protected final List<FacetRequest> facetRequests

Constructor Detail

FacetSearchParams

public FacetSearchParams(FacetRequest... facetRequests)

Initializes with the given requests and default FacetIndexingParams.ALL_PARENTS. If you used a different FacetIndexingParams, you should use FacetSearchParams(List, FacetIndexingParams).

FacetSearchParams

public FacetSearchParams(List<FacetRequest> facetRequests)

Initializes with the given requests and default FacetIndexingParams.ALL_PARENTS. If you used a different FacetIndexingParams, you should use FacetSearchParams(List, FacetIndexingParams).

FacetSearchParams

public FacetSearchParams(List<FacetRequest> facetRequests,
                 FacetIndexingParams indexingParams)

Initilizes with the given requests and FacetIndexingParams.

Method Detail

getCategoryListCache

public CategoryListCache getCategoryListCache()

Returns the CategoryListCache. By default returns null, you should override if you want to use a cache.

getFacetIndexingParams

public FacetIndexingParams getFacetIndexingParams()

Returns the FacetIndexingParams that were passed to the constructor.

getFacetRequests

public List<FacetRequest> getFacetRequests()

Returns the list of facet requests that were passed to the constructor.

toString

public String toString()

Overrides:

toString in class Object