## Uses of Class
org.apache.solr.handler.component.PivotFacetValue

- Packages that use PivotFacetValue
  Package | Description
  --- | ---
  org.apache.solr.handler.component | `SearchComponent` implementations for use in `SearchHandler`

- - ### Uses of PivotFacetValue in org.apache.solr.handler.component

    Fields in org.apache.solr.handler.component declared as PivotFacetValue
    Modifier and Type | Field and Description
    --- | ---
    `PivotFacetValue` | PivotFacetField.`parentValue`

    Methods in org.apache.solr.handler.component that return PivotFacetValue
    Modifier and Type | Method and Description
    --- | ---
    `static PivotFacetValue` | PivotFacetValue.`createFromNamedList(int shardNumber, ResponseBuilder rb, PivotFacetField parentField, NamedList<Object> pivotData)` A recursive method to construct a new `PivotFacetValue` object from the contents of the `NamedList` provided by the specified shard, relative to the specified field.
    `PivotFacetValue` | PivotFacetFieldValueCollection.`get(Comparable value)` Fast lookup to retrieve a `PivotFacetValue` from this collection if it exists
    `PivotFacetValue` | PivotFacetFieldValueCollection.`getAt(int index)` Fetchs a `PivotFacetValue` from this collection via the index, may not be used to fetch the `PivotFacetValue` corrisponding to the missing-value.
    `PivotFacetValue` | PivotFacetFieldValueCollection.`getMissingValue()` The `PivotFacetValue` with corisponding to a a value of `null` when `FacetParams.FACET_MISSING` is used.

    Methods in org.apache.solr.handler.component that return types with arguments of type PivotFacetValue
    Modifier and Type | Method and Description
    --- | ---
    `List<PivotFacetValue>` | PivotFacetFieldValueCollection.`getExplicitValuesList()` Read-Only access to the Collection of `PivotFacetValue`s corrisponding to non-missing values.
    `List<PivotFacetValue>` | PivotFacetFieldValueCollection.`getNextLevelValuesToRefine()` Returns the appropriate sub-list of the explicit values that need to be refined, based on the `FacetParams.FACET_OFFSET` & `FacetParams.FACET_LIMIT` for this field.
    `List<PivotFacetValue>` | PivotFacet.`getQueuedRefinements(int shardNumber)` An immutable List of the `PivotFacetValue`s that need to be refined for this pivot.
    `Iterator<PivotFacetValue>` | PivotFacetFieldValueCollection.`iterator()` Iterator over all elements in this Collection, including the result of `PivotFacetFieldValueCollection.getMissingValue()` as the last element (if it exists)

    Methods in org.apache.solr.handler.component with parameters of type PivotFacetValue
    Modifier and Type | Method and Description
    --- | ---
    `void` | PivotFacetFieldValueCollection.`add(PivotFacetValue pfValue)` Adds a `PivotFacetValue` to this collection -- callers must not use this method if a `PivotFacetValue` with the same value already exists in this collection
    `void` | PivotFacet.`addRefinement(int shardNumber, PivotFacetValue value)` Tracks that the specified shard needs to be asked to refine the specified `PivotFacetValue`
    `int` | PivotFacetFieldValueCollection.PivotFacetCountComparator.`compare(PivotFacetValue left, PivotFacetValue right)`
    `int` | PivotFacetFieldValueCollection.PivotFacetValueComparator.`compare(PivotFacetValue left, PivotFacetValue right)`
    `static PivotFacetField` | PivotFacetField.`createFromListOfNamedLists(int shardNumber, ResponseBuilder rb, PivotFacetValue owner, List<NamedList<Object>> pivotValues)` A recursive method to construct a new `PivotFacetField` object from the contents of the `NamedList`s provided by the specified shard, relative to a parent value (if this is not the top field in the pivot hierarchy) The associated child `PivotFacetValue`s will be recursively built as well.

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