Class TermRangeQuery

  • All Implemented Interfaces:
    java.lang.Cloneable

    public class TermRangeQuery
    extends MultiTermQuery
    A Query that matches documents within an range of terms.

    This query matches the documents looking for terms that fall into the supplied range according to Byte.compareTo(Byte). It is not intended for numerical ranges; use NumericRangeQuery instead.

    This query uses the MultiTermQuery.CONSTANT_SCORE_AUTO_REWRITE_DEFAULT rewrite method.

    Since:
    2.9
    • Constructor Detail

      • TermRangeQuery

        public TermRangeQuery​(java.lang.String field,
                              BytesRef lowerTerm,
                              BytesRef upperTerm,
                              boolean includeLower,
                              boolean includeUpper)
        Constructs a query selecting 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:
        field - The field that holds both lower and upper terms.
        lowerTerm - The term text at the lower end of the range
        upperTerm - 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.
    • Method Detail

      • newStringRange

        public static TermRangeQuery newStringRange​(java.lang.String field,
                                                    java.lang.String lowerTerm,
                                                    java.lang.String upperTerm,
                                                    boolean includeLower,
                                                    boolean includeUpper)
        Factory that creates a new TermRangeQuery using Strings for term text.
      • getLowerTerm

        public BytesRef getLowerTerm()
        Returns the lower value of this range query
      • getUpperTerm

        public BytesRef getUpperTerm()
        Returns the upper value of this range query
      • includesLower

        public boolean includesLower()
        Returns true if the lower endpoint is inclusive
      • includesUpper

        public boolean includesUpper()
        Returns true if the upper endpoint is inclusive
      • toString

        public java.lang.String toString​(java.lang.String field)
        Prints a user-readable version of this query.
        Specified by:
        toString in class Query
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class MultiTermQuery