org.apache.lucene.search.intervals

Class DifferenceIntervalsSource

java.lang.Object

org.apache.lucene.search.intervals.IntervalsSource

org.apache.lucene.search.intervals.DifferenceIntervalsSource

Direct Known Subclasses:

NonOverlappingIntervalsSource, NotContainedByIntervalsSource, NotContainingIntervalsSource

abstract class DifferenceIntervalsSource
extends IntervalsSource

Field Summary

Fields

Modifier and Type	Field and Description
(package private) IntervalsSource	minuend
(package private) IntervalsSource	subtrahend

Constructor Summary

Constructors

Constructor and Description
DifferenceIntervalsSource(IntervalsSource minuend, IntervalsSource subtrahend)

Method Summary

Modifier and Type	Method and Description
protected abstract IntervalIterator	combine(IntervalIterator minuend, IntervalIterator subtrahend)
IntervalIterator	intervals(java.lang.String field, LeafReaderContext ctx) Create an IntervalIterator exposing the minimum intervals defined by this IntervalsSource Returns null if no intervals for this field exist in this segment
MatchesIterator	matches(java.lang.String field, LeafReaderContext ctx, int doc) Return a MatchesIterator over the intervals defined by this IntervalsSource for a given document and field Returns null if no intervals exist in the given document and field
int	minExtent() Return the minimum possible width of an interval returned by this source
void	visit(java.lang.String field, QueryVisitor visitor) Expert: visit the tree of sources

Methods inherited from class org.apache.lucene.search.intervals.IntervalsSource

equals, hashCode, pullUpDisjunctions, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

minuend

final IntervalsSource minuend

subtrahend

final IntervalsSource subtrahend

Constructor Detail

DifferenceIntervalsSource

DifferenceIntervalsSource(IntervalsSource minuend,
                          IntervalsSource subtrahend)

Method Detail

combine

protected abstract IntervalIterator combine(IntervalIterator minuend,
                                            IntervalIterator subtrahend)

intervals

public final IntervalIterator intervals(java.lang.String field,
                                        LeafReaderContext ctx)
                                 throws java.io.IOException

Description copied from class: IntervalsSource

Create an IntervalIterator exposing the minimum intervals defined by this IntervalsSource Returns null if no intervals for this field exist in this segment

Specified by:

intervals in class IntervalsSource

Parameters:

field - the field to read positions from

ctx - the context for which to return the iterator

Throws:

java.io.IOException

matches

public final MatchesIterator matches(java.lang.String field,
                                     LeafReaderContext ctx,
                                     int doc)
                              throws java.io.IOException

Description copied from class: IntervalsSource

Return a MatchesIterator over the intervals defined by this IntervalsSource for a given document and field Returns null if no intervals exist in the given document and field

Specified by:

matches in class IntervalsSource

Parameters:

field - the field to read positions from

ctx - the document's context

doc - the document to return matches for

Throws:

java.io.IOException

visit

public void visit(java.lang.String field,
                  QueryVisitor visitor)

Description copied from class: IntervalsSource

Expert: visit the tree of sources

Specified by:

visit in class IntervalsSource

minExtent

public int minExtent()

Description copied from class: IntervalsSource

Return the minimum possible width of an interval returned by this source

Specified by:

minExtent in class IntervalsSource