Class SimpleTextFieldsReader.SimpleTextDocsEnum
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.index.PostingsEnum
-
- org.apache.lucene.index.ImpactsEnum
-
- org.apache.lucene.codecs.simpletext.SimpleTextFieldsReader.SimpleTextDocsEnum
-
- All Implemented Interfaces:
ImpactsSource
- Enclosing class:
- SimpleTextFieldsReader
private class SimpleTextFieldsReader.SimpleTextDocsEnum extends ImpactsEnum
-
-
Field Summary
Fields Modifier and Type Field Description private int
cost
private int
docID
private IndexInput
in
private IndexInput
inStart
private int
nextSkipDoc
private boolean
omitTF
private BytesRefBuilder
scratch
private CharsRefBuilder
scratchUTF16
private long
seekTo
private SimpleTextSkipReader
skipReader
private int
tf
-
Fields inherited from class org.apache.lucene.index.PostingsEnum
ALL, FREQS, NONE, OFFSETS, PAYLOADS, POSITIONS
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Constructor Description SimpleTextDocsEnum()
-
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.void
advanceShallow(int target)
Shallow-advance totarget
.private int
advanceTarget(int target)
boolean
canReuse(IndexInput in)
long
cost()
Returns the estimated cost of thisDocIdSetIterator
.int
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.int
endOffset()
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 withIndexOptions.DOCS
.Impacts
getImpacts()
Get information about upcoming impacts for doc ids that are greater than or equal to the maximum ofDocIdSetIterator.docID()
and the last target that was passed toImpactsSource.advanceShallow(int)
.BytesRef
getPayload()
Returns the payload at this position, or null if no payload was indexed.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
nextPosition()
Returns the next position, or -1 if positions were not indexed.private int
readDoc()
SimpleTextFieldsReader.SimpleTextDocsEnum
reset(long fp, boolean omitTF, int docFreq, long skipPointer)
int
startOffset()
Returns start offset for the current position, or -1 if offsets were not indexed.-
Methods inherited from class org.apache.lucene.index.PostingsEnum
featureRequested
-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Field Detail
-
inStart
private final IndexInput inStart
-
in
private final IndexInput in
-
omitTF
private boolean omitTF
-
docID
private int docID
-
tf
private int tf
-
scratch
private final BytesRefBuilder scratch
-
scratchUTF16
private final CharsRefBuilder scratchUTF16
-
cost
private int cost
-
skipReader
private SimpleTextSkipReader skipReader
-
nextSkipDoc
private int nextSkipDoc
-
seekTo
private long seekTo
-
-
Method Detail
-
canReuse
public boolean canReuse(IndexInput in)
-
reset
public SimpleTextFieldsReader.SimpleTextDocsEnum reset(long fp, boolean omitTF, int docFreq, long skipPointer) throws java.io.IOException
- Throws:
java.io.IOException
-
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
-
freq
public int freq() throws java.io.IOException
Description copied from class:PostingsEnum
Returns 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
PostingsEnum
was obtain withPostingsEnum.NONE
, the result of this method is undefined.- Specified by:
freq
in classPostingsEnum
- Throws:
java.io.IOException
-
nextPosition
public int nextPosition() throws java.io.IOException
Description copied from class:PostingsEnum
Returns the next position, or -1 if positions were not indexed. Calling this more thanPostingsEnum.freq()
times is undefined.- Specified by:
nextPosition
in classPostingsEnum
- Throws:
java.io.IOException
-
startOffset
public int startOffset() throws java.io.IOException
Description copied from class:PostingsEnum
Returns start offset for the current position, or -1 if offsets were not indexed.- Specified by:
startOffset
in classPostingsEnum
- Throws:
java.io.IOException
-
endOffset
public int endOffset() throws java.io.IOException
Description copied from class:PostingsEnum
Returns end offset for the current position, or -1 if offsets were not indexed.- Specified by:
endOffset
in classPostingsEnum
- Throws:
java.io.IOException
-
getPayload
public BytesRef getPayload() throws java.io.IOException
Description copied from class:PostingsEnum
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 classPostingsEnum
- Throws:
java.io.IOException
-
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
-
readDoc
private int readDoc() throws java.io.IOException
- Throws:
java.io.IOException
-
advanceTarget
private int advanceTarget(int target) throws java.io.IOException
- 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
-
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
-
advanceShallow
public void advanceShallow(int target) throws java.io.IOException
Description copied from interface:ImpactsSource
Shallow-advance totarget
. This is cheaper than callingDocIdSetIterator.advance(int)
and allows further calls toImpactsSource.getImpacts()
to ignore doc IDs that are less thantarget
in order to get more precise information about impacts. This method may not be called on targets that are less than the currentDocIdSetIterator.docID()
. After this method has been called,DocIdSetIterator.nextDoc()
may not be called if the current doc ID is less thantarget - 1
andDocIdSetIterator.advance(int)
may not be called on targets that are less thantarget
.- Throws:
java.io.IOException
-
getImpacts
public Impacts getImpacts() throws java.io.IOException
Description copied from interface:ImpactsSource
Get information about upcoming impacts for doc ids that are greater than or equal to the maximum ofDocIdSetIterator.docID()
and the last target that was passed toImpactsSource.advanceShallow(int)
. This method may not be called on an unpositioned iterator on whichImpactsSource.advanceShallow(int)
has never been called. NOTE: advancing this iterator may invalidate the returned impacts, so they should not be used after the iterator has been advanced.- Throws:
java.io.IOException
-
-