Package org.apache.lucene.index
Class FilterSortedDocValues
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.SortedDocValues
org.apache.lucene.index.FilterSortedDocValues
Delegates all methods to a wrapped
SortedDocValues.-
Field Summary
FieldsFields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintadvance(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.booleanadvanceExact(int target) Advance the iterator to exactlytargetand return whethertargethas a value.longcost()Returns the estimated cost of thisDocIdSetIterator.intdocID()Returns the following:-1ifDocIdSetIterator.nextDoc()orDocIdSetIterator.advance(int)were not called yet.intReturns the number of unique values.intersect(CompiledAutomaton automaton) Returns aTermsEnumover the values, filtered by aCompiledAutomatonThe enum supportsTermsEnum.ord().lookupOrd(int ord) Retrieves the value for the specified ordinal.intlookupTerm(BytesRef key) Ifkeyexists, returns its ordinal, else returns-insertionPoint-1, likeArrays.binarySearch.intnextDoc()Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.NO_MORE_DOCSif 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.intordValue()Returns the ordinal for the current docID.Returns aTermsEnumover the values.Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, docIDRunEnd, empty, intoBitSet, range, slowAdvance
-
Field Details
-
in
Wrapped values
-
-
Constructor Details
-
FilterSortedDocValues
Sole constructor
-
-
Method Details
-
advanceExact
Advance the iterator to exactlytargetand return whethertargethas a value.targetmust be greater than or equal to the currentdoc IDand must be a valid doc ID, ie. ≥ 0 and <maxDoc. After this method returns,DocIdSetIterator.docID()returnstarget.- Throws:
IOException
-
ordValue
Description copied from class:SortedDocValuesReturns the ordinal for the current docID. It is illegal to call this method afteradvanceExact(int)returnedfalse.- Specified by:
ordValuein classSortedDocValues- Returns:
- ordinal for the document: this is dense, starts at 0, then increments by 1 for the next value in sorted order.
- Throws:
IOException
-
lookupOrd
Description copied from class:SortedDocValuesRetrieves the value for the specified ordinal. The returnedBytesRefmay be re-used across calls toSortedDocValues.lookupOrd(int)so make sure tocopy itif you want to keep it around.- Specified by:
lookupOrdin classSortedDocValues- Parameters:
ord- ordinal to lookup (must be >= 0 and <SortedDocValues.getValueCount())- Throws:
IOException- See Also:
-
getValueCount
public int getValueCount()Description copied from class:SortedDocValuesReturns the number of unique values.- Specified by:
getValueCountin classSortedDocValues- Returns:
- number of unique values in this SortedDocValues. This is also equivalent to one plus the maximum ordinal.
-
lookupTerm
Description copied from class:SortedDocValuesIfkeyexists, returns its ordinal, else returns-insertionPoint-1, likeArrays.binarySearch.- Overrides:
lookupTermin classSortedDocValues- Parameters:
key- Key to look up- Throws:
IOException
-
termsEnum
Description copied from class:SortedDocValuesReturns aTermsEnumover the values. The enum supportsTermsEnum.ord()andTermsEnum.seekExact(long).- Overrides:
termsEnumin classSortedDocValues- Throws:
IOException
-
intersect
Description copied from class:SortedDocValuesReturns aTermsEnumover the values, filtered by aCompiledAutomatonThe enum supportsTermsEnum.ord().- Overrides:
intersectin classSortedDocValues- Throws:
IOException
-
docID
public int docID()Description copied from class:DocIdSetIteratorReturns the following:-1ifDocIdSetIterator.nextDoc()orDocIdSetIterator.advance(int)were not called yet.DocIdSetIterator.NO_MORE_DOCSif the iterator has exhausted.- Otherwise it should return the doc ID it is currently on.
- Specified by:
docIDin classDocIdSetIterator
-
nextDoc
Description copied from class:DocIdSetIteratorAdvances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.NO_MORE_DOCSif 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:
nextDocin classDocIdSetIterator- Throws:
IOException
-
advance
Description copied from class:DocIdSetIteratorAdvances 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_DOCSif 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 > currentit 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_DOCSfor 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:
advancein classDocIdSetIterator- Throws:
IOException
-
cost
public long cost()Description copied from class:DocIdSetIteratorReturns 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:
costin classDocIdSetIterator
-