Module org.apache.lucene.queries

Package org.apache.lucene.queries.spans

Class NearSpansUnordered

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.queries.spans.Spans

org.apache.lucene.queries.spans.ConjunctionSpans

org.apache.lucene.queries.spans.NearSpansUnordered

public class NearSpansUnordered
extends ConjunctionSpans

Similar to NearSpansOrdered, but for the unordered case.

Expert: Only public for subclassing. Most implementations should not need this class

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	NearSpansUnordered.SpanTotalLengthEndPositionWindow	Maintain totalSpanLength and maxEndPosition

Field Summary

Fields

Modifier and Type	Field	Description
private final int	allowedSlop
private NearSpansUnordered.SpanTotalLengthEndPositionWindow	spanWindow

Fields inherited from class org.apache.lucene.queries.spans.ConjunctionSpans

atFirstInCurrentDoc, conjunction, oneExhaustedInCurrentDoc, subSpans

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

NO_MORE_POSITIONS

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

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor	Description
NearSpansUnordered(int allowedSlop, List<Spans> subSpans)

Method Summary

Modifier and Type	Method	Description
void	collect(SpanCollector collector)	Collect postings data from the leaves of the current Spans.
int	endPosition()	Returns the end position for the current start position, or -1 when Spans.nextStartPosition() was not yet called on the current doc.
int	nextStartPosition()	Returns the next start position for the current doc.
(package private) static boolean	positionsOrdered(Spans spans1, Spans spans2)	Check whether two Spans in the same document are ordered with possible overlap.
int	startPosition()	Returns the start position in the current doc, or -1 when Spans.nextStartPosition() was not yet called on the current doc.
(package private) boolean	twoPhaseCurrentDocMatches()
int	width()	Return the width of the match, which is typically used to sloppy freq.

Methods inherited from class org.apache.lucene.queries.spans.ConjunctionSpans

advance, asTwoPhaseIterator, cost, docID, getSubSpans, nextDoc, positionsCost, toMatchDoc

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

doCurrentSpans, doStartCurrentDoc, toString

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

all, empty, range, slowAdvance

Methods inherited from class java.lang.Object

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

Field Details

allowedSlop

private final int allowedSlop

spanWindow

private NearSpansUnordered.SpanTotalLengthEndPositionWindow spanWindow

Constructor Details

NearSpansUnordered

public NearSpansUnordered(int allowedSlop,
 List<Spans> subSpans)
                   throws IOException

Throws:

IOException

Method Details

positionsOrdered

static boolean positionsOrdered(Spans spans1,
 Spans spans2)

Check whether two Spans in the same document are ordered with possible overlap.

Returns:

true iff spans1 starts before spans2 or the spans start at the same position, and spans1 ends before spans2.

twoPhaseCurrentDocMatches

boolean twoPhaseCurrentDocMatches()
                           throws IOException

Specified by:

twoPhaseCurrentDocMatches in class ConjunctionSpans

Throws:

IOException

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

width

public int width()

Description copied from class: Spans

Return the width of the match, which is typically used to sloppy freq. It is only legal to call this method when the iterator is on a valid doc ID and positioned. The return value must be positive, and lower values means that the match is better.

Specified by:

width in class Spans

collect

public void collect(SpanCollector collector)
             throws IOException

Description copied from class: Spans

Collect postings data from the leaves of the current Spans.

This method should only be called after Spans.nextStartPosition(), and before Spans.NO_MORE_POSITIONS has been reached.

Specified by:

collect in class Spans

Parameters:

collector - a SpanCollector

Throws:

IOException