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	Description
TextIndexDefinitionBuilder()

Method Summary

Modifier and Type	Method	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 wildcard.
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(@Nullable 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.
TextIndexDefinition.TextIndexDefinitionBuilder	withSimpleCollation()	Configure to use simple Collation.

Methods inherited from class Object

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

Constructor Details

TextIndexDefinitionBuilder

public TextIndexDefinitionBuilder()

Method Details

named

@Contract("_ -> this")
public TextIndexDefinition.TextIndexDefinitionBuilder named(String name)

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

Parameters:

name -

Returns:

onAllFields

@Contract("-> this")
public TextIndexDefinition.TextIndexDefinitionBuilder onAllFields()

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

Returns:

onFields

@Contract("_ -> this")
public TextIndexDefinition.TextIndexDefinitionBuilder onFields(String... fieldnames)

Include given fields with default weight.

Parameters:

fieldnames -

Returns:

onField

@Contract("_ -> this")
public TextIndexDefinition.TextIndexDefinitionBuilder onField(String fieldname)

Include given field with default weight.

Parameters:

fieldname -

Returns:

onField

@Contract("_, _ -> this")
public TextIndexDefinition.TextIndexDefinitionBuilder onField(String fieldname,
 Float weight)

Include given field with weight.

Parameters:

fieldname -

Returns:

withDefaultLanguage

@Contract("_ -> this")
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

@Contract("_ -> this")
public TextIndexDefinition.TextIndexDefinitionBuilder withLanguageOverride(String fieldname)

Define field for language override.

Parameters:

fieldname -

Returns:

partial

@Contract("_ -> this")
public TextIndexDefinition.TextIndexDefinitionBuilder partial(@Nullable 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/

withSimpleCollation

@Contract("-> this")
public TextIndexDefinition.TextIndexDefinitionBuilder withSimpleCollation()

Configure to use simple Collation. Required if the collection uses a non-simple collation.

Since:

2.2

build

@Contract("-> new")
public TextIndexDefinition build()