org.apache.lucene.facet.range

Class LongRange

java.lang.Object

org.apache.lucene.facet.range.Range

org.apache.lucene.facet.range.LongRange

public final class LongRange
extends Range

Represents a range over long values.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
long	max Maximum.
boolean	maxInclusive True if the maximum value is inclusive.
long	min Minimum.
boolean	minInclusive True if the minimum value is inclusive.

Fields inherited from class org.apache.lucene.facet.range.Range

label

Constructor Summary

Constructors

Constructor and Description
LongRange(String label, long minIn, boolean minInclusive, long maxIn, boolean maxInclusive) Create a LongRange.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(long value) True if this range accepts the provided value.
Query	getQuery(Query fastMatchQuery, ValueSource valueSource) Returns a new Query accepting only documents in this range.
String	toString()

Methods inherited from class org.apache.lucene.facet.range.Range

failNoMatch, getQuery

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

min

public final long min

Minimum.

max

public final long max

Maximum.

minInclusive

public final boolean minInclusive

True if the minimum value is inclusive.

maxInclusive

public final boolean maxInclusive

True if the maximum value is inclusive.

Constructor Detail

LongRange

public LongRange(String label,
         long minIn,
         boolean minInclusive,
         long maxIn,
         boolean maxInclusive)

Create a LongRange.

Method Detail

accept

public boolean accept(long value)

True if this range accepts the provided value.

toString

public String toString()

Overrides:

toString in class Object

getQuery

public Query getQuery(Query fastMatchQuery,
             ValueSource valueSource)

Description copied from class: Range

Returns a new Query accepting only documents in this range. This query might not be very efficient when run on its own since it is optimized towards random-access, so it is best used either with DrillDownQuery or when intersected with another query that can lead the iteration. If the ValueSource is static, e.g. an indexed numeric field, then it may be more efficient to use NumericRangeQuery. The provided fastMatchQuery, if non-null, will first be consulted, and only if that is set for each document will the range then be checked.

Specified by:

getQuery in class Range