org.apache.lucene.search.intervals

Class FixedFieldIntervalsSource

java.lang.Object

org.apache.lucene.search.intervals.IntervalsSource

org.apache.lucene.search.intervals.FixedFieldIntervalsSource

class FixedFieldIntervalsSource
extends IntervalsSource

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	field
private IntervalsSource	source

Constructor Summary

Constructors

Constructor and Description
FixedFieldIntervalsSource(java.lang.String field, IntervalsSource source)

Method Summary

Modifier and Type	Method and Description
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 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
java.util.Collection<IntervalsSource>	pullUpDisjunctions() Expert: return the set of disjunctions that make up this IntervalsSource Most implementations can return Collections.singleton(this)
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

field

private final java.lang.String field

source

private final IntervalsSource source

Constructor Detail

FixedFieldIntervalsSource

FixedFieldIntervalsSource(java.lang.String field,
                          IntervalsSource source)

Method Detail

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

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

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