Class TermRangeTermEnum

  • All Implemented Interfaces:
    Closeable, AutoCloseable

    public class TermRangeTermEnum
    extends FilteredTermEnum
    Subclass of FilteredTermEnum for enumerating all terms that match the specified range parameters.

    Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it.

    Since:
    2.9
    • Constructor Detail

      • TermRangeTermEnum

        public TermRangeTermEnum​(IndexReader reader,
                                 String field,
                                 String lowerTermText,
                                 String upperTermText,
                                 boolean includeLower,
                                 boolean includeUpper,
                                 Collator collator)
                          throws IOException
        Enumerates all terms greater/equal than lowerTerm but less/equal than upperTerm. If an endpoint is null, it is said to be "open". Either or both endpoints may be open. Open endpoints may not be exclusive (you can't select all but the first or last term without explicitly specifying the term to exclude.)
        Parameters:
        reader -
        field - An interned field that holds both lower and upper terms.
        lowerTermText - The term text at the lower end of the range
        upperTermText - The term text at the upper end of the range
        includeLower - If true, the lowerTerm is included in the range.
        includeUpper - If true, the upperTerm is included in the range.
        collator - The collator to use to collate index Terms, to determine their membership in the range bounded by lowerTerm and upperTerm.
        Throws:
        IOException