java.lang.Object
- org.apache.lucene.search.DocIdSetIterator
- - org.apache.lucene.index.DocValuesIterator
  - - org.apache.lucene.index.BinaryDocValues
    - - org.apache.lucene.index.SortedDocValues
      - org.apache.lucene.index.SortedDocValuesWriter.BufferedSortedDocValues

Enclosing class:: SortedDocValuesWriter

private static class SortedDocValuesWriter.BufferedSortedDocValues
extends SortedDocValues

Field Summary

Fields
Modifier and Type	Field	Description
`(package private) DocIdSetIterator`	`docsWithField`
`(package private) BytesRefHash`	`hash`
`(package private) PackedLongValues.Iterator`	`iter`
`private int`	`ord`
`(package private) int[]`	`ordMap`
`(package private) BytesRef`	`scratch`
`(package private) int[]`	`sortedValues`
`(package private) int`	`valueCount`

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

Constructor Summary

Constructors
Constructor	Description
`BufferedSortedDocValues(BytesRefHash hash, int valueCount, PackedLongValues docToOrd, int[] sortedValues, int[] ordMap, DocIdSetIterator docsWithField)`

Method Summary

All Methods Instance Methods Concrete Methods
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`	`getValueCount()`	Returns the number of unique values.
`BytesRef`	`lookupOrd(int ord)`	Retrieves the value for the specified ordinal.
`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.
`int`	`ordValue()`	Returns the ordinal for the current docID.

Methods inherited from class org.apache.lucene.index.SortedDocValues
binaryValue, intersect, lookupTerm, termsEnum

Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - hash
```
final BytesRefHash hash
```
  - scratch
```
final BytesRef scratch
```
  - sortedValues
```
final int[] sortedValues
```
  - ordMap
```
final int[] ordMap
```
  - valueCount
```
final int valueCount
```
  - ord
```
private int ord
```
  - iter
```
final PackedLongValues.Iterator iter
```
  - docsWithField
```
final DocIdSetIterator docsWithField
```
- Constructor Detail
  - BufferedSortedDocValues
```
public BufferedSortedDocValues(BytesRefHash hash,
                               int valueCount,
                               PackedLongValues docToOrd,
                               int[] sortedValues,
                               int[] ordMap,
                               DocIdSetIterator docsWithField)
```
- Method Detail
  - 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 java.io.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:
    
    java.io.IOException
  - advance
```
public int advance(int target)
```
    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
  - advanceExact
```
public boolean advanceExact(int target)
                     throws java.io.IOException
```
    Description copied from class: DocValuesIterator
    
    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.
    
    Specified by:
    
    advanceExact in class DocValuesIterator
    
    Throws:
    
    java.io.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
  - ordValue
```
public int ordValue()
```
    Description copied from class: SortedDocValues
    
    Returns the ordinal for the current docID. It is illegal to call this method after DocValuesIterator.advanceExact(int) returned false.
    
    Specified by:
    
    ordValue in class SortedDocValues
    
    Returns:
    
    ordinal for the document: this is dense, starts at 0, then increments by 1 for the next value in sorted order.
  - lookupOrd
```
public BytesRef lookupOrd(int ord)
```
    Description copied from class: SortedDocValues
    
    Retrieves the value for the specified ordinal. The returned BytesRef may be re-used across calls to SortedDocValues.lookupOrd(int) so make sure to copy it if you want to keep it around.
    
    Specified by:
    
    lookupOrd in class SortedDocValues
    
    Parameters:
    
    ord - ordinal to lookup (must be >= 0 and < SortedDocValues.getValueCount())
    
    See Also:
    
    SortedDocValues.ordValue()
  - getValueCount
```
public int getValueCount()
```
    Description copied from class: SortedDocValues
    
    Returns the number of unique values.
    
    Specified by:
    
    getValueCount in class SortedDocValues
    
    Returns:
    
    number of unique values in this SortedDocValues. This is also equivalent to one plus the maximum ordinal.

Class SortedDocValuesWriter.BufferedSortedDocValues

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.lucene.index.SortedDocValues

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

Methods inherited from class java.lang.Object

Field Detail

hash

scratch

sortedValues

ordMap

valueCount

ord

iter

docsWithField

Constructor Detail

BufferedSortedDocValues

Method Detail

docID

nextDoc

advance

advanceExact

cost

ordValue

lookupOrd

getValueCount