Module org.apache.lucene.core

Package org.apache.lucene.search

Class DisjunctionMatchesIterator.TermsEnumDisjunctionMatchesIterator

java.lang.Object

org.apache.lucene.search.DisjunctionMatchesIterator.TermsEnumDisjunctionMatchesIterator

All Implemented Interfaces:

MatchesIterator

Enclosing class:

DisjunctionMatchesIterator

private static class DisjunctionMatchesIterator.TermsEnumDisjunctionMatchesIterator
extends Object
implements MatchesIterator

Field Summary

Fields

Modifier and Type	Field	Description
private final int	doc
private final MatchesIterator	first
private MatchesIterator	it
private final Query	query
private final TermsEnum	te
private final BytesRefIterator	terms

Constructor Summary

Constructors

Constructor	Description
TermsEnumDisjunctionMatchesIterator(MatchesIterator first, BytesRefIterator terms, TermsEnum te, int doc, Query query)

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
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
private void	init()
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

first

private final MatchesIterator first

terms

private final BytesRefIterator terms

te

private final TermsEnum te

doc

private final int doc

query

private final Query query

it

private MatchesIterator it

Constructor Details

TermsEnumDisjunctionMatchesIterator

TermsEnumDisjunctionMatchesIterator(MatchesIterator first,
 BytesRefIterator terms,
 TermsEnum te,
 int doc,
 Query query)

Method Details

init

private void init()
           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