|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.facet.search.params.FacetSearchParams
public class FacetSearchParams
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.
Field Summary | |
---|---|
protected List<FacetRequest> |
facetRequests
|
protected FacetIndexingParams |
indexingParams
|
Constructor Summary | |
---|---|
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 | |
---|---|
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 |
---|
protected final FacetIndexingParams indexingParams
protected final List<FacetRequest> facetRequests
Constructor Detail |
---|
public FacetSearchParams(FacetRequest... facetRequests)
requests
and default
FacetIndexingParams.ALL_PARENTS
. If you used a different
FacetIndexingParams
, you should use
FacetSearchParams(List, FacetIndexingParams)
.
public FacetSearchParams(List<FacetRequest> facetRequests)
requests
and default
FacetIndexingParams.ALL_PARENTS
. If you used a different
FacetIndexingParams
, you should use
FacetSearchParams(List, FacetIndexingParams)
.
public FacetSearchParams(List<FacetRequest> facetRequests, FacetIndexingParams indexingParams)
requests
and
FacetIndexingParams
.
Method Detail |
---|
public CategoryListCache getCategoryListCache()
CategoryListCache
. By default returns null
, you
should override if you want to use a cache.
public FacetIndexingParams getFacetIndexingParams()
FacetIndexingParams
that were passed to the
constructor.
public List<FacetRequest> getFacetRequests()
facet requests
that were passed to
the constructor.
public String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |