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

- Packages that use FacetResult
  Package | Description
  --- | ---
  org.apache.lucene.facet | Faceted search.
  org.apache.lucene.facet.facetset | Provides FacetSets faceting capabilities which allows users to facet on high dimensional field values.
  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 | 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.
    `abstract FacetResult` | Facets.`getAllChildren​(String dim, String... path)` | Returns all child labels with non-zero counts under the specified path.
    `FacetResult` | LongValueFacetCounts.`getAllChildren​(String dim, String... path)` |
    `FacetResult` | MultiFacets.`getAllChildren​(String dim, String... path)` |
    `FacetResult` | StringValueFacetCounts.`getAllChildren​(String dim, String... path)` |
    `FacetResult` | LongValueFacetCounts.`getAllChildrenSortByValue()` | Returns all unique values seen, sorted by value.
    `abstract FacetResult` | Facets.`getTopChildren​(int topN, String dim, String... path)` | Returns the topN child labels under the specified path.
    `FacetResult` | LongValueFacetCounts.`getTopChildren​(int topN, String dim, String... path)` |
    `FacetResult` | MultiFacets.`getTopChildren​(int topN, String dim, String... path)` |
    `FacetResult` | StringValueFacetCounts.`getTopChildren​(int topN, String dim, String... path)` |
    `FacetResult` | LongValueFacetCounts.`getTopChildrenSortByCount​(int topN)` | Deprecated. Please use `LongValueFacetCounts.getTopChildren(int, String, String...)` instead for the same functionality.

    Methods in org.apache.lucene.facet that return types with arguments of type FacetResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `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>` | LongValueFacetCounts.`getAllDims​(int topN)` |
    `List<FacetResult>` | MultiFacets.`getAllDims​(int topN)` |
    `List<FacetResult>` | StringValueFacetCounts.`getAllDims​(int topN)` |
    `List<FacetResult>` | Facets.`getTopDims​(int topNDims, int topNChildren)` | Returns labels for topN dimensions and their topNChildren sorted by the number of hits/aggregated values that dimension matched.

    Methods in org.apache.lucene.facet with parameters of type FacetResult
    Modifier and Type | Method | 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.facetset

    Methods in org.apache.lucene.facet.facetset that return FacetResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `FacetResult` | MatchingFacetSetsCounts.`getAllChildren​(String dim, String... path)` |
    `FacetResult` | MatchingFacetSetsCounts.`getTopChildren​(int topN, String dim, String... path)` |

    Methods in org.apache.lucene.facet.facetset that return types with arguments of type FacetResult
    Modifier and Type | Method | Description
    --- | --- | ---
    `List<FacetResult>` | MatchingFacetSetsCounts.`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 | Description
    --- | --- | ---
    `FacetResult` | FloatTaxonomyFacets.`getAllChildren​(String dim, String... path)` | Deprecated.
    `FacetResult` | IntTaxonomyFacets.`getAllChildren​(String dim, String... path)` | Deprecated.
    `FacetResult` | FloatTaxonomyFacets.`getTopChildren​(int topN, String dim, String... path)` | Deprecated.
    `FacetResult` | IntTaxonomyFacets.`getTopChildren​(int topN, String dim, String... path)` | Deprecated.

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