org.apache.lucene.search

Class RangeFilter

public class RangeFilter extends Filter

A Filter that restricts search results to a range of values in a given field.

This code borrows heavily from {@link RangeQuery}, but is implemented as a Filter (much like {@link DateFilter}).

Constructor Summary
RangeFilter(String fieldName, String lowerTerm, String upperTerm, boolean includeLower, boolean includeUpper)
Method Summary
BitSetbits(IndexReader reader)
Returns a BitSet with true for documents which should be permitted in search results, and false for those that should not.
booleanequals(Object o)
Returns true if o is equal to this.
inthashCode()
Returns a hash code value for this object.
static RangeFilterLess(String fieldName, String upperTerm)
Constructs a filter for field fieldName matching less than or equal to upperTerm.
static RangeFilterMore(String fieldName, String lowerTerm)
Constructs a filter for field fieldName matching greater than or equal to lowerTerm.
StringtoString()

Constructor Detail

RangeFilter

public RangeFilter(String fieldName, String lowerTerm, String upperTerm, boolean includeLower, boolean includeUpper)

Parameters: fieldName The field this range applies to lowerTerm The lower bound on this range upperTerm The upper bound on this range includeLower Does this range include the lower bound? includeUpper Does this range include the upper bound?

Throws: IllegalArgumentException if both terms are null or if lowerTerm is null and includeLower is true (similar for upperTerm and includeUpper)

Method Detail

bits

public BitSet bits(IndexReader reader)
Returns a BitSet with true for documents which should be permitted in search results, and false for those that should not.

equals

public boolean equals(Object o)
Returns true if o is equal to this.

hashCode

public int hashCode()
Returns a hash code value for this object.

Less

public static RangeFilter Less(String fieldName, String upperTerm)
Constructs a filter for field fieldName matching less than or equal to upperTerm.

More

public static RangeFilter More(String fieldName, String lowerTerm)
Constructs a filter for field fieldName matching greater than or equal to lowerTerm.

toString

public String toString()
Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.