com.marklogic.client.admin.config

Class QueryOptions.QueryCustom

java.lang.Object

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

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

com.marklogic.client.admin.config.QueryOptions.QueryCustom

All Implemented Interfaces:

Annotatable<QueryOptions.QueryCustom>, ConstraintSource, TermOptions

Enclosing class:

QueryOptions

public static class QueryOptions.QueryCustom
extends QueryOptions.FacetableConstraintConfiguration
implements TermOptions, ConstraintSource, Annotatable<QueryOptions.QueryCustom>

A custom constraint. Custom constraints use XQuery extensions to implement parsing and faceting functionality.

Constructor Summary

Constructors

Constructor and Description
QueryOptions.QueryCustom(boolean doFacets) Constructor for the custom constraint.
QueryOptions.QueryCustom(boolean doFacets, QueryOptions.XQueryExtension parseExtension) Constructor for the custom constraint.

Method Summary

Methods

Modifier and Type	Method and Description
QueryOptions.QueryCustom	annotate(String xmlString) Adds an annotation, returning this custom constraint.
List<QueryOptions.QueryAnnotation>	getAnnotations() Gets the annotations on this custom constraint.
QueryOptions.XQueryExtension	getFinishFacet() Returns the XQuery function called to finish the facet.
QueryOptions.XQueryExtension	getParse() Returns the XQuery function called to implement the custom constraint.
QueryOptions.XQueryExtension	getStartFacet() Returns the XQuery function called to start the facet.
void	setFinishFacet(QueryOptions.XQueryExtension finishFacet) Specifies an XQuery function called to finish the facet.
void	setParse(QueryOptions.XQueryExtension parse) Specifies an XQuery function called to implement the custom constraint.
void	setStartFacet(QueryOptions.XQueryExtension startFacet) Specifies an XQuery function called to start the facet.

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.TermOptions

getTermOptions, getWeight, setTermOptions, setWeight

Constructor Detail

QueryOptions.QueryCustom

public QueryOptions.QueryCustom(boolean doFacets)

Constructor for the custom constraint.

Parameters:

doFacets - whether to build a facet on the custom constraint

QueryOptions.QueryCustom

public QueryOptions.QueryCustom(boolean doFacets,
                        QueryOptions.XQueryExtension parseExtension)

Constructor for the custom constraint.

Parameters:

doFacets - whether to build a facet on the custom constraint

parseExtension - the identification of the XQuery function that implements the custom constraint

Method Detail

getAnnotations

public List<QueryOptions.QueryAnnotation> getAnnotations()

Gets the annotations on this custom constraint.

Specified by:

getAnnotations in interface Annotatable<QueryOptions.QueryCustom>

annotate

public QueryOptions.QueryCustom annotate(String xmlString)

Adds an annotation, returning this custom constraint.

Specified by:

annotate in interface Annotatable<QueryOptions.QueryCustom>

getFinishFacet

public QueryOptions.XQueryExtension getFinishFacet()

Returns the XQuery function called to finish the facet.

Returns:

the identification of the XQuery function

getParse

public QueryOptions.XQueryExtension getParse()

Returns the XQuery function called to implement the custom constraint.

Returns:

the identification of the XQuery function

getStartFacet

public QueryOptions.XQueryExtension getStartFacet()

Returns the XQuery function called to start the facet.

Returns:

the identification of the XQuery function

setFinishFacet

public void setFinishFacet(QueryOptions.XQueryExtension finishFacet)

Specifies an XQuery function called to finish the facet.

Parameters:

finishFacet - the identification of the XQuery function

setParse

public void setParse(QueryOptions.XQueryExtension parse)

Specifies an XQuery function called to implement the custom constraint.

Parameters:

parse - the identification of the XQuery function

setStartFacet

public void setStartFacet(QueryOptions.XQueryExtension startFacet)

Specifies an XQuery function called to start the facet.

Parameters:

startFacet - the identification of the XQuery function