com.cloudant.client.api.query

Class JsonIndex.Builder

java.lang.Object

com.cloudant.client.internal.query.Builder<JsonIndex,com.cloudant.client.api.query.JsonIndex.Definition,JsonIndex.Builder,JsonIndex.Field>

com.cloudant.client.api.query.JsonIndex.Builder

Enclosing class:

JsonIndex

public static class JsonIndex.Builder
extends com.cloudant.client.internal.query.Builder<JsonIndex,com.cloudant.client.api.query.JsonIndex.Definition,JsonIndex.Builder,JsonIndex.Field>

Class for building a definition for a JSON type index.

Field Summary

Fields inherited from class com.cloudant.client.internal.query.Builder

instance

Method Summary

Modifier and Type	Method and Description
JsonIndex.Builder	asc(java.lang.String... fieldNames) Add one or more fields to the JsonIndex configuration in ascending order.
JsonIndex.Builder	desc(java.lang.String... fieldNames) Add one or more fields to the JsonIndex configuration in descending order.
JsonIndex.Builder	designDocument(java.lang.String designDocumentId) Configure the design document name, if not set a new design document will be created with a generated name.
JsonIndex.Builder	name(java.lang.String indexName) Configure the name of the index, if not set a name will be generated.
protected JsonIndex	newInstance()
JsonIndex.Builder	partialFilterSelector(Selector selector) Configure a selector to choose documents that should be added to the index.
protected JsonIndex.Builder	returnThis()

Methods inherited from class com.cloudant.client.internal.query.Builder

definition, fields

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

protected JsonIndex newInstance()

Specified by:

newInstance in class com.cloudant.client.internal.query.Builder<JsonIndex,com.cloudant.client.api.query.JsonIndex.Definition,JsonIndex.Builder,JsonIndex.Field>

returnThis

protected JsonIndex.Builder returnThis()

Specified by:

returnThis in class com.cloudant.client.internal.query.Builder<JsonIndex,com.cloudant.client.api.query.JsonIndex.Definition,JsonIndex.Builder,JsonIndex.Field>

name

public JsonIndex.Builder name(java.lang.String indexName)

Configure the name of the index, if not set a name will be generated.

Overrides:

name in class com.cloudant.client.internal.query.Builder<JsonIndex,com.cloudant.client.api.query.JsonIndex.Definition,JsonIndex.Builder,JsonIndex.Field>

Parameters:

indexName - name of the index

Returns:

the builder for chaining

designDocument

public JsonIndex.Builder designDocument(java.lang.String designDocumentId)

Configure the design document name, if not set a new design document will be created with a generated name.

Overrides:

designDocument in class com.cloudant.client.internal.query.Builder<JsonIndex,com.cloudant.client.api.query.JsonIndex.Definition,JsonIndex.Builder,JsonIndex.Field>

Parameters:

designDocumentId - design document ID (the _design prefix is added if not supplied)

Returns:

the builder for chaining

partialFilterSelector

public JsonIndex.Builder partialFilterSelector(Selector selector)

Configure a selector to choose documents that should be added to the index.

Obtain a selector from an Operation or Expression.

Overrides:

partialFilterSelector in class com.cloudant.client.internal.query.Builder<JsonIndex,com.cloudant.client.api.query.JsonIndex.Definition,JsonIndex.Builder,JsonIndex.Field>

Parameters:

selector - Selector object describing criteria used to add documents to index

Returns:

the builder for chaining

See Also:

Selector, selector syntax

asc

public JsonIndex.Builder asc(java.lang.String... fieldNames)

Add one or more fields to the JsonIndex configuration in ascending order.

Parameters:

fieldNames - names of the fields to index

Returns:

the builder for chaining

desc

public JsonIndex.Builder desc(java.lang.String... fieldNames)

Add one or more fields to the JsonIndex configuration in descending order.

Parameters:

fieldNames - names of the fields to index

Returns:

the builder for chaining