Package org.apache.lucene.index
Class FilterLeafReader.FilterPostingsEnum
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.PostingsEnum
org.apache.lucene.index.FilterLeafReader.FilterPostingsEnum
- All Implemented Interfaces:
Unwrappable<PostingsEnum>
- Enclosing class:
FilterLeafReader
public abstract static class FilterLeafReader.FilterPostingsEnum
extends PostingsEnum
implements Unwrappable<PostingsEnum>
Base class for filtering
PostingsEnum implementations.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final PostingsEnumThe underlying PostingsEnum instance.Fields inherited from class org.apache.lucene.index.PostingsEnum
ALL, FREQS, NONE, OFFSETS, PAYLOADS, POSITIONSFields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCreate a new FilterPostingsEnum -
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.longcost()Returns the estimated cost of thisDocIdSetIterator.intdocID()Returns the following:-1ifDocIdSetIterator.nextDoc()orDocIdSetIterator.advance(int)were not called yet.intReturns end offset for the current position, or -1 if offsets were not indexed.intfreq()Returns term frequency in the current document, or 1 if the field was indexed withIndexOptions.DOCS.Returns the payload at this position, or null if no payload was indexed.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.intReturns the next position, or -1 if positions were not indexed.intReturns start offset for the current position, or -1 if offsets were not indexed.unwrap()Unwraps this instanceMethods inherited from class org.apache.lucene.index.PostingsEnum
featureRequestedMethods inherited from class org.apache.lucene.search.DocIdSetIterator
all, docIDRunEnd, empty, intoBitSet, range, slowAdvance
-
Field Details
-
in
The underlying PostingsEnum instance.
-
-
Constructor Details
-
FilterPostingsEnum
Create a new FilterPostingsEnum- Parameters:
in- the underlying PostingsEnum instance.
-
-
Method Details
-
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
-
freq
Description copied from class:PostingsEnumReturns term frequency in the current document, or 1 if the field was indexed withIndexOptions.DOCS. Do not call this beforeDocIdSetIterator.nextDoc()is first called, nor afterDocIdSetIterator.nextDoc()returnsDocIdSetIterator.NO_MORE_DOCS.NOTE: if the
PostingsEnumwas obtain withPostingsEnum.NONE, the result of this method is undefined.- Specified by:
freqin classPostingsEnum- Throws:
IOException
-
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
-
nextPosition
Description copied from class:PostingsEnumReturns the next position, or -1 if positions were not indexed. Calling this more thanPostingsEnum.freq()times is undefined.- Specified by:
nextPositionin classPostingsEnum- Throws:
IOException
-
startOffset
Description copied from class:PostingsEnumReturns start offset for the current position, or -1 if offsets were not indexed.- Specified by:
startOffsetin classPostingsEnum- Throws:
IOException
-
endOffset
Description copied from class:PostingsEnumReturns end offset for the current position, or -1 if offsets were not indexed.- Specified by:
endOffsetin classPostingsEnum- Throws:
IOException
-
getPayload
Description copied from class:PostingsEnumReturns the payload at this position, or null if no payload was indexed. You should not modify anything (neither members of the returned BytesRef nor bytes in the byte[]).- Specified by:
getPayloadin classPostingsEnum- 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
-
unwrap
Description copied from interface:UnwrappableUnwraps this instance- Specified by:
unwrapin interfaceUnwrappable<PostingsEnum>
-