## Uses of Class
org.apache.lucene.facet.taxonomy.CategoryPath

Packages that use CategoryPath
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.
org.apache.lucene.facet.sortedset: Classes to perform faceting without a separate taxonomy index, using on SortedSetDocValuesField.
org.apache.lucene.facet.taxonomy: Taxonomy of Categories
org.apache.lucene.facet.taxonomy.directory: Taxonomy index implementation using on top of a Directory.
org.apache.lucene.facet.taxonomy.writercache: Improves indexing time by caching a map of CategoryPath to their Ordinal.
org.apache.lucene.facet.taxonomy.writercache.cl2o: Category->Ordinal caching implementation using an optimized data-structures
org.apache.lucene.facet.taxonomy.writercache.lru: An LRU cache implementation for the CategoryPath to Ordinal map

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

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

Methods in org.apache.lucene.facet.associations with parameters of type CategoryPath
`protected void` `AssociationsDrillDownStream.addAdditionalAttributes(CategoryPath cp, boolean isParent)`
`CategoryAssociation` `CategoryAssociationsContainer.getAssociation(CategoryPath category)` Returns the `CategoryAssociation` that was set for the `category`, or `null` if none was defined.
`void` `CategoryAssociationsContainer.setAssociation(CategoryPath category, CategoryAssociation association)` Adds the `CategoryAssociation` for the given `category`.

Method parameters in org.apache.lucene.facet.associations with type arguments of type CategoryPath
`void` `AssociationsFacetFields.addFields(Document doc, Iterable<CategoryPath> categories)`
`Map<String,BytesRef>` `AssociationsListBuilder.build(IntsRef ordinals, Iterable<CategoryPath> categories)`
`protected Map<CategoryListParams,Iterable<CategoryPath>>` `AssociationsFacetFields.createCategoryListMapping(Iterable<CategoryPath> categories)`
`protected Map<String,BytesRef>` `AssociationsFacetFields.getCategoryListData(CategoryListParams categoryListParams, IntsRef ordinals, Iterable<CategoryPath> categories)`
`protected DrillDownStream` `AssociationsFacetFields.getDrillDownStream(Iterable<CategoryPath> categories)`

Constructors in org.apache.lucene.facet.associations with parameters of type CategoryPath
`AssociationFloatSumFacetRequest(CategoryPath path, int num)` Create a float association facet request for a given node in the taxonomy.
`AssociationIntSumFacetRequest(CategoryPath path, int num)` Create an integer association facet request for a given node in the taxonomy.

Constructor parameters in org.apache.lucene.facet.associations with type arguments of type CategoryPath
`MultiAssociationsFacetsAggregator(Map<CategoryPath,FacetsAggregator> aggregators)` Creates a new `MultiAssociationsFacetsAggregator` over the given aggregators.

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

Methods in org.apache.lucene.facet.index that return types with arguments of type CategoryPath
`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 CategoryPath
`protected void` `DrillDownStream.addAdditionalAttributes(CategoryPath category, boolean isParent)`

Method parameters in org.apache.lucene.facet.index with type arguments of type CategoryPath
`void` `FacetFields.addFields(Document doc, Iterable<CategoryPath> categories)` Adds the needed facet fields to the document.
`Map<String,BytesRef>` `CountingListBuilder.build(IntsRef ordinals, Iterable<CategoryPath> categories)` Every returned `BytesRef` corresponds to a single partition (as defined by `FacetIndexingParams.getPartitionSize()`) and the key denotes the partition ID.
`Map<String,BytesRef>` `CategoryListBuilder.build(IntsRef ordinals, Iterable<CategoryPath> categories)` Returns the encoded ordinals data.
`protected Map<CategoryListParams,Iterable<CategoryPath>>` `FacetFields.createCategoryListMapping(Iterable<CategoryPath> categories)` Creates a mapping between a `CategoryListParams` and all `categories` that are associated with it.
`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.
`protected DrillDownStream` `FacetFields.getDrillDownStream(Iterable<CategoryPath> categories)` Returns a `DrillDownStream` for writing the categories drill-down terms.

Constructor parameters in org.apache.lucene.facet.index with type arguments of type CategoryPath
`DrillDownStream(Iterable<CategoryPath> categories, FacetIndexingParams indexingParams)`

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

Methods in org.apache.lucene.facet.params with parameters of type CategoryPath
`int` `FacetIndexingParams.drillDownTermText(CategoryPath path, char[] buffer)` Copies the text required to execute a drill-down query on the given category to the given `char[]`, and returns the number of characters that were written.
`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`.

Constructor parameters in org.apache.lucene.facet.params with type arguments of type CategoryPath
`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 CategoryPath in org.apache.lucene.facet.search

Fields in org.apache.lucene.facet.search declared as CategoryPath
`CategoryPath` `FacetRequest.categoryPath`
`CategoryPath` `FacetResultNode.label` The `label` of this result.

Methods in org.apache.lucene.facet.search with parameters of type CategoryPath
`void` `DrillDownQuery.add(CategoryPath... paths)` Adds one dimension of drill downs; if you pass multiple values they are OR'd, and then the entire dimension is AND'd against the base query.
`static Term` `DrillDownQuery.term(FacetIndexingParams iParams, CategoryPath path)` Return a drill-down `Term` for a category.

Constructors in org.apache.lucene.facet.search with parameters of type CategoryPath
`CountFacetRequest(CategoryPath path, int num)`
`FacetRequest(CategoryPath path, int numResults)` Initialize the request with a given path, and a requested number of facets results.
`SumScoreFacetRequest(CategoryPath path, int num)` Create a score facet request for a given node in the taxonomy.

Uses of CategoryPath in org.apache.lucene.facet.sortedset

Method parameters in org.apache.lucene.facet.sortedset with type arguments of type CategoryPath
`void` `SortedSetDocValuesFacetFields.addFields(Document doc, Iterable<CategoryPath> categories)`

Uses of CategoryPath in org.apache.lucene.facet.taxonomy

Fields in org.apache.lucene.facet.taxonomy declared as CategoryPath
`static CategoryPath` `CategoryPath.EMPTY` An empty `CategoryPath`

Methods in org.apache.lucene.facet.taxonomy that return CategoryPath
`abstract CategoryPath` `TaxonomyReader.getPath(int ordinal)` Returns the path name of the category with the given ordinal.
`CategoryPath` `CategoryPath.subpath(int length)` Returns a sub-path of this path up to `length` components.

Methods in org.apache.lucene.facet.taxonomy with parameters of type CategoryPath
`int` `TaxonomyWriter.addCategory(CategoryPath categoryPath)` addCategory() adds a category with a given path name to the taxonomy, and returns its ordinal.
`int` `CategoryPath.compareTo(CategoryPath other)` Compares this path with another `CategoryPath` for lexicographic order.
`abstract int` `TaxonomyReader.getOrdinal(CategoryPath categoryPath)` Returns the ordinal of the category given as a path.

Uses of CategoryPath in org.apache.lucene.facet.taxonomy.directory

Methods in org.apache.lucene.facet.taxonomy.directory that return CategoryPath
`CategoryPath` `DirectoryTaxonomyReader.getPath(int ordinal)`

Methods in org.apache.lucene.facet.taxonomy.directory with parameters of type CategoryPath
`int` `DirectoryTaxonomyWriter.addCategory(CategoryPath categoryPath)`
`protected int` `DirectoryTaxonomyWriter.findCategory(CategoryPath categoryPath)` Look up the given category in the cache and/or the on-disk storage, returning the category's ordinal, or a negative number in case the category does not yet exist in the taxonomy.
`int` `DirectoryTaxonomyReader.getOrdinal(CategoryPath cp)`

Uses of CategoryPath in org.apache.lucene.facet.taxonomy.writercache

Methods in org.apache.lucene.facet.taxonomy.writercache with parameters of type CategoryPath
`int` `TaxonomyWriterCache.get(CategoryPath categoryPath)` Lookup a category in the cache, returning its ordinal, or a negative number if the category is not in the cache.
`boolean` `TaxonomyWriterCache.put(CategoryPath categoryPath, int ordinal)` Add a category to the cache, with the given ordinal as the value.

Uses of CategoryPath in org.apache.lucene.facet.taxonomy.writercache.cl2o

Methods in org.apache.lucene.facet.taxonomy.writercache.cl2o with parameters of type CategoryPath
`abstract void` `LabelToOrdinal.addLabel(CategoryPath label, int ordinal)` Adds a new label if its not yet in the table.
`void` `CompactLabelToOrdinal.addLabel(CategoryPath label, int ordinal)`
`int` `CollisionMap.addLabel(CategoryPath label, int hash, int cid)`
`int` `Cl2oTaxonomyWriterCache.get(CategoryPath categoryPath)`
`int` `CollisionMap.get(CategoryPath label, int hash)`
`abstract int` `LabelToOrdinal.getOrdinal(CategoryPath label)`
`int` `CompactLabelToOrdinal.getOrdinal(CategoryPath label)`
`boolean` `Cl2oTaxonomyWriterCache.put(CategoryPath categoryPath, int ordinal)`

Uses of CategoryPath in org.apache.lucene.facet.taxonomy.writercache.lru

Methods in org.apache.lucene.facet.taxonomy.writercache.lru with parameters of type CategoryPath
`int` `LruTaxonomyWriterCache.get(CategoryPath categoryPath)`
`boolean` `LruTaxonomyWriterCache.put(CategoryPath categoryPath, int ordinal)`

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