Package org.apache.lucene.search

Class FilterMatchesIterator

java.lang.Object
org.apache.lucene.search.FilterMatchesIterator
All Implemented Interfaces:
MatchesIterator
public abstract class FilterMatchesIterator extends Object implements MatchesIterator
A MatchesIterator that delegates all calls to another MatchesIterator

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final MatchesIterator
    in
    The delegate

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    FilterMatchesIterator(MatchesIterator in)
    Create a new FilterMatchesIterator

  • 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
    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