Class FilterSortedSetDocValues
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.index.SortedSetDocValues
-
- org.apache.lucene.index.FilterSortedSetDocValues
-
public class FilterSortedSetDocValues extends SortedSetDocValues
Delegates all methods to a wrappedSortedSetDocValues.
-
-
Field Summary
Fields Modifier and Type Field Description protected SortedSetDocValuesinWrapped values-
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 FilterSortedSetDocValues(SortedSetDocValues in)Initializes delegate
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intadvance(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.intdocValueCount()Retrieves the number of unique ords for the current document.longgetValueCount()Returns the number of unique values.TermsEnumintersect(CompiledAutomaton automaton)Returns aTermsEnumover the values, filtered by aCompiledAutomatonThe enum supportsTermsEnum.ord().BytesReflookupOrd(long ord)Retrieves the value for the specified ordinal.longlookupTerm(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.longnextOrd()Returns the next ordinal for the current document.TermsEnumtermsEnum()Returns aTermsEnumover the values.-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Field Detail
-
in
protected final SortedSetDocValues in
Wrapped values
-
-
Constructor Detail
-
FilterSortedSetDocValues
public FilterSortedSetDocValues(SortedSetDocValues in)
Initializes delegate
-
-
Method Detail
-
advanceExact
public boolean advanceExact(int target) throws IOExceptionAdvance 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
-
nextOrd
public long nextOrd() throws IOExceptionDescription copied from class:SortedSetDocValuesReturns the next ordinal for the current document. It is illegal to call this method afteradvanceExact(int)returnedfalse.Note: Returns
SortedSetDocValues.NO_MORE_ORDSwhen the current document has no more ordinals. This behavior will be removed in a future version. Callers should useSortedSetDocValues.docValueCount()to determine the number of values for the current document up-front.- Specified by:
nextOrdin 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. - Throws:
IOException
-
docValueCount
public int docValueCount()
Description copied from class:SortedSetDocValuesRetrieves the number of unique ords for the current document. This must always be greater than zero. It is illegal to call this method afteradvanceExact(int)returnedfalse.- Specified by:
docValueCountin classSortedSetDocValues
-
lookupOrd
public BytesRef lookupOrd(long ord) throws IOException
Description copied from class:SortedSetDocValuesRetrieves the value for the specified ordinal. The returnedBytesRefmay be re-used across calls to lookupOrd so make sure tocopy itif you want to keep it around.- Specified by:
lookupOrdin classSortedSetDocValues- Parameters:
ord- ordinal to lookup- Throws:
IOException- See Also:
SortedSetDocValues.nextOrd()
-
getValueCount
public long getValueCount()
Description copied from class:SortedSetDocValuesReturns the number of unique values.- Specified by:
getValueCountin 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 IOException
Description copied from class:SortedSetDocValuesIfkeyexists, returns its ordinal, else returns-insertionPoint-1, likeArrays.binarySearch.- Overrides:
lookupTermin classSortedSetDocValues- Parameters:
key- Key to look up- Throws:
IOException
-
termsEnum
public TermsEnum termsEnum() throws IOException
Description copied from class:SortedSetDocValuesReturns aTermsEnumover the values. The enum supportsTermsEnum.ord()andTermsEnum.seekExact(long).- Overrides:
termsEnumin classSortedSetDocValues- Throws:
IOException
-
intersect
public TermsEnum intersect(CompiledAutomaton automaton) throws IOException
Description copied from class:SortedSetDocValuesReturns aTermsEnumover the values, filtered by aCompiledAutomatonThe enum supportsTermsEnum.ord().- Overrides:
intersectin classSortedSetDocValues- 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
public int nextDoc() throws IOExceptionDescription 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
public int advance(int target) throws IOExceptionDescription 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
-
-