Package com.mongodb.client.model.search

Interface FieldSearchPath

All Superinterfaces:

Bson, SearchPath

@Sealed
@Beta(CLIENT)
public interface FieldSearchPath
extends SearchPath

Since:

4.7

See Also:

• SearchPath.fieldPath(String)

Field Summary

Fields inherited from interface org.bson.conversions.Bson

DEFAULT_CODEC_REGISTRY

Method Summary

Modifier and Type	Method	Description
FieldSearchPath	multi(String analyzerName)	Creates a new FieldSearchPath with the name of the alternate analyzer specified.
default String	toValue()	Returns the name of the field represented by this path.

Methods inherited from interface org.bson.conversions.Bson

toBsonDocument, toBsonDocument

Methods inherited from interface com.mongodb.client.model.search.SearchPath

toBsonValue

Method Details

multi

FieldSearchPath multi(String analyzerName)

Creates a new FieldSearchPath with the name of the alternate analyzer specified.

Parameters:

analyzerName - The name of the alternate analyzer.

Returns:

A new FieldSearchPath.

toValue

default String toValue()

Returns the name of the field represented by this path.

This method may be useful when using the of methods, e.g., SearchScore.of(Bson). Depending on the syntax of the document being constructed, it may be required to use the method SearchPath.toBsonValue() instead.

Returns:

A String equal to the one used to create this path.

See Also:

• SearchPath.toBsonValue()