com.marklogic.client.admin.config

Class QueryOptions.QueryRange

java.lang.Object

com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem

com.marklogic.client.admin.config.QueryOptions.FacetableConstraintConfiguration

com.marklogic.client.admin.config.QueryOptions.QueryRange

All Implemented Interfaces:

ConstraintSource, Indexed, RangeIndexed, TermSource, TupleSource

Enclosing class:

QueryOptions

public static final class QueryOptions.QueryRange
extends QueryOptions.FacetableConstraintConfiguration
implements TupleSource, ConstraintSource, RangeIndexed, TermSource

Models a range constraint source. A QueryRange is a child of a QueryConstraint and contains facet and index source configuration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryOptions.QueryRange.Bucket Configures a range, for use in grouping range index values in facets.
static class	QueryOptions.QueryRange.ComputedBucket Models a bucket on a range constraint whose values are anchored to time, and computed based on the current time.

Constructor Summary

Constructors

Constructor and Description
QueryRange() Zero-argument constructor.

Method Summary

Modifier and Type	Method and Description
void	addBucket(QueryOptions.QueryRange.Bucket bucket) Add a bucket to this QueryRange's buckets.
void	addBuckets(List<Buckets> buckets) Add a list of buckets to the buckets for this QueryRange.
QueryOptions.QueryRange	addComputedBucket(QueryOptions.QueryRange.ComputedBucket computedBucket) Add a computed bucket to this QueryRange's buckets.
void	build(QueryOptions.QueryTuples tuples) Add this QueryRange to the tuples query.
void	build(QueryOptions.QueryValues values) Add this QueryRange to the values query.
void	deleteBuckets() remove all computed and defined buckets from a RangeOption
List<QueryOptions.QueryRange.Bucket>	getBuckets() Returns the list of buckets for this QueryRange.
List<QueryOptions.QueryRange.ComputedBucket>	getComputedBuckets() The list of computed buckets for this QueryRange.

Methods inherited from class com.marklogic.client.admin.config.QueryOptions.FacetableConstraintConfiguration

addFacetOption, doFacets, getCollation, getDoFacets, getFacetOptions, getType, setCollation, setDoFacets, setFacetOptions, setType

Methods inherited from class com.marklogic.client.admin.config.QueryOptions.BaseConstraintItem

addTermOption, getAttribute, getElement, getFieldName, getFragmentScope, getJsonKeyName, getPath, getPathIndex, getPathNamespaceBindings, getTermOptions, getWeight, setAttribute, setElement, setField, setFragmentScope, setJsonKey, setPath, setTermOptions, setWeight

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.marklogic.client.admin.config.support.RangeIndexed

setCollation, setType

Methods inherited from interface com.marklogic.client.admin.config.support.Indexed

setAttribute, setElement, setField, setJsonKey, setPath

Methods inherited from interface com.marklogic.client.admin.config.support.TermSource

getTermOptions

Constructor Detail

QueryRange

public QueryRange()

Zero-argument constructor.

Method Detail

addBucket

public void addBucket(QueryOptions.QueryRange.Bucket bucket)

Add a bucket to this QueryRange's buckets.

Parameters:

bucket - a Bucket object for use with this QueryRange

addComputedBucket

public QueryOptions.QueryRange addComputedBucket(QueryOptions.QueryRange.ComputedBucket computedBucket)

Add a computed bucket to this QueryRange's buckets.

Parameters:

computedBucket - a ComputedBucket object for use with this QueryRange

Returns:

this QueryRange

deleteBuckets

public void deleteBuckets()

remove all computed and defined buckets from a RangeOption

getBuckets

public List<QueryOptions.QueryRange.Bucket> getBuckets()

Returns the list of buckets for this QueryRange.

Returns:

the bucket list

getComputedBuckets

public List<QueryOptions.QueryRange.ComputedBucket> getComputedBuckets()

The list of computed buckets for this QueryRange.

Returns:

the bucket list

addBuckets

public void addBuckets(List<Buckets> buckets)

Add a list of buckets to the buckets for this QueryRange.

Parameters:

buckets - the bucket list

build

public void build(QueryOptions.QueryTuples tuples)

Add this QueryRange to the tuples query.

Specified by:

build in interface TupleSource

build

public void build(QueryOptions.QueryValues values)

Add this QueryRange to the values query.

Specified by:

build in interface TupleSource