Module org.apache.lucene.queries

Package org.apache.lucene.queries.spans

Class ContainSpans

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.ContainSpans

abstract class ContainSpans
extends ConjunctionSpans

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Spans	bigSpans
(package private) Spans	littleSpans
(package private) Spans	sourceSpans

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
ContainSpans(Spans bigSpans, Spans littleSpans, Spans sourceSpans)

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	startPosition()	Returns the start position in the current doc, or -1 when Spans.nextStartPosition() was not yet called on the current doc.
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, twoPhaseCurrentDocMatches

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

doCurrentSpans, doStartCurrentDoc, nextStartPosition, 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

sourceSpans

Spans sourceSpans

bigSpans

Spans bigSpans

littleSpans

Spans littleSpans

Constructor Details

ContainSpans

ContainSpans(Spans bigSpans,
 Spans littleSpans,
 Spans sourceSpans)

Method Details

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