org.springframework.data.mongodb.core.index

Class TextIndexDefinition.TextIndexDefinitionBuilder

java.lang.Object

org.springframework.data.mongodb.core.index.TextIndexDefinition.TextIndexDefinitionBuilder

Enclosing class:

TextIndexDefinition

public static class TextIndexDefinition.TextIndexDefinitionBuilder
extends Object

TextIndexDefinition.TextIndexDefinitionBuilder helps defining options for creating TextIndexDefinition.

Since:

1.6

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor and Description
TextIndexDefinitionBuilder()

Method Summary

Modifier and Type	Method and Description
TextIndexDefinition	build()
TextIndexDefinition.TextIndexDefinitionBuilder	named(String name) Define the name to be used when creating the index in the store.
TextIndexDefinition.TextIndexDefinitionBuilder	onAllFields() Define the index to span all fields using wilcard.
TextIndexDefinition.TextIndexDefinitionBuilder	onField(String fieldname) Include given field with default weight.
TextIndexDefinition.TextIndexDefinitionBuilder	onField(String fieldname, Float weight) Include given field with weight.
TextIndexDefinition.TextIndexDefinitionBuilder	onFields(String... fieldnames) Include given fields with default weight.
TextIndexDefinition.TextIndexDefinitionBuilder	partial(IndexFilter filter) Only index the documents that meet the specified filter expression.
TextIndexDefinition.TextIndexDefinitionBuilder	withDefaultLanguage(String language) Define the default language to be used when indexing documents.
TextIndexDefinition.TextIndexDefinitionBuilder	withLanguageOverride(String fieldname) Define field for language override.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextIndexDefinitionBuilder

public TextIndexDefinitionBuilder()

Method Detail

named

public TextIndexDefinition.TextIndexDefinitionBuilder named(String name)

Define the name to be used when creating the index in the store.

Parameters:

name -

Returns:

onAllFields

public TextIndexDefinition.TextIndexDefinitionBuilder onAllFields()

Define the index to span all fields using wilcard.
NOTE TextIndexDefinition cannot contain any other fields when defined with wildcard.

Returns:

onFields

public TextIndexDefinition.TextIndexDefinitionBuilder onFields(String... fieldnames)

Include given fields with default weight.

Parameters:

fieldnames -

Returns:

onField

public TextIndexDefinition.TextIndexDefinitionBuilder onField(String fieldname)

Include given field with default weight.

Parameters:

fieldname -

Returns:

onField

public TextIndexDefinition.TextIndexDefinitionBuilder onField(String fieldname,
                                                              Float weight)

Include given field with weight.

Parameters:

fieldname -

Returns:

withDefaultLanguage

public TextIndexDefinition.TextIndexDefinitionBuilder withDefaultLanguage(String language)

Define the default language to be used when indexing documents.

Parameters:

language -

Returns:

See Also:

https://docs.mongodb.org/manual/tutorial/specify-language-for-text-index/#specify-default-language-text-index

withLanguageOverride

public TextIndexDefinition.TextIndexDefinitionBuilder withLanguageOverride(String fieldname)

Define field for language override.

Parameters:

fieldname -

Returns:

partial

public TextIndexDefinition.TextIndexDefinitionBuilder partial(IndexFilter filter)

Only index the documents that meet the specified filter expression.

Parameters:

filter - can be null.

Returns:

Since:

1.10

See Also:

https://docs.mongodb.com/manual/core/index-partial/

build

public TextIndexDefinition build()