Module org.apache.lucene.queries

Package org.apache.lucene.queries.intervals

Class TermIntervalsSource

java.lang.Object

org.apache.lucene.queries.intervals.IntervalsSource

org.apache.lucene.queries.intervals.TermIntervalsSource

class TermIntervalsSource
extends IntervalsSource

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final BytesRef	term
private static final int	TERM_OPS_PER_POS	Number of simple operations in Lucene90PostingsReader.EverythingEnum#nextPosition() when no seek or buffer refill is done.
private static final int	TERM_POSNS_SEEK_OPS_PER_DOC	A guess of the average number of simple operations for the initial seek and buffer refill per document for the positions of a term.

Constructor Summary

Constructors

Constructor	Description
TermIntervalsSource(BytesRef term)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
IntervalIterator	intervals(String field, LeafReaderContext ctx)	Create an IntervalIterator exposing the minimum intervals defined by this IntervalsSource
(package private) static IntervalIterator	intervals(BytesRef term, TermsEnum te)
IntervalMatchesIterator	matches(String field, LeafReaderContext ctx, int doc)	Return a MatchesIterator over the intervals defined by this IntervalsSource for a given document and field
(package private) static IntervalMatchesIterator	matches(TermsEnum te, int doc, String 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
(package private) static float	termPositionsCost(TermsEnum termsEnum)	Returns an expected cost in simple operations of processing the occurrences of a term in a document that contains the term.
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

term

final BytesRef term

TERM_POSNS_SEEK_OPS_PER_DOC

private static final int TERM_POSNS_SEEK_OPS_PER_DOC

A guess of the average number of simple operations for the initial seek and buffer refill per document for the positions of a term. See also Lucene90PostingsReader.EverythingEnum#nextPosition().

Aside: Instead of being constant this could depend among others on Lucene90PostingsFormat.BLOCK_SIZE, TermsEnum.docFreq(), TermsEnum.totalTermFreq(), DocIdSetIterator.cost() (expected number of matching docs), IndexReader.maxDoc() (total number of docs in the segment), and the seek time and block size of the device storing the index.

See Also:

• Constant Field Values

TERM_OPS_PER_POS

private static final int TERM_OPS_PER_POS

Number of simple operations in Lucene90PostingsReader.EverythingEnum#nextPosition() when no seek or buffer refill is done.

See Also:

• Constant Field Values

Constructor Details

TermIntervalsSource

TermIntervalsSource(BytesRef term)

Method Details

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

intervals

static IntervalIterator intervals(BytesRef term,
 TermsEnum te)
                           throws IOException

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

matches

static IntervalMatchesIterator matches(TermsEnum te,
 int doc,
 String field)
                                throws IOException

Throws:

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

Specified by:

equals in class IntervalsSource

toString

public String toString()

Specified by:

toString in class IntervalsSource

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

termPositionsCost

static float termPositionsCost(TermsEnum termsEnum)
                        throws IOException

Returns an expected cost in simple operations of processing the occurrences of a term in a document that contains the term. This is for use by TwoPhaseIterator.matchCost() implementations.

Parameters:

termsEnum - The term is the term at which this TermsEnum is positioned.

Throws:

IOException