com.marklogic.client.admin.config

Class QueryOptions.Field

java.lang.Object

com.marklogic.client.admin.config.QueryOptions.Field

All Implemented Interfaces:

TupleSource

Enclosing class:

QueryOptions

public static class QueryOptions.Field
extends Object
implements TupleSource

Models a field. Fields are a MarkLogic server-side object to refer to sets of elements and attributes. They are referenced by name.

Constructor Summary

Constructors

Constructor and Description
QueryOptions.Field() Zero-argument constructor.
QueryOptions.Field(String name) Constructs the field with the name of the field.

Method Summary

Methods

Modifier and Type	Method and Description
void	build(Indexed indexable) Adds this field to the indexed specification.
void	build(QueryOptions.QueryTuples tuples) Adds this field to the tuples query specification.
void	build(QueryOptions.QueryValues values) Adds this field to the values query specification.
String	getName() Returns the name of the field.
void	setName(String name) Specifies the name of the field.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryOptions.Field

public QueryOptions.Field()

Zero-argument constructor.

QueryOptions.Field

public QueryOptions.Field(String name)

Constructs the field with the name of the field.

Parameters:

name - the field

Method Detail

build

public void build(QueryOptions.QueryTuples tuples)

Adds this field to the tuples query specification.

Specified by:

build in interface TupleSource

getName

public String getName()

Returns the name of the field.

Returns:

the field

setName

public void setName(String name)

Specifies the name of the field.

Parameters:

name - the field

build

public void build(Indexed indexable)

Adds this field to the indexed specification.

Parameters:

indexable - the index specification

build

public void build(QueryOptions.QueryValues values)

Adds this field to the values query specification.

Specified by:

build in interface TupleSource