## Uses of Class
org.apache.lucene.facet.params.CategoryListParams

Packages that use CategoryListParams
org.apache.lucene.facet.associations: Allows associating arbitrary values with a category.
org.apache.lucene.facet.index: Facets indexing code.
org.apache.lucene.facet.params: Facets indexing and search parameters.
org.apache.lucene.facet.search: Facets search code.

Uses of CategoryListParams in org.apache.lucene.facet.associations

Methods in org.apache.lucene.facet.associations that return types with arguments of type CategoryListParams
`protected Map<CategoryListParams,Iterable<CategoryPath>>` `AssociationsFacetFields.createCategoryListMapping(Iterable<CategoryPath> categories)`

Methods in org.apache.lucene.facet.associations with parameters of type CategoryListParams
`void` `MultiAssociationsFacetsAggregator.aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
`void` `SumFloatAssociationFacetsAggregator.aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
`void` `SumIntAssociationFacetsAggregator.aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
`protected Map<String,BytesRef>` `AssociationsFacetFields.getCategoryListData(CategoryListParams categoryListParams, IntsRef ordinals, Iterable<CategoryPath> categories)`

Uses of CategoryListParams in org.apache.lucene.facet.index

Methods in org.apache.lucene.facet.index that return types with arguments of type CategoryListParams
`protected Map<CategoryListParams,Iterable<CategoryPath>>` `FacetFields.createCategoryListMapping(Iterable<CategoryPath> categories)` Creates a mapping between a `CategoryListParams` and all `categories` that are associated with it.

Methods in org.apache.lucene.facet.index with parameters of type CategoryListParams
`protected Map<String,BytesRef>` `FacetFields.getCategoryListData(CategoryListParams categoryListParams, IntsRef ordinals, Iterable<CategoryPath> categories)` Returns the category list data, as a mapping from key to `BytesRef` which includes the encoded data.

Constructors in org.apache.lucene.facet.index with parameters of type CategoryListParams
`CountingListBuilder(CategoryListParams categoryListParams, FacetIndexingParams indexingParams, TaxonomyWriter taxoWriter)`

Uses of CategoryListParams in org.apache.lucene.facet.params

Subclasses of CategoryListParams in org.apache.lucene.facet.params
`class` `PerDimensionOrdinalPolicy` A `CategoryListParams` which allow controlling the `CategoryListParams.OrdinalPolicy` used for each dimension.

Fields in org.apache.lucene.facet.params declared as CategoryListParams
`protected CategoryListParams` `FacetIndexingParams.clParams`
`protected static CategoryListParams` `FacetIndexingParams.DEFAULT_CATEGORY_LIST_PARAMS`

Methods in org.apache.lucene.facet.params that return CategoryListParams
`CategoryListParams` `PerDimensionIndexingParams.getCategoryListParams(CategoryPath category)` Returns the `CategoryListParams` for the corresponding dimension which is returned by `category.getComponent(0)`.
`CategoryListParams` `FacetIndexingParams.getCategoryListParams(CategoryPath category)` Returns the `CategoryListParams` for this `CategoryPath`.

Methods in org.apache.lucene.facet.params that return types with arguments of type CategoryListParams
`List<CategoryListParams>` `PerDimensionIndexingParams.getAllCategoryListParams()`
`List<CategoryListParams>` `FacetIndexingParams.getAllCategoryListParams()` Returns a list of all `categoryListParams` that are used for facets indexing.

Constructors in org.apache.lucene.facet.params with parameters of type CategoryListParams
`FacetIndexingParams(CategoryListParams categoryListParams)` Initializes new params with the given `CategoryListParams`.
`PerDimensionIndexingParams(Map<CategoryPath,CategoryListParams> paramsMap, CategoryListParams categoryListParams)` Same as `PerDimensionIndexingParams.PerDimensionIndexingParams(Map)`, only the given `CategoryListParams` will be used for any dimension that is not specified in the given mapping.

Constructor parameters in org.apache.lucene.facet.params with type arguments of type CategoryListParams
`PerDimensionIndexingParams(Map<CategoryPath,CategoryListParams> paramsMap)` Initializes a new instance with the given dimension-to-params mapping.
`PerDimensionIndexingParams(Map<CategoryPath,CategoryListParams> paramsMap, CategoryListParams categoryListParams)` Same as `PerDimensionIndexingParams.PerDimensionIndexingParams(Map)`, only the given `CategoryListParams` will be used for any dimension that is not specified in the given mapping.

Uses of CategoryListParams in org.apache.lucene.facet.search

Methods in org.apache.lucene.facet.search that return types with arguments of type CategoryListParams
`protected Set<CategoryListParams>` `FacetsAccumulator.getCategoryLists()`

Methods in org.apache.lucene.facet.search with parameters of type CategoryListParams
`void` `FastCountingFacetsAggregator.aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
`void` `CachedOrdsCountingFacetsAggregator.aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
`void` `PerCategoryListAggregator.aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
`void` `CountingFacetsAggregator.aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
`void` `FacetsAggregator.aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)` Aggregate the facets found in the given matching documents.
`void` `SumScoreFacetsAggregator.aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
`abstract void` `IntRollupFacetsAggregator.aggregate(FacetsCollector.MatchingDocs matchingDocs, CategoryListParams clp, FacetArrays facetArrays)`
`static OrdinalsCache.CachedOrds` `OrdinalsCache.getCachedOrds(AtomicReaderContext context, CategoryListParams clp)` Returns the `OrdinalsCache.CachedOrds` relevant to the given `AtomicReaderContext`, or `null` if there is no `BinaryDocValues` in this reader for the requested `field`.

Constructors in org.apache.lucene.facet.search with parameters of type CategoryListParams
`OrdinalsCache.CachedOrds(BinaryDocValues dv, int maxDoc, CategoryListParams clp)` Creates a new `OrdinalsCache.CachedOrds` from the `BinaryDocValues`.

Constructor parameters in org.apache.lucene.facet.search with type arguments of type CategoryListParams
`PerCategoryListAggregator(Map<CategoryListParams,FacetsAggregator> aggregators, FacetIndexingParams fip)`

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.