Class MultiDocsAndPositionsEnum
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Holds aDocsAndPositionsEnum
along with the correspondingReaderSlice
. -
Field Summary
Fields inherited from class org.apache.lucene.index.DocsAndPositionsEnum
FLAG_OFFSETS, FLAG_PAYLOADS
Fields inherited from class org.apache.lucene.index.DocsEnum
FLAG_FREQS, FLAG_NONE
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
Constructor Summary
ConstructorsConstructorDescriptionMultiDocsAndPositionsEnum
(MultiTermsEnum parent, int subReaderCount) Sole constructor. -
Method Summary
Modifier and TypeMethodDescriptionint
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
canReuse
(MultiTermsEnum parent) Returnstrue
if this instance can be reused by the providedMultiTermsEnum
.long
cost()
Returns the estimated cost of thisDocIdSetIterator
.int
docID()
Returns the following: -1 orDocIdSetIterator.NO_MORE_DOCS
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.int
Returns end offset for the current position, or -1 if offsets were not indexed.int
freq()
Returns term frequency in the current document, or 1 if the field was indexed withFieldInfo.IndexOptions.DOCS_ONLY
.int
How many sub-readers we are merging.Returns the payload at this position, or null if no payload was indexed.getSubs()
Returns sub-readers we are merging.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.int
Returns the next position.reset
(MultiDocsAndPositionsEnum.EnumWithSlice[] subs, int numSubs) Rre-use and reset this instance on the provided slices.int
Returns start offset for the current position, or -1 if offsets were not indexed.toString()
Methods inherited from class org.apache.lucene.index.DocsEnum
attributes
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
empty, slowAdvance
-
Constructor Details
-
MultiDocsAndPositionsEnum
Sole constructor.
-
-
Method Details
-
canReuse
Returnstrue
if this instance can be reused by the providedMultiTermsEnum
. -
reset
Rre-use and reset this instance on the provided slices. -
getNumSubs
public int getNumSubs()How many sub-readers we are merging.- See Also:
-
getSubs
Returns sub-readers we are merging. -
freq
Description copied from class:DocsEnum
Returns term frequency in the current document, or 1 if the field was indexed withFieldInfo.IndexOptions.DOCS_ONLY
. Do not call this beforeDocIdSetIterator.nextDoc()
is first called, nor afterDocIdSetIterator.nextDoc()
returnsDocIdSetIterator.NO_MORE_DOCS
.NOTE: if the
DocsEnum
was obtain withDocsEnum.FLAG_NONE
, the result of this method is undefined.- Specified by:
freq
in classDocsEnum
- Throws:
IOException
-
docID
public int docID()Description copied from class:DocIdSetIterator
Returns the following:- -1 or
DocIdSetIterator.NO_MORE_DOCS
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
- -1 or
-
advance
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:
IOException
-
nextDoc
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:
IOException
-
nextPosition
Description copied from class:DocsAndPositionsEnum
Returns the next position. You should only call this up toDocsEnum.freq()
times else the behavior is not defined. If positions were not indexed this will return -1; this only happens if offsets were indexed and you passed needsOffset=true when pulling the enum.- Specified by:
nextPosition
in classDocsAndPositionsEnum
- Throws:
IOException
-
startOffset
Description copied from class:DocsAndPositionsEnum
Returns start offset for the current position, or -1 if offsets were not indexed.- Specified by:
startOffset
in classDocsAndPositionsEnum
- Throws:
IOException
-
endOffset
Description copied from class:DocsAndPositionsEnum
Returns end offset for the current position, or -1 if offsets were not indexed.- Specified by:
endOffset
in classDocsAndPositionsEnum
- Throws:
IOException
-
getPayload
Description copied from class:DocsAndPositionsEnum
Returns 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:
getPayload
in classDocsAndPositionsEnum
- Throws:
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
-
toString
-