## Uses of Class
org.apache.lucene.facet.FacetResult

- Packages that use FacetResult
  Package | Description
  --- | ---
  org.apache.lucene.facet | Faceted search.
  org.apache.lucene.facet.sortedset | Provides faceting capabilities over facets that were indexed with `SortedSetDocValuesFacetField`.
  org.apache.lucene.facet.taxonomy | Taxonomy of Categories.

- - ### Uses of FacetResult in org.apache.lucene.facet

    Methods in org.apache.lucene.facet that return FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `FacetResult` | RandomSamplingFacetsCollector.`amortizeFacetCounts(FacetResult res, FacetsConfig config, IndexSearcher searcher)` Note: if you use a counting `Facets` implementation, you can amortize the sampled counts by calling this method.
    `FacetResult` | LongValueFacetCounts.`getAllChildrenSortByValue()` Returns all unique values seen, sorted by value.
    `FacetResult` | LongValueFacetCounts.`getTopChildren(int topN, String dim, String... path)`
    `abstract FacetResult` | Facets.`getTopChildren(int topN, String dim, String... path)` Returns the topN child labels under the specified path.
    `FacetResult` | MultiFacets.`getTopChildren(int topN, String dim, String... path)`
    `FacetResult` | LongValueFacetCounts.`getTopChildrenSortByCount(int topN)` Returns the specified top number of facets, sorted by count.

    Methods in org.apache.lucene.facet that return types with arguments of type FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `List<FacetResult>` | LongValueFacetCounts.`getAllDims(int topN)`
    `abstract List<FacetResult>` | Facets.`getAllDims(int topN)` Returns topN labels for any dimension that had hits, sorted by the number of hits that dimension matched; this is used for "sparse" faceting, where many different dimensions were indexed, for example depending on the type of document.
    `List<FacetResult>` | MultiFacets.`getAllDims(int topN)`

    Methods in org.apache.lucene.facet with parameters of type FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `FacetResult` | RandomSamplingFacetsCollector.`amortizeFacetCounts(FacetResult res, FacetsConfig config, IndexSearcher searcher)` Note: if you use a counting `Facets` implementation, you can amortize the sampled counts by calling this method.

  - ### Uses of FacetResult in org.apache.lucene.facet.sortedset

    Methods in org.apache.lucene.facet.sortedset that return FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `FacetResult` | ConcurrentSortedSetDocValuesFacetCounts.`getTopChildren(int topN, String dim, String... path)`
    `FacetResult` | SortedSetDocValuesFacetCounts.`getTopChildren(int topN, String dim, String... path)`

    Methods in org.apache.lucene.facet.sortedset that return types with arguments of type FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `List<FacetResult>` | ConcurrentSortedSetDocValuesFacetCounts.`getAllDims(int topN)`
    `List<FacetResult>` | SortedSetDocValuesFacetCounts.`getAllDims(int topN)`

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

    Methods in org.apache.lucene.facet.taxonomy that return FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `FacetResult` | IntTaxonomyFacets.`getTopChildren(int topN, String dim, String... path)`
    `FacetResult` | FloatTaxonomyFacets.`getTopChildren(int topN, String dim, String... path)`

    Methods in org.apache.lucene.facet.taxonomy that return types with arguments of type FacetResult
    Modifier and Type | Method and Description
    --- | ---
    `List<FacetResult>` | TaxonomyFacets.`getAllDims(int topN)`

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