|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.search.spans.Spans org.apache.lucene.search.spans.TermSpans
public class TermSpans
Expert: Public for extension only
Field Summary | |
---|---|
protected int |
count
|
protected int |
doc
|
protected int |
freq
|
protected int |
position
|
protected TermPositions |
positions
|
protected Term |
term
|
Constructor Summary | |
---|---|
TermSpans(TermPositions positions,
Term term)
|
Method Summary | |
---|---|
int |
doc()
Returns the document number of the current match. |
int |
end()
Returns the end position of the current match. |
Collection<byte[]> |
getPayload()
Returns the payload data for the current span. |
TermPositions |
getPositions()
|
boolean |
isPayloadAvailable()
Checks if a payload can be loaded at this position. |
boolean |
next()
Move to the next match, returning true iff any such exists. |
boolean |
skipTo(int target)
Skips to the first match beyond the current, whose document number is greater than or equal to target. |
int |
start()
Returns the start position of the current match. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected TermPositions positions
protected Term term
protected int doc
protected int freq
protected int count
protected int position
Constructor Detail |
---|
public TermSpans(TermPositions positions, Term term) throws IOException
IOException
Method Detail |
---|
public boolean next() throws IOException
Spans
next
in class Spans
IOException
public boolean skipTo(int target) throws IOException
Spans
Returns true iff there is such a match.
Behaves as if written:
boolean skipTo(int target) { do { if (!next()) return false; } while (target > doc()); return true; }Most implementations are considerably more efficient than that.
skipTo
in class Spans
IOException
public int doc()
Spans
doc
in class Spans
public int start()
Spans
start
in class Spans
public int end()
Spans
end
in class Spans
public Collection<byte[]> getPayload() throws IOException
Spans
Spans.next()
is called for
the first time.
This method must not be called more than once after each call
of Spans.next()
. However, most payloads are loaded lazily,
so if the payload data for the current position is not needed,
this method may not be called at all for performance reasons. An ordered
SpanQuery does not lazy load, so if you have payloads in your index and
you do not want ordered SpanNearQuerys to collect payloads, you can
disable collection with a constructor option.WARNING: The status of the Payloads feature is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case.
getPayload
in class Spans
IOException
public boolean isPayloadAvailable()
Spans
Spans.next()
.
isPayloadAvailable
in class Spans
public String toString()
toString
in class Object
public TermPositions getPositions()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |