com.marklogic.client.admin.config

Class QueryOptions.BaseConstraintItem

java.lang.Object

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

Direct Known Subclasses:

QueryOptions.FacetableConstraintConfiguration, QueryOptions.QueryElementQuery, QueryOptions.QueryGeospatialAttributePair, QueryOptions.QueryGeospatialElement, QueryOptions.QueryGeospatialElementPair, QueryOptions.QueryProperties, QueryOptions.QueryValue, QueryOptions.QueryWord

Enclosing class:

QueryOptions

public abstract static class QueryOptions.BaseConstraintItem
extends Object

Partial implementation of A ConstraintSource. Each constraint in the MarkLogic Search API is of a certain type. This class is the root of the class hierarchy of Range, Word, Value, and so forth. Note: This partial implementation contains convenience methods for helping with index definitions, which are not applicable to all constraint types.

Constructor Summary

Constructors

Constructor and Description
QueryOptions.BaseConstraintItem() Construct a new BaseConstraintItem

Method Summary

Methods

Modifier and Type	Method and Description
void	addTermOption(String termOption) Adds a term option to this data source.
QName	getAttribute() Gets the XML QName referring to an attribute.
QName	getElement() Gets the XML QName referring to an element.
String	getFieldName() Gets the name of a field that backs this constraint.
QueryOptions.FragmentScope	getFragmentScope() Gets the FragmenScope of this constraint source.
String	getJsonKeyName() Gets the name of a json key that backs this constraint.
String	getPath() Gets the string representing a path index data source.
QueryOptions.PathIndex	getPathIndex() Gets the path index object that backs this data source.
NamespaceContext	getPathNamespaceBindings() Gets the namespace context in scope for a path index configuration.
List<String>	getTermOptions() Gets the term options for this constraint source.
Double	getWeight() Gets the relative weight assigned to this constraint source.
void	setAttribute(QueryOptions.MarkLogicQName attribute) Sets an attribute QName to partially find an element-attribute index.
void	setElement(QueryOptions.MarkLogicQName element) Sets an element QName to reference an element.
void	setField(QueryOptions.Field field) Sets a field to back this constraint source.
void	setFragmentScope(QueryOptions.FragmentScope fragmentScope) Sets a fragment scope for this constraint source.
void	setJsonKey(QueryOptions.JsonKey jsonKey) Sets a json key index specification for this constraint source.
void	setPath(QueryOptions.PathIndex pathIndex) Sets a path index specification for this constraint source.
void	setTermOptions(List<String> termOptions) Sets the term options for this constraint source.
void	setWeight(Double weight) Sets the relative weight for this constraint source.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryOptions.BaseConstraintItem

public QueryOptions.BaseConstraintItem()

Construct a new BaseConstraintItem

Method Detail

addTermOption

public void addTermOption(String termOption)

Adds a term option to this data source.

Parameters:

termOption - A term option.

getAttribute

public QName getAttribute()

Gets the XML QName referring to an attribute.

Returns:

The attribute QName. Returns null if this object does not contain an element-attribute index specification.

getElement

public QName getElement()

Gets the XML QName referring to an element.

Returns:

The element QName. Returns null if this object does not contain an element-attribute or element index specification.

getPath

public String getPath()

Gets the string representing a path index data source.

Returns:

The XPath string. Returns null if this object does not contain a path index specification.

getPathNamespaceBindings

public NamespaceContext getPathNamespaceBindings()

Gets the namespace context in scope for a path index configuration.

Returns:

The namespace context with bindings. Returns null if this object does not contain a path index specification.

getPathIndex

public QueryOptions.PathIndex getPathIndex()

Gets the path index object that backs this data source.

Returns:

A PathIndex object containing an XPath expression and namespace bindings. Returns null if this object does not contain a path index specification.

getFieldName

public String getFieldName()

Gets the name of a field that backs this constraint.

Returns:

The field name. Returns null if this is not a field-index-backed constraint.

getJsonKeyName

public String getJsonKeyName()

Gets the name of a json key that backs this constraint.

Returns:

The field name. Returns null if this is not a json-key-index-backed constraint.

getFragmentScope

public QueryOptions.FragmentScope getFragmentScope()

Gets the FragmenScope of this constraint source.

Returns:

The fragmentScope. Returns null if this constraint source relies on system default.

getTermOptions

public List<String> getTermOptions()

Gets the term options for this constraint source.

Returns:

The list of term options.

getWeight

public Double getWeight()

Gets the relative weight assigned to this constraint source.

Returns:

The weight. Returns null if not defined. Undefined weights are interpreted as 1.0.

setAttribute

public void setAttribute(QueryOptions.MarkLogicQName attribute)

Sets an attribute QName to partially find an element-attribute index.

Parameters:

attribute - The attribute QName. To be meaningful needs setElement to be called as well.

setElement

public void setElement(QueryOptions.MarkLogicQName element)

Sets an element QName to reference an element.

Parameters:

element - The element QName.

setField

public void setField(QueryOptions.Field field)

Sets a field to back this constraint source.

Parameters:

field - The field object.

setPath

public void setPath(QueryOptions.PathIndex pathIndex)

Sets a path index specification for this constraint source.

Parameters:

pathIndex - The path index specification.

setJsonKey

public void setJsonKey(QueryOptions.JsonKey jsonKey)

Sets a json key index specification for this constraint source.

Parameters:

jsonKey - The json key.

setFragmentScope

public void setFragmentScope(QueryOptions.FragmentScope fragmentScope)

Sets a fragment scope for this constraint source.

Parameters:

fragmentScope - the fragment scope.

setTermOptions

public void setTermOptions(List<String> termOptions)

Sets the term options for this constraint source.

Parameters:

termOptions - A list of term options.

setWeight

public void setWeight(Double weight)

Sets the relative weight for this constraint source.

Parameters:

weight - The weight.