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

- Packages that use FacetLabel
  Package | Description
  --- | ---
  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.

- - ### Uses of FacetLabel in org.apache.lucene.facet.taxonomy

    Methods in org.apache.lucene.facet.taxonomy that return FacetLabel
    Modifier and Type | Method and Description
    --- | ---
    `abstract FacetLabel` | TaxonomyReader.`getPath(int ordinal)` Returns the path name of the category with the given ordinal.
    `FacetLabel` | TaxonomyFacetLabels.FacetLabelReader.`nextFacetLabel(int docId)` Retrieves the next `FacetLabel` for the specified `docId`, or `null` if there are no more.
    `FacetLabel` | TaxonomyFacetLabels.FacetLabelReader.`nextFacetLabel(int docId, String facetDimension)` Retrieves the next `FacetLabel` for the specified `docId` under the requested `facetDimension`, or `null` if there are no more.
    `FacetLabel` | FacetLabel.`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 FacetLabel
    Modifier and Type | Method and Description
    --- | ---
    `int` | TaxonomyWriter.`addCategory(FacetLabel categoryPath)` addCategory() adds a category with a given path name to the taxonomy, and returns its ordinal.
    `int` | FacetLabel.`compareTo(FacetLabel other)` Compares this path with another `FacetLabel` for lexicographic order.
    `abstract int` | TaxonomyReader.`getOrdinal(FacetLabel categoryPath)` Returns the ordinal of the category given as a path.

  - ### Uses of FacetLabel in org.apache.lucene.facet.taxonomy.directory

    Methods in org.apache.lucene.facet.taxonomy.directory that return FacetLabel
    Modifier and Type | Method and Description
    --- | ---
    `FacetLabel` | DirectoryTaxonomyReader.`getPath(int ordinal)`

    Methods in org.apache.lucene.facet.taxonomy.directory with parameters of type FacetLabel
    Modifier and Type | Method and Description
    --- | ---
    `int` | DirectoryTaxonomyWriter.`addCategory(FacetLabel categoryPath)`
    `protected int` | DirectoryTaxonomyWriter.`findCategory(FacetLabel 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(FacetLabel cp)`

  - ### Uses of FacetLabel in org.apache.lucene.facet.taxonomy.writercache

    Methods in org.apache.lucene.facet.taxonomy.writercache with parameters of type FacetLabel
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | LabelToOrdinal.`addLabel(FacetLabel label, int ordinal)` Adds a new label if it is not yet in the table.
    `int` | UTF8TaxonomyWriterCache.`get(FacetLabel label)`
    `int` | TaxonomyWriterCache.`get(FacetLabel categoryPath)` Lookup a category in the cache, returning its ordinal, or a negative number if the category is not in the cache.
    `int` | LruTaxonomyWriterCache.`get(FacetLabel categoryPath)`
    `abstract int` | LabelToOrdinal.`getOrdinal(FacetLabel label)` Returns the ordinal assigned to the given label, or `LabelToOrdinal.INVALID_ORDINAL` if the label cannot be found in this table.
    `boolean` | UTF8TaxonomyWriterCache.`put(FacetLabel label, int ord)`
    `boolean` | TaxonomyWriterCache.`put(FacetLabel categoryPath, int ordinal)` Add a category to the cache, with the given ordinal as the value.
    `boolean` | LruTaxonomyWriterCache.`put(FacetLabel categoryPath, int ordinal)`

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