Module org.apache.lucene.facet

Package org.apache.lucene.facet.taxonomy

Class OrdinalMappingLeafReader.OrdinalMappingSortedNumericDocValues

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.DocValuesIterator

org.apache.lucene.index.SortedNumericDocValues

org.apache.lucene.index.FilterSortedNumericDocValues

org.apache.lucene.facet.taxonomy.OrdinalMappingLeafReader.OrdinalMappingSortedNumericDocValues

Enclosing class:

OrdinalMappingLeafReader

private class OrdinalMappingLeafReader.OrdinalMappingSortedNumericDocValues
extends FilterSortedNumericDocValues

Field Summary

Fields

Modifier and Type	Field	Description
private final IntArrayList	currentValues
private int	currIndex

Fields inherited from class org.apache.lucene.index.FilterSortedNumericDocValues

in

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

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor	Description
OrdinalMappingSortedNumericDocValues(SortedNumericDocValues in)

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.
int	docValueCount()	Retrieves the number of values for the current document.
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	nextValue()	Iterates to the next value in the current document.
private void	reloadValues()

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

cost, docID

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 Details

currentValues

private final IntArrayList currentValues

currIndex

private int currIndex

Constructor Details

OrdinalMappingSortedNumericDocValues

OrdinalMappingSortedNumericDocValues(SortedNumericDocValues in)

Method Details

advanceExact

public boolean advanceExact(int target)
                     throws 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.

Overrides:

advanceExact in class FilterSortedNumericDocValues

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.

Overrides:

advance in class FilterSortedNumericDocValues

Throws:

IOException

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.

Overrides:

nextDoc in class FilterSortedNumericDocValues

Throws:

IOException

docValueCount

public int docValueCount()

Description copied from class: SortedNumericDocValues

Retrieves the number of values for the current document. This must always be greater than zero. It is illegal to call this method after DocValuesIterator.advanceExact(int) returned false.

Overrides:

docValueCount in class FilterSortedNumericDocValues

reloadValues

private void reloadValues()
                   throws IOException

Throws:

IOException

nextValue

public long nextValue()

Description copied from class: SortedNumericDocValues

Iterates to the next value in the current document. Do not call this more than SortedNumericDocValues.docValueCount() times for the document.

Overrides:

nextValue in class FilterSortedNumericDocValues