com.marklogic.client.admin.config

Class QueryOptions.QueryCollection

java.lang.Object

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

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

com.marklogic.client.admin.config.QueryOptions.QueryCollection

All Implemented Interfaces:

ConstraintSource, TupleSource

Enclosing class:

QueryOptions

public static class QueryOptions.QueryCollection
extends QueryOptions.FacetableConstraintConfiguration
implements TupleSource, ConstraintSource

Models a constraint on collection URIs.

Constructor Summary

Constructors

Constructor and Description
QueryCollection()

Method Summary

Modifier and Type	Method and Description
void	build(QueryOptions.QueryTuples tuples) Add this QueryCollection to the tuples query.
void	build(QueryOptions.QueryValues values) Add this QueryCollection to the values query.
String	getPrefix() The prefix to be removed from collectionOption URIs in generating facet labels.
void	setPrefix(String prefix) Set the collectionOption prefix, returning the modified CollectionOption object.

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

Constructor Detail

QueryCollection

public QueryCollection()

Method Detail

getPrefix

public String getPrefix()

The prefix to be removed from collectionOption URIs in generating facet labels.

Returns:

the prefix

setPrefix

public void setPrefix(String prefix)

Set the collectionOption prefix, returning the modified CollectionOption object.

Parameters:

prefix - The prefix to be removed from collectionOption URIs in generating facet labels.

build

public void build(QueryOptions.QueryTuples tuples)

Add this QueryCollection to the tuples query.

Specified by:

build in interface TupleSource

build

public void build(QueryOptions.QueryValues values)

Add this QueryCollection to the values query.

Specified by:

build in interface TupleSource