com.day.cq.search.facets.buckets

Class ValueRangeBucket

java.lang.Object

com.day.cq.search.facets.buckets.SimpleBucket

com.day.cq.search.facets.buckets.PredefinedBucket

com.day.cq.search.facets.buckets.ValueRangeBucket

All Implemented Interfaces:

Bucket

public class ValueRangeBucket
extends PredefinedBucket

ValueRangeBucket is a bucket that stands for an interval of values.

Since:

5.2

Constructor Summary

Constructors

Constructor and Description
ValueRangeBucket(java.lang.String name, java.lang.Comparable from, boolean fromIncluded, java.lang.Comparable to, boolean toIncluded, Predicate predicate) Creates an interval matching bucket.

Method Summary

Modifier and Type	Method and Description
void	acceptValue(Value value) Accepts the value and increments the counter of this bucket if the value matches this buckets definition.
java.lang.Comparable	getFrom()
java.lang.Comparable	getTo()

Methods inherited from class com.day.cq.search.facets.buckets.SimpleBucket

getCount, getPredicate, getValue, increment

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValueRangeBucket

public ValueRangeBucket(java.lang.String name,
                        java.lang.Comparable from,
                        boolean fromIncluded,
                        java.lang.Comparable to,
                        boolean toIncluded,
                        Predicate predicate)

Creates an interval matching bucket.

Parameters:

name - name of this bucket (for display)

from - lower end of interval

fromIncluded - if true, will include the from value in the interval, ie. use >=

to - upper end of interval

toIncluded - if true, will include the to value in the interval, ie. use <=

predicate - the predicate representing this bucket

Method Detail

getFrom

public java.lang.Comparable getFrom()

Returns:

the lower bound or null if none is set.

getTo

public java.lang.Comparable getTo()

Returns:

the upper bound or null if none is set.

acceptValue

public void acceptValue(Value value)
                 throws RepositoryException

Accepts the value and increments the counter of this bucket if the value matches this buckets definition.

Specified by:

acceptValue in class PredefinedBucket

Parameters:

value - the value to accept.

Throws:

RepositoryException - if an error occurs while reading from the repository.