org.apache.lucene.search.spans

Class TermSpans

java.lang.Object

org.apache.lucene.search.spans.TermSpans

All Implemented Interfaces:

Spans

public class TermSpans
extends java.lang.Object
implements Spans

Expert: Public for extension only

Constructor Summary

Constructors

Constructor and Description
TermSpans(TermPositions positions, Term term)

Method Summary

Modifier and Type	Method and Description
int	doc() Returns the document number of the current match.
int	end() Returns the end position of the current match.
TermPositions	getPositions()
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TermSpans

public TermSpans(TermPositions positions,
                 Term term)
          throws java.io.IOException

Throws:

java.io.IOException

Method Detail

next

public boolean next()
             throws java.io.IOException

Description copied from interface: Spans

Move to the next match, returning true iff any such exists.

Specified by:

next in interface Spans

Throws:

java.io.IOException

skipTo

public boolean skipTo(int target)
               throws java.io.IOException

Description copied from interface: Spans

Skips to the first match beyond the current, whose document number is greater than or equal to target.

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.

Specified by:

skipTo in interface Spans

Throws:

java.io.IOException

doc

public int doc()

Description copied from interface: Spans

Returns the document number of the current match. Initially invalid.

Specified by:

doc in interface Spans

start

public int start()

Description copied from interface: Spans

Returns the start position of the current match. Initially invalid.

Specified by:

start in interface Spans

end

public int end()

Description copied from interface: Spans

Returns the end position of the current match. Initially invalid.

Specified by:

end in interface Spans

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPositions

public TermPositions getPositions()