org.apache.lucene.search

Class RangeFilter

java.lang.Object

org.apache.lucene.search.Filter

org.apache.lucene.search.RangeFilter

All Implemented Interfaces:

java.io.Serializable

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 RangeQuery, but is implemented as a Filter

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RangeFilter(java.lang.String fieldName, java.lang.String lowerTerm, java.lang.String upperTerm, boolean includeLower, boolean includeUpper)
RangeFilter(java.lang.String fieldName, java.lang.String lowerTerm, java.lang.String upperTerm, boolean includeLower, boolean includeUpper, java.text.Collator collator) WARNING: Using this constructor and supplying a non-null value in the collator parameter will cause every single index Term in the Field referenced by lowerTerm and/or upperTerm to be examined.

Method Summary

Modifier and Type	Method and Description
java.util.BitSet	bits(IndexReader reader) Deprecated. Use getDocIdSet(IndexReader) instead.
boolean	equals(java.lang.Object o) Returns true if o is equal to this.
DocIdSet	getDocIdSet(IndexReader reader) Returns a DocIdSet with documents that should be permitted in search results.
int	hashCode() Returns a hash code value for this object.
static RangeFilter	Less(java.lang.String fieldName, java.lang.String upperTerm) Constructs a filter for field fieldName matching less than or equal to upperTerm.
static RangeFilter	More(java.lang.String fieldName, java.lang.String lowerTerm) Constructs a filter for field fieldName matching greater than or equal to lowerTerm.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RangeFilter

public RangeFilter(java.lang.String fieldName,
                   java.lang.String lowerTerm,
                   java.lang.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:

java.lang.IllegalArgumentException - if both terms are null or if lowerTerm is null and includeLower is true (similar for upperTerm and includeUpper)

RangeFilter

public RangeFilter(java.lang.String fieldName,
                   java.lang.String lowerTerm,
                   java.lang.String upperTerm,
                   boolean includeLower,
                   boolean includeUpper,
                   java.text.Collator collator)

WARNING: Using this constructor and supplying a non-null value in the collator parameter will cause every single index Term in the Field referenced by lowerTerm and/or upperTerm to be examined. Depending on the number of index Terms in this Field, the operation could be very slow.

Parameters:

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?

collator - The collator to use when determining range inclusion; set to null to use Unicode code point ordering instead of collation.

Throws:

java.lang.IllegalArgumentException - if both terms are null or if lowerTerm is null and includeLower is true (similar for upperTerm and includeUpper)

Method Detail

Less

public static RangeFilter Less(java.lang.String fieldName,
                               java.lang.String upperTerm)

Constructs a filter for field fieldName matching less than or equal to upperTerm.

More

public static RangeFilter More(java.lang.String fieldName,
                               java.lang.String lowerTerm)

Constructs a filter for field fieldName matching greater than or equal to lowerTerm.

bits

public java.util.BitSet bits(IndexReader reader)
                      throws java.io.IOException

Deprecated. Use getDocIdSet(IndexReader) instead.

Returns a BitSet with true for documents which should be permitted in search results, and false for those that should not.

Overrides:

bits in class Filter

Returns:

A BitSet with true for documents which should be permitted in search results, and false for those that should not.

Throws:

java.io.IOException

getDocIdSet

public DocIdSet getDocIdSet(IndexReader reader)
                     throws java.io.IOException

Returns a DocIdSet with documents that should be permitted in search results.

Overrides:

getDocIdSet in class Filter

Returns:

a DocIdSet that provides the documents which should be permitted or prohibited in search results.

Throws:

java.io.IOException

See Also:

DocIdBitSet

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Returns true if o is equal to this.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Returns a hash code value for this object.

Overrides:

hashCode in class java.lang.Object