Module org.apache.lucene.queries

Package org.apache.lucene.queries.intervals

Class RepeatingIntervalsSource

java.lang.Object

org.apache.lucene.queries.intervals.IntervalsSource

org.apache.lucene.queries.intervals.RepeatingIntervalsSource

class RepeatingIntervalsSource
extends IntervalsSource

Generates an iterator that spans repeating instances of a sub-iterator, avoiding minimization. This is useful for repeated terms within an unordered interval, for example, ensuring that multiple iterators do not match on a single term.

The generated iterators have a specialized IntervalIterator.width() implementation that sums up the widths of the individual sub-iterators, rather than just returning the full span of the iterator.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	RepeatingIntervalsSource.DuplicateIntervalIterator
private static class	RepeatingIntervalsSource.DuplicateMatchesIterator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final int	childCount
(package private) final IntervalsSource	in
(package private) String	name

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RepeatingIntervalsSource(IntervalsSource in, int childCount)

Method Summary

Modifier and Type	Method	Description
(package private) static IntervalsSource	build(IntervalsSource in, int childCount)
boolean	equals(Object other)
int	hashCode()
IntervalIterator	intervals(String field, LeafReaderContext ctx)	Create an IntervalIterator exposing the minimum intervals defined by this IntervalsSource
IntervalMatchesIterator	matches(String field, LeafReaderContext ctx, int doc)	Return a MatchesIterator over the intervals defined by this IntervalsSource for a given document and field
int	minExtent()	Return the minimum possible width of an interval returned by this source
Collection<IntervalsSource>	pullUpDisjunctions()	Expert: return the set of disjunctions that make up this IntervalsSource
void	setName(String name)
String	toString()
void	visit(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 Details

in

final IntervalsSource in

childCount

final int childCount

name

String name

Constructor Details

RepeatingIntervalsSource

private RepeatingIntervalsSource(IntervalsSource in,
 int childCount)

Method Details

build

static IntervalsSource build(IntervalsSource in,
 int childCount)

setName

public void setName(String name)

intervals

public IntervalIterator intervals(String field,
 LeafReaderContext ctx)
                           throws 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:

IOException

matches

public IntervalMatchesIterator matches(String field,
 LeafReaderContext ctx,
 int doc)
                                throws 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:

IOException

visit

public void visit(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 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

hashCode

public int hashCode()

Specified by:

hashCode in class IntervalsSource

equals

public boolean equals(Object other)

Specified by:

equals in class IntervalsSource

toString

public String toString()

Specified by:

toString in class IntervalsSource