Package org.apache.lucene.queries.intervals

Class FilteredIntervalsSource

java.lang.Object

org.apache.lucene.queries.intervals.IntervalsSource

org.apache.lucene.queries.intervals.FilteredIntervalsSource

Direct Known Subclasses:

FilteredIntervalsSource.MaxGaps, FilteredIntervalsSource.MaxWidth

public abstract class FilteredIntervalsSource
extends IntervalsSource

An IntervalsSource that filters the intervals from another IntervalsSource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	FilteredIntervalsSource.MaxGaps
private static class	FilteredIntervalsSource.MaxWidth

Field Summary

Fields

Modifier and Type	Field	Description
protected IntervalsSource	in
private java.lang.String	name

Constructor Summary

Constructors

Constructor	Description
FilteredIntervalsSource(java.lang.String name, IntervalsSource in)	Create a new FilteredIntervalsSource

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	accept(IntervalIterator it)
boolean	equals(java.lang.Object o)
int	hashCode()
IntervalIterator	intervals(java.lang.String field, LeafReaderContext ctx)	Create an IntervalIterator exposing the minimum intervals defined by this IntervalsSource
IntervalMatchesIterator	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
static IntervalsSource	maxGaps(IntervalsSource in, int maxGaps)
static IntervalsSource	maxWidth(IntervalsSource in, int maxWidth)
int	minExtent()	Return the minimum possible width of an interval returned by this source
java.util.Collection<IntervalsSource>	pullUpDisjunctions()	Expert: return the set of disjunctions that make up this IntervalsSource
java.lang.String	toString()
void	visit(java.lang.String field, QueryVisitor visitor)	Expert: visit the tree of sources

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

in

protected final IntervalsSource in

Constructor Detail

FilteredIntervalsSource

public FilteredIntervalsSource(java.lang.String name,
                               IntervalsSource in)

Create a new FilteredIntervalsSource

Parameters:

name - the name of the filter

in - the source to filter

Method Detail

maxGaps

public static IntervalsSource maxGaps(IntervalsSource in,
                                      int maxGaps)

maxWidth

public static IntervalsSource maxWidth(IntervalsSource in,
                                       int maxWidth)

accept

protected abstract boolean accept(IntervalIterator it)

Returns:

false if the current interval should be filtered out

intervals

public 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 IntervalMatchesIterator 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

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

pullUpDisjunctions

public java.util.Collection<IntervalsSource> pullUpDisjunctions()

Description copied from class: IntervalsSource

Expert: return the set of disjunctions that make up this IntervalsSource

Most implementations can return Collections.singleton(this)

Specified by:

pullUpDisjunctions in class IntervalsSource

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

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in class IntervalsSource

hashCode

public int hashCode()

Specified by:

hashCode in class IntervalsSource

toString

public java.lang.String toString()

Specified by:

toString in class IntervalsSource