com.couchbase.lite

Class IndexOptions

java.lang.Object

com.couchbase.lite.IndexOptions

public class IndexOptions
extends Object

Options for creating a database index.

Constructor Summary

Constructors

Constructor and Description
IndexOptions() Create an IndexOptions with default values.
IndexOptions(String language, boolean ignoreDiacritics) Create an IndexOptions with the given language and ignoreDiacritics value.

Method Summary

Modifier and Type	Method and Description
String	getLanguage() Get the language option.
boolean	isIgnoreDiacritics() Get the ignoring diacritics option.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexOptions

public IndexOptions()

Create an IndexOptions with default values.

The default language is null, which means using the language of the current locale. The default ignoreDiacritics is false, which means not ignoring accents/diacritical marks.

IndexOptions

public IndexOptions(String language,
                    boolean ignoreDiacritics)

Create an IndexOptions with the given language and ignoreDiacritics value.

Parameters:

language - the language code, e.g. "en" or "de". This affects how word breaks and word stems are parsed. Use null for current locale and "" to disable stemming.

ignoreDiacritics - true to ignore accents/diacritical marks.

Method Detail

getLanguage

public String getLanguage()

Get the language option.

Returns:

the language option.

isIgnoreDiacritics

public boolean isIgnoreDiacritics()

Get the ignoring diacritics option.

Returns:

the ignoring diacritics option.