com.cloudant.client.api.query

Class TextIndex

java.lang.Object

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

com.cloudant.client.api.query.TextIndex

All Implemented Interfaces:

Index<TextIndex.Field>

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

Class model of a text index definition.

This class should not be instantiated directly, use TextIndex.Builder to create a text index definition string to pass to Database.createIndex(String) or use Database.listIndexes() and Indexes.textIndexes() to retrieve existing text index definitions.

See Also:

Database.createIndex(String)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextIndex.Builder Class for building a definition for a text type index.
static class	TextIndex.Field Model of a field in the text index including the field name and type.

Field Summary

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

ddoc, def, name

Method Summary

Modifier and Type	Method and Description
static TextIndex.Builder	builder() Get a new instance of a builder to configure a TextIndex.
java.lang.String	getAnalyzer() Get the JSON string representation of the analyzer configured for this text index.
java.lang.String	getDefaultField() Get the JSON string representation of the default field configuration.
boolean	getIndexArrayLengths()

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

getDesignDocumentID, getFields, getName, getPartialFilterSelector, getType

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static TextIndex.Builder builder()

Get a new instance of a builder to configure a TextIndex.

Returns:

a builder for configuring a TextIndex

getDefaultField

public java.lang.String getDefaultField()

Get the JSON string representation of the default field configuration.

Returns:

default field JSON as string

getAnalyzer

public java.lang.String getAnalyzer()

Get the JSON string representation of the analyzer configured for this text index.

Returns:

analyzer JSON as string

getIndexArrayLengths

public boolean getIndexArrayLengths()

Returns:

true if this index is configured to scan documents for arrays and store their lengths