com.cloudant.client.api.query

Class TextIndex.Builder

java.lang.Object

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

com.cloudant.client.api.query.TextIndex.Builder

Enclosing class:

TextIndex

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

Class for building a definition for a text type index.

Field Summary

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

instance

Method Summary

Modifier and Type	Method and Description
TextIndex.Builder	analyzer(java.lang.String analyzer) Configure the analyzer for the text index.
TextIndex.Builder	bool(java.lang.String... fieldNames) Add a field containing boolean values to the text index configuration.
TextIndex.Builder	defaultField(boolean enabled, java.lang.String analyzer) Configure the default field for the text index.
TextIndex.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.
TextIndex.Builder	indexArrayLengths(boolean indexArrayLengths)
TextIndex.Builder	name(java.lang.String indexName) Configure the name of the index, if not set a name will be generated.
protected TextIndex	newInstance()
TextIndex.Builder	number(java.lang.String... fieldNames) Add one or more fields containing numerical values to the text index configuration.
TextIndex.Builder	partialFilterSelector(Selector selector) Configure a selector to choose documents that should be added to the index.
protected TextIndex.Builder	returnThis()
TextIndex.Builder	string(java.lang.String... fieldNames) Add one or more fields containing string values to the text index configuration.

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

returnThis

protected TextIndex.Builder returnThis()

Specified by:

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

name

public TextIndex.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<TextIndex,com.cloudant.client.api.query.TextIndex.Definition,TextIndex.Builder,TextIndex.Field>

Parameters:

indexName - name of the index

Returns:

the builder for chaining

designDocument

public TextIndex.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<TextIndex,com.cloudant.client.api.query.TextIndex.Definition,TextIndex.Builder,TextIndex.Field>

Parameters:

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

Returns:

the builder for chaining

partialFilterSelector

public TextIndex.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<TextIndex,com.cloudant.client.api.query.TextIndex.Definition,TextIndex.Builder,TextIndex.Field>

Parameters:

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

Returns:

the builder for chaining

See Also:

Selector, selector syntax

newInstance

protected TextIndex newInstance()

Specified by:

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

defaultField

public TextIndex.Builder defaultField(boolean enabled,
                                      java.lang.String analyzer)

Configure the default field for the text index.

Parameters:

enabled - true to enable the default field

analyzer - analyzer to use for the default field

Returns:

the builder for chaining

analyzer

public TextIndex.Builder analyzer(java.lang.String analyzer)

Configure the analyzer for the text index.

The analyzer can be a simple string or a more complex JSON object, as shown in the following examples:

Configure the "keyword" analyzer:

 
 TextIndex.builder().analyzer("keyword");
 
 

Configure different analyzers for different fields:

 
 String analyzerString = "{\"name\": \"perfield\"," +
     "\"default\": \"english\"," +
     "\"fields\": {" +
     "\"spanish\": \"spanish\"," +
     "\"german\": \"german\"}}";
 TextIndex.builder().analyzer(analyzerString);
 
 

Parameters:

analyzer - either a simple string or a complex JSON object, represented as a string

Returns:

the builder for chaining

See Also:

Cloudant Search Analyzers

indexArrayLengths

public TextIndex.Builder indexArrayLengths(boolean indexArrayLengths)

Parameters:

indexArrayLengths - true if the indexer should search for arrays and store their lengths

Returns:

the builder for chaining

string

public TextIndex.Builder string(java.lang.String... fieldNames)

Add one or more fields containing string values to the text index configuration.

Parameters:

fieldNames - names of the fields to index

Returns:

the builder for chaining

number

public TextIndex.Builder number(java.lang.String... fieldNames)

Add one or more fields containing numerical values to the text index configuration.

Parameters:

fieldNames - names of the fields to index

Returns:

the builder for chaining

bool

public TextIndex.Builder bool(java.lang.String... fieldNames)

Add a field containing boolean values to the text index configuration.

Parameters:

fieldNames - name of the field to index

Returns:

the builder for chaining