org.apache.lucene.search.spans

Class TermSpans

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.search.spans.Spans

org.apache.lucene.search.spans.TermSpans

public class TermSpans
extends Spans

Expert: Public for extension only. This does not work correctly for terms that indexed at position Integer.MAX_VALUE.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	count
protected int	doc
protected int	freq
protected int	position
protected PostingsEnum	postings
protected boolean	readPayload
protected Term	term

Fields inherited from class org.apache.lucene.search.spans.Spans

NO_MORE_POSITIONS

Fields inherited from class org.apache.lucene.search.DocIdSetIterator

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor and Description
TermSpans(PostingsEnum postings, Term term)

Method Summary

Methods

Modifier and Type	Method and 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.
long	cost() Returns the estimated cost of this DocIdSetIterator.
int	docID() Returns the following: -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
int	endPosition() Returns the end position for the current start position, or -1 when Spans.nextStartPosition() was not yet called on the current doc.
Collection<byte[]>	getPayload() Returns the payload data for the current start/end position.
PostingsEnum	getPostings()
boolean	isPayloadAvailable() Checks if a payload can be loaded at the current start/end position.
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	nextStartPosition() Returns the next start position for the current doc.
int	startPosition() Returns the start position in the current doc, or -1 when Spans.nextStartPosition() was not yet called on the current doc.
String	toString()

Methods inherited from class org.apache.lucene.search.spans.Spans

asTwoPhaseIterator

Methods inherited from class org.apache.lucene.search.DocIdSetIterator

all, empty, slowAdvance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

postings

protected final PostingsEnum postings

term

protected final Term term

doc

protected int doc

freq

protected int freq

count

protected int count

position

protected int position

readPayload

protected boolean readPayload

Constructor Detail

TermSpans

public TermSpans(PostingsEnum postings,
         Term term)

Method Detail

nextDoc

public int nextDoc()
            throws IOException

Description copied from class: DocIdSetIterator

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.

Specified by:

nextDoc in class DocIdSetIterator

Throws:

IOException

advance

public int advance(int target)
            throws 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 returns DocIdSetIterator.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 class DocIdSetIterator

Throws:

IOException

docID

public int docID()

Description copied from class: DocIdSetIterator

Returns the following:

• -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.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 class DocIdSetIterator

nextStartPosition

public int nextStartPosition()
                      throws IOException

Description copied from class: Spans

Returns the next start position for the current doc. There is always at least one start/end position per doc. After the last start/end position at the current doc this returns Spans.NO_MORE_POSITIONS.

Specified by:

nextStartPosition in class Spans

Throws:

IOException

startPosition

public int startPosition()

Description copied from class: Spans

Returns the start position in the current doc, or -1 when Spans.nextStartPosition() was not yet called on the current doc. After the last start/end position at the current doc this returns Spans.NO_MORE_POSITIONS.

Specified by:

startPosition in class Spans

endPosition

public int endPosition()

Description copied from class: Spans

Returns the end position for the current start position, or -1 when Spans.nextStartPosition() was not yet called on the current doc. After the last start/end position at the current doc this returns Spans.NO_MORE_POSITIONS.

Specified by:

endPosition in class Spans

cost

public long cost()

Description copied from class: DocIdSetIterator

Returns the estimated cost of this DocIdSetIterator.

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 class DocIdSetIterator

getPayload

public Collection<byte[]> getPayload()
                              throws IOException

Description copied from class: Spans

Returns the payload data for the current start/end position. This is only valid after Spans.nextStartPosition() returned an available start position. This method must not be called more than once after each call of Spans.nextStartPosition(). 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.
Note that the return type is a collection, thus the ordering should not be relied upon.

Specified by:

getPayload in class Spans

Returns:

a List of byte arrays containing the data of this payload, otherwise null if isPayloadAvailable is false

Throws:

IOException - if there is a low-level I/O error

isPayloadAvailable

public boolean isPayloadAvailable()
                           throws IOException

Description copied from class: Spans

Checks if a payload can be loaded at the current start/end position.

Payloads can only be loaded once per call to Spans.nextStartPosition().

Specified by:

isPayloadAvailable in class Spans

Returns:

true if there is a payload available at this start/end position that can be loaded

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Spans

getPostings

public PostingsEnum getPostings()