FilterSortedSetDocValues (Lucene 10.5.0 core API)
Description: declaration: package: org.apache.lucene.index, class: FilterSortedSetDocValues

Package org.apache.lucene.index

# Class FilterSortedSetDocValues

java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.SortedSetDocValues
org.apache.lucene.index.FilterSortedSetDocValues

public class FilterSortedSetDocValues extends SortedSetDocValues
Delegates all methods to a wrapped `SortedSetDocValues`.

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `protected final SortedSetDocValues`
  `in`
  Wrapped values

  ### Fields inherited from class org.apache.lucene.search.DocIdSetIterator

  `NO_MORE_DOCS`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `FilterSortedSetDocValues(SortedSetDocValues in)`
  Initializes delegate

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `advance(int target)`
  Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.
  `boolean`
  `advanceExact(int target)`
  Advance the iterator to exactly `target` and return whether `target` has a value.
  `long`
  `cost()`
  Returns the estimated cost of this `DocIdSetIterator`.
  `int`
  `docID()`
  Returns the following: `-1` if `DocIdSetIterator.nextDoc()` or `DocIdSetIterator.advance(int)` were not called yet.
  `int`
  `docValueCount()`
  Retrieves the number of unique ords for the current document.
  `long`
  `getValueCount()`
  Returns the number of unique values.
  `TermsEnum`
  `intersect(CompiledAutomaton automaton)`
  Returns a `TermsEnum` over the values, filtered by a `CompiledAutomaton` The enum supports `TermsEnum.ord()`.
  `BytesRef`
  `lookupOrd(long ord)`
  Retrieves the value for the specified ordinal.
  `long`
  `lookupTerm(BytesRef key)`
  If `key` exists, returns its ordinal, else returns `-insertionPoint-1`, like `Arrays.binarySearch`.
  `int`
  `nextDoc()`
  Advances to the next document in the set and returns the doc it is currently on, or `DocIdSetIterator.NO_MORE_DOCS` if there are no more docs in the set.
  NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
  `long`
  `nextOrd()`
  Returns the next ordinal for the current document.
  `TermsEnum`
  `termsEnum()`
  Returns a `TermsEnum` over the values.

  ### Methods inherited from class org.apache.lucene.search.DocIdSetIterator

  `all, docIDRunEnd, empty, intoBitSet, range, slowAdvance`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Field Details

  - ### in

    protected final SortedSetDocValues in
    Wrapped values

- ## Constructor Details

  - ### FilterSortedSetDocValues

    public FilterSortedSetDocValues(SortedSetDocValues in)
    Initializes delegate

- ## Method Details

  - ### advanceExact

    public boolean advanceExact(int target) throws IOException
    Advance the iterator to exactly `target` and return whether `target` has a value. `target` must be greater than or equal to the current `doc ID` and must be a valid doc ID, ie. ≥ 0 and < `maxDoc`. After this method returns, `DocIdSetIterator.docID()` returns `target`.

    Note: it is illegal to call `DocIdSetIterator.intoBitSet(int, org.apache.lucene.util.FixedBitSet, int)` or `DocIdSetIterator.docIDRunEnd()` when this method returns false.

    Throws:
      `IOException`

  - ### nextOrd

    public long nextOrd() throws IOException
    Description copied from class: `SortedSetDocValues`
    Returns the next ordinal for the current document. It is illegal to call this method after `advanceExact(int)` returned `false`. It is illegal to call this more than `SortedSetDocValues.docValueCount()` times for the currently-positioned doc.
    Specified by:
      `nextOrd` in class `SortedSetDocValues`
    Returns:
      next ordinal for the document. ordinals are dense, start at 0, then increment by 1 for the next value in sorted order.
    Throws:
      `IOException`

  - ### docValueCount

    public int docValueCount()
    Description copied from class: `SortedSetDocValues`
    Retrieves the number of unique ords for the current document. This must always be greater than zero. It is illegal to call this method after `advanceExact(int)` returned `false`.
    Specified by:
      `docValueCount` in class `SortedSetDocValues`

  - ### lookupOrd

    public BytesRef lookupOrd(long ord) throws IOException
    Description copied from class: `SortedSetDocValues`
    Retrieves the value for the specified ordinal. The returned `BytesRef` may be re-used across calls to lookupOrd so make sure to `copy it` if you want to keep it around.
    Specified by:
      `lookupOrd` in class `SortedSetDocValues`
    Parameters:
      `ord` - ordinal to lookup
    Throws:
      `IOException`
    See Also:
      - `SortedSetDocValues.nextOrd()`

  - ### getValueCount

    public long getValueCount()
    Description copied from class: `SortedSetDocValues`
    Returns the number of unique values.
    Specified by:
      `getValueCount` in class `SortedSetDocValues`
    Returns:
      number of unique values in this SortedDocValues. This is also equivalent to one plus the maximum ordinal.

  - ### lookupTerm

    public long lookupTerm(BytesRef key) throws IOException
    Description copied from class: `SortedSetDocValues`
    If `key` exists, returns its ordinal, else returns `-insertionPoint-1`, like `Arrays.binarySearch`.
    Overrides:
      `lookupTerm` in class `SortedSetDocValues`
    Parameters:
      `key` - Key to look up
    Throws:
      `IOException`

  - ### termsEnum

    public TermsEnum termsEnum() throws IOException
    Description copied from class: `SortedSetDocValues`
    Returns a `TermsEnum` over the values. The enum supports `TermsEnum.ord()` and `TermsEnum.seekExact(long)`.
    Overrides:
      `termsEnum` in class `SortedSetDocValues`
    Throws:
      `IOException`

  - ### intersect

    public TermsEnum intersect(CompiledAutomaton automaton) throws IOException
    Description copied from class: `SortedSetDocValues`
    Returns a `TermsEnum` over the values, filtered by a `CompiledAutomaton` The enum supports `TermsEnum.ord()`.
    Overrides:
      `intersect` in class `SortedSetDocValues`
    Throws:
      `IOException`

  - ### docID

    public int docID()
    Description copied from class: `DocIdSetIterator`
    Returns the following:
    - `-1` if `DocIdSetIterator.nextDoc()` or `DocIdSetIterator.advance(int)` were not called yet.
    - `DocIdSetIterator.NO_MORE_DOCS` if the iterator has exhausted.
    - Otherwise it should return the doc ID it is currently on.
    Specified by:
      `docID` in class `DocIdSetIterator`

  - ### nextDoc

    public int nextDoc() throws IOException
    Description copied from class: `DocIdSetIterator`
    Advances to the next document in the set and returns the doc it is currently on, or `DocIdSetIterator.NO_MORE_DOCS` if there are no more docs in the set.
    NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
    Specified by:
      `nextDoc` in class `DocIdSetIterator`
    Throws:
      `IOException`

  - ### advance

    public int advance(int target) throws IOException
    Description copied from class: `DocIdSetIterator`
    Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returns `DocIdSetIterator.NO_MORE_DOCS` if target is greater than the highest document number in the set.

    The behavior of this method is undefined when called with `target ≤ current` , or after the iterator has exhausted. Both cases may result in unpredicted behavior.

    When `target > current` it behaves as if written:

         int advance(int target) {
           int doc;
           while ((doc = nextDoc()) < target) {
           }
           return doc;
         }

    Some implementations are considerably more efficient than that.

    NOTE: this method may be called with `DocIdSetIterator.NO_MORE_DOCS` for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

    Specified by:
      `advance` in class `DocIdSetIterator`
    Throws:
      `IOException`

  - ### cost

    public long cost()
    Description copied from class: `DocIdSetIterator`
    Returns the estimated cost of this `DocIdSetIterator`.

    This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.

    Specified by:
      `cost` in class `DocIdSetIterator`