com.marklogic.client.admin.config

Class QueryOptions.QueryConstraint

java.lang.Object

com.marklogic.client.admin.config.QueryOptions.QueryConstraint

All Implemented Interfaces:

Annotatable<QueryOptions.QueryConstraint>

Enclosing class:

QueryOptions

public static class QueryOptions.QueryConstraint
extends Object
implements Annotatable<QueryOptions.QueryConstraint>

Models a constraint node in Search API configuration.

Constructor Summary

Constructors

Constructor and Description
QueryConstraint() Zero-argument constructor.
QueryConstraint(String name) Construct with the name of the constraint.

Method Summary

Modifier and Type	Method and Description
QueryOptions.QueryConstraint	annotate(String xmlAnnotation) Adds an annotation and returns the constraint.
List<QueryOptions.QueryAnnotation>	getAnnotations() Returns the list of annotations on the constraint.
String	getName() Returns the name of the constraint.
<T extends QueryOptions.BaseConstraintItem> T	getSource() Returns the constrained index.
void	setName(String name) Specifies the name of the constraint.
void	setSource(ConstraintSource constraintDefinition) Specifies the constrained index.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryConstraint

public QueryConstraint()

Zero-argument constructor.

QueryConstraint

public QueryConstraint(String name)

Construct with the name of the constraint.

Parameters:

name - the name of the constraint

Method Detail

getAnnotations

public List<QueryOptions.QueryAnnotation> getAnnotations()

Returns the list of annotations on the constraint.

Specified by:

getAnnotations in interface Annotatable<QueryOptions.QueryConstraint>

Returns:

the annotations

getName

public String getName()

Returns the name of the constraint.

Returns:

the name

getSource

public <T extends QueryOptions.BaseConstraintItem> T getSource()

Returns the constrained index.

Type Parameters:

T - the type of source

Returns:

the index specification

setName

public void setName(String name)

Specifies the name of the constraint.

Parameters:

name - the constraint name

setSource

public void setSource(ConstraintSource constraintDefinition)

Specifies the constrained index.

Parameters:

constraintDefinition - the index specification

annotate

public QueryOptions.QueryConstraint annotate(String xmlAnnotation)

Adds an annotation and returns the constraint.

Specified by:

annotate in interface Annotatable<QueryOptions.QueryConstraint>