LongTupleCursor (Lucene 10.5.0 core API)
Description: declaration: package: org.apache.lucene.document.column, class: LongTupleCursor

Package org.apache.lucene.document.column

# Class LongTupleCursor

java.lang.Object
org.apache.lucene.document.column.LongTupleCursor

public abstract class LongTupleCursor extends Object
A tuple cursor over a `LongColumn`. Yields `(docID, longValue)` pairs. Batch-local doc-ids are returned in non-decreasing order; the same doc-id may repeat for multi-valued fields (e.g. `SORTED_NUMERIC`).

WARNING: This API is experimental and might change in incompatible ways in the next release.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `LongTupleCursor()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `abstract long`
  `longValue()`
  Returns the value at the current cursor position.
  `abstract int`
  `nextDoc()`
  Advances to the next tuple and returns its doc-id, or `DocIdSetIterator.NO_MORE_DOCS` if exhausted.

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

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

- ## Constructor Details

  - ### LongTupleCursor

    public LongTupleCursor()

- ## Method Details

  - ### nextDoc

    public abstract int nextDoc()
    Advances to the next tuple and returns its doc-id, or `DocIdSetIterator.NO_MORE_DOCS` if exhausted.

    Returned doc-ids are batch-local (0 to `numDocs - 1`) and are emitted in non-decreasing order. The same doc-id may be returned multiple times when a document has multiple values.

  - ### longValue

    public abstract long longValue()
    Returns the value at the current cursor position. Only valid after a successful `nextDoc()` call that returned a value other than `DocIdSetIterator.NO_MORE_DOCS`.