Class SingletonSortedSetDocValues
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.index.DocValuesIterator
-
- org.apache.lucene.index.SortedSetDocValues
-
- org.apache.lucene.index.SingletonSortedSetDocValues
-
final class SingletonSortedSetDocValues extends SortedSetDocValues
Exposes multi-valued iterator view over a single-valued iterator.This can be used if you want to have one multi-valued implementation that works for single or multi-valued types.
-
-
Field Summary
Fields Modifier and Type Field Description private SortedDocValues
in
private long
ord
-
Fields inherited from class org.apache.lucene.index.SortedSetDocValues
NO_MORE_ORDS
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Constructor Description SingletonSortedSetDocValues(SortedDocValues in)
Creates a multi-valued view over the provided SortedDocValues
-
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 exactlytarget
and return whethertarget
has a value.long
cost()
Returns the estimated cost of thisDocIdSetIterator
.int
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.long
docValueCount()
Retrieves the number of values for the current document.SortedDocValues
getSortedDocValues()
Return the wrappedSortedDocValues
long
getValueCount()
Returns the number of unique values.BytesRef
lookupOrd(long ord)
Retrieves the value for the specified ordinal.long
lookupTerm(BytesRef key)
Ifkey
exists, returns its ordinal, else returns-insertionPoint-1
, likeArrays.binarySearch
.int
nextDoc()
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.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 aTermsEnum
over the values.-
Methods inherited from class org.apache.lucene.index.SortedSetDocValues
intersect
-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Field Detail
-
in
private final SortedDocValues in
-
ord
private long ord
-
-
Constructor Detail
-
SingletonSortedSetDocValues
public SingletonSortedSetDocValues(SortedDocValues in)
Creates a multi-valued view over the provided SortedDocValues
-
-
Method Detail
-
getSortedDocValues
public SortedDocValues getSortedDocValues()
Return the wrappedSortedDocValues
-
docID
public int docID()
Description copied from class:DocIdSetIterator
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.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 classDocIdSetIterator
-
nextOrd
public long nextOrd()
Description copied from class:SortedSetDocValues
Returns the next ordinal for the current document. It is illegal to call this method afterDocValuesIterator.advanceExact(int)
returnedfalse
.- Specified by:
nextOrd
in classSortedSetDocValues
- Returns:
- next ordinal for the document, or
SortedSetDocValues.NO_MORE_ORDS
. ordinals are dense, start at 0, then increment by 1 for the next value in sorted order.
-
docValueCount
public long docValueCount()
Description copied from class:SortedSetDocValues
Retrieves the number of values for the current document. This must always be greater than zero. It is illegal to call this method afterDocValuesIterator.advanceExact(int)
returnedfalse
.- Specified by:
docValueCount
in classSortedSetDocValues
-
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, orDocIdSetIterator.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 classDocIdSetIterator
- Throws:
java.io.IOException
-
advance
public int advance(int target) throws java.io.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 returnsDocIdSetIterator.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 classDocIdSetIterator
- Throws:
java.io.IOException
-
advanceExact
public boolean advanceExact(int target) throws java.io.IOException
Description copied from class:DocValuesIterator
Advance the iterator to exactlytarget
and return whethertarget
has a value.target
must be greater than or equal to the currentdoc ID
and must be a valid doc ID, ie. ≥ 0 and <maxDoc
. After this method returns,DocIdSetIterator.docID()
returnstarget
.- Specified by:
advanceExact
in classDocValuesIterator
- Throws:
java.io.IOException
-
lookupOrd
public BytesRef lookupOrd(long ord) throws java.io.IOException
Description copied from class:SortedSetDocValues
Retrieves the value for the specified ordinal. The returnedBytesRef
may be re-used across calls to lookupOrd so make sure tocopy it
if you want to keep it around.- Specified by:
lookupOrd
in classSortedSetDocValues
- Parameters:
ord
- ordinal to lookup- Throws:
java.io.IOException
- See Also:
SortedSetDocValues.nextOrd()
-
getValueCount
public long getValueCount()
Description copied from class:SortedSetDocValues
Returns the number of unique values.- Specified by:
getValueCount
in classSortedSetDocValues
- 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 java.io.IOException
Description copied from class:SortedSetDocValues
Ifkey
exists, returns its ordinal, else returns-insertionPoint-1
, likeArrays.binarySearch
.- Overrides:
lookupTerm
in classSortedSetDocValues
- Parameters:
key
- Key to look up- Throws:
java.io.IOException
-
termsEnum
public TermsEnum termsEnum() throws java.io.IOException
Description copied from class:SortedSetDocValues
Returns aTermsEnum
over the values. The enum supportsTermsEnum.ord()
andTermsEnum.seekExact(long)
.- Overrides:
termsEnum
in classSortedSetDocValues
- Throws:
java.io.IOException
-
cost
public long cost()
Description copied from class:DocIdSetIterator
Returns the estimated cost of thisDocIdSetIterator
.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 classDocIdSetIterator
-
-