Module org.apache.lucene.core

Package org.apache.lucene.search

Class DisjunctionMatchesIterator

java.lang.Object

org.apache.lucene.search.DisjunctionMatchesIterator

All Implemented Interfaces:

MatchesIterator

final class DisjunctionMatchesIterator
extends Object
implements MatchesIterator

A MatchesIterator that combines matches from a set of sub-iterators

Matches are sorted by their start positions, and then by their end positions, so that prefixes sort first. Matches may overlap, or be duplicated if they appear in more than one of the sub-iterators.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	DisjunctionMatchesIterator.TermsEnumDisjunctionMatchesIterator

Field Summary

Fields

Modifier and Type	Field	Description
private final PriorityQueue<MatchesIterator>	queue
private boolean	started

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DisjunctionMatchesIterator(List<MatchesIterator> matches)

Method Summary

Modifier and Type	Method	Description
private static BytesRefIterator	asBytesRefIterator(List<Term> terms)
int	endOffset()	The ending offset of the current match, or -1 if offsets are not available
int	endPosition()	The end position of the current match, or -1 if positions are not available
(package private) static MatchesIterator	fromSubIterators(List<MatchesIterator> mis)
(package private) static MatchesIterator	fromTerms(LeafReaderContext context, int doc, Query query, String field, List<Term> terms)	Create a DisjunctionMatchesIterator over a list of terms
(package private) static MatchesIterator	fromTermsEnum(LeafReaderContext context, int doc, Query query, String field, BytesRefIterator terms)	Create a DisjunctionMatchesIterator over a list of terms extracted from a BytesRefIterator
Query	getQuery()	Returns the Query causing the current match
MatchesIterator	getSubMatches()	Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current match
boolean	next()	Advance the iterator to the next match position
int	startOffset()	The starting offset of the current match, or -1 if offsets are not available
int	startPosition()	The start position of the current match, or -1 if positions are not available

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

queue

private final PriorityQueue<MatchesIterator> queue

started

private boolean started

Constructor Details

DisjunctionMatchesIterator

private DisjunctionMatchesIterator(List<MatchesIterator> matches)
                            throws IOException

Throws:

IOException

Method Details

fromTerms

static MatchesIterator fromTerms(LeafReaderContext context,
 int doc,
 Query query,
 String field,
 List<Term> terms)
                          throws IOException

Create a DisjunctionMatchesIterator over a list of terms

Only terms that have at least one match in the given document will be included

Throws:

IOException

asBytesRefIterator

private static BytesRefIterator asBytesRefIterator(List<Term> terms)

fromTermsEnum

static MatchesIterator fromTermsEnum(LeafReaderContext context,
 int doc,
 Query query,
 String field,
 BytesRefIterator terms)
                              throws IOException

Create a DisjunctionMatchesIterator over a list of terms extracted from a BytesRefIterator

Only terms that have at least one match in the given document will be included

Throws:

IOException

fromSubIterators

static MatchesIterator fromSubIterators(List<MatchesIterator> mis)
                                 throws IOException

Throws:

IOException

next

public boolean next()
             throws IOException

Description copied from interface: MatchesIterator

Advance the iterator to the next match position

Specified by:

next in interface MatchesIterator

Returns:

true if matches have not been exhausted

Throws:

IOException

startPosition

public int startPosition()

Description copied from interface: MatchesIterator

The start position of the current match, or -1 if positions are not available

Should only be called after MatchesIterator.next() has returned true

Specified by:

startPosition in interface MatchesIterator

endPosition

public int endPosition()

Description copied from interface: MatchesIterator

The end position of the current match, or -1 if positions are not available

Should only be called after MatchesIterator.next() has returned true

Specified by:

endPosition in interface MatchesIterator

startOffset

public int startOffset()
                throws IOException

Description copied from interface: MatchesIterator

The starting offset of the current match, or -1 if offsets are not available

Should only be called after MatchesIterator.next() has returned true

Specified by:

startOffset in interface MatchesIterator

Throws:

IOException

endOffset

public int endOffset()
              throws IOException

Description copied from interface: MatchesIterator

The ending offset of the current match, or -1 if offsets are not available

Should only be called after MatchesIterator.next() has returned true

Specified by:

endOffset in interface MatchesIterator

Throws:

IOException

getSubMatches

public MatchesIterator getSubMatches()
                              throws IOException

Description copied from interface: MatchesIterator

Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current match

Returns null if there are no submatches (ie the current iterator is at the leaf level)

Should only be called after MatchesIterator.next() has returned true

Specified by:

getSubMatches in interface MatchesIterator

Throws:

IOException

getQuery

public Query getQuery()

Description copied from interface: MatchesIterator

Returns the Query causing the current match

If this MatchesIterator has been returned from a MatchesIterator.getSubMatches() call, then returns a TermQuery equivalent to the current match

Should only be called after MatchesIterator.next() has returned true

Specified by:

getQuery in interface MatchesIterator