Package org.springframework.data.mongodb.core.index

Class TextIndexDefinition

java.lang.Object

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

All Implemented Interfaces:

IndexDefinition

public class TextIndexDefinition
extends Object
implements IndexDefinition

IndexDefinition to span multiple keys for text search.

Since:

1.6

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextIndexDefinition.TextIndexDefinitionBuilder	TextIndexDefinition.TextIndexDefinitionBuilder helps defining options for creating TextIndexDefinition.
static class	TextIndexDefinition.TextIndexedFieldSpec

Method Summary

Modifier and Type	Method	Description
void	addFieldSpec(TextIndexDefinition.TextIndexedFieldSpec fieldSpec)
void	addFieldSpecs(Collection<TextIndexDefinition.TextIndexedFieldSpec> fieldSpecs)
static TextIndexDefinition.TextIndexDefinitionBuilder	builder()	Get TextIndexDefinition.TextIndexDefinitionBuilder to create TextIndexDefinition.
static TextIndexDefinition	forAllFields()	Creates a TextIndexDefinition for all fields in the document.
org.bson.Document	getIndexKeys()	Get the Document containing properties covered by the index.
org.bson.Document	getIndexOptions()	Get the index properties such as unique,...
boolean	hasFieldSpec()	Returns if the TextIndexDefinition has fields assigned.

Methods inherited from class java.lang.Object

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

Method Details

forAllFields

public static TextIndexDefinition forAllFields()

Creates a TextIndexDefinition for all fields in the document.

Returns:

builder

public static TextIndexDefinition.TextIndexDefinitionBuilder builder()

Get TextIndexDefinition.TextIndexDefinitionBuilder to create TextIndexDefinition.

Returns:

addFieldSpec

public void addFieldSpec(TextIndexDefinition.TextIndexedFieldSpec fieldSpec)

Parameters:

fieldSpec -

addFieldSpecs

public void addFieldSpecs(Collection<TextIndexDefinition.TextIndexedFieldSpec> fieldSpecs)

Parameters:

fieldSpecs -

hasFieldSpec

public boolean hasFieldSpec()

Returns if the TextIndexDefinition has fields assigned.

Returns:

getIndexKeys

public org.bson.Document getIndexKeys()

Description copied from interface: IndexDefinition

Get the Document containing properties covered by the index.

Specified by:

getIndexKeys in interface IndexDefinition

Returns:

never null.

getIndexOptions

public org.bson.Document getIndexOptions()

Description copied from interface: IndexDefinition

Get the index properties such as unique,...

Specified by:

getIndexOptions in interface IndexDefinition

Returns:

never null.