|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.DocsEnum
org.apache.lucene.index.DocsAndPositionsEnum
org.apache.lucene.index.FilterAtomicReader.FilterDocsAndPositionsEnum
public static class FilterAtomicReader.FilterDocsAndPositionsEnum
Base class for filtering DocsAndPositionsEnum
implementations.
Field Summary | |
---|---|
protected DocsAndPositionsEnum |
in
|
Fields inherited from class org.apache.lucene.index.DocsAndPositionsEnum |
---|
FLAG_OFFSETS, FLAG_PAYLOADS |
Fields inherited from class org.apache.lucene.index.DocsEnum |
---|
FLAG_FREQS |
Fields inherited from class org.apache.lucene.search.DocIdSetIterator |
---|
NO_MORE_DOCS |
Constructor Summary | |
---|---|
FilterAtomicReader.FilterDocsAndPositionsEnum(DocsAndPositionsEnum in)
|
Method Summary | |
---|---|
int |
advance(int target)
Advances to the first beyond (see NOTE below) the current whose document number is greater than or equal to target. |
AttributeSource |
attributes()
Returns the related attributes. |
int |
docID()
Returns the following: -1 or DocIdSetIterator.NO_MORE_DOCS if DocIdSetIterator.nextDoc() or
DocIdSetIterator.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. |
BytesRef |
getPayload()
Returns the payload at this position, or null if no payload was indexed. |
boolean |
hasPayload()
|
int |
nextDoc()
Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.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. |
int |
startOffset()
Returns start offset for the current position, or -1 if offsets were not indexed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final DocsAndPositionsEnum in
Constructor Detail |
---|
public FilterAtomicReader.FilterDocsAndPositionsEnum(DocsAndPositionsEnum in)
Method Detail |
---|
public int docID()
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if DocIdSetIterator.nextDoc()
or
DocIdSetIterator.advance(int)
were not called yet.
DocIdSetIterator.NO_MORE_DOCS
if the iterator has exhausted.
docID
in class DocIdSetIterator
public int freq() throws IOException
DocsEnum
DocIdSetIterator.nextDoc()
is first called,
nor after DocIdSetIterator.nextDoc()
returns NO_MORE_DOCS.
freq
in class DocsEnum
IOException
public int nextDoc() throws IOException
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the
set.
nextDoc
in class DocIdSetIterator
IOException
public int advance(int target) throws IOException
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the
set.
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: when target ≤ current
implementations may opt
not to advance beyond their current DocIdSetIterator.docID()
.
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.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
advance
in class DocIdSetIterator
IOException
public int nextPosition() throws IOException
DocsAndPositionsEnum
DocsEnum.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.
nextPosition
in class DocsAndPositionsEnum
IOException
public int startOffset() throws IOException
DocsAndPositionsEnum
startOffset
in class DocsAndPositionsEnum
IOException
public int endOffset() throws IOException
DocsAndPositionsEnum
endOffset
in class DocsAndPositionsEnum
IOException
public BytesRef getPayload() throws IOException
DocsAndPositionsEnum
getPayload
in class DocsAndPositionsEnum
IOException
public boolean hasPayload()
hasPayload
in class DocsAndPositionsEnum
public AttributeSource attributes()
DocsEnum
attributes
in class DocsEnum
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |