Module org.apache.lucene.queries

Package org.apache.lucene.queries.intervals

Class DisjunctionIntervalsSource.DisjunctionMatchesIterator

java.lang.Object

org.apache.lucene.queries.intervals.DisjunctionIntervalsSource.DisjunctionMatchesIterator

All Implemented Interfaces:

IntervalMatchesIterator, MatchesIterator

Enclosing class:

DisjunctionIntervalsSource

private static class DisjunctionIntervalsSource.DisjunctionMatchesIterator
extends Object
implements IntervalMatchesIterator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final DisjunctionIntervalsSource.DisjunctionIntervalIterator	it
(package private) final List<IntervalMatchesIterator>	subs

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DisjunctionMatchesIterator(DisjunctionIntervalsSource.DisjunctionIntervalIterator it, List<IntervalMatchesIterator> subs)

Method Summary

Modifier and Type	Method	Description
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
int	gaps()	The number of top-level gaps inside the current match
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
int	width()	The width of the current match

Methods inherited from class java.lang.Object

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

Field Details

it

final DisjunctionIntervalsSource.DisjunctionIntervalIterator it

subs

final List<IntervalMatchesIterator> subs

Constructor Details

DisjunctionMatchesIterator

private DisjunctionMatchesIterator(DisjunctionIntervalsSource.DisjunctionIntervalIterator it,
 List<IntervalMatchesIterator> subs)

Method Details

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

gaps

public int gaps()

Description copied from interface: IntervalMatchesIterator

The number of top-level gaps inside the current match

Specified by:

gaps in interface IntervalMatchesIterator

See Also:

• IntervalIterator.gaps()

width

public int width()

Description copied from interface: IntervalMatchesIterator

The width of the current match

Specified by:

width in interface IntervalMatchesIterator

See Also:

• IntervalIterator.width()