Package dev.morphia.query

Class Meta

java.lang.Object

dev.morphia.query.Meta

public class Meta
extends Object

Defines $meta expression object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Meta.MetaDataKeyword	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
Meta(Meta.MetaDataKeyword metaDataKeyword)	Deprecated, for removal: This API element is subject to removal in a future version.
Meta(Meta.MetaDataKeyword metaDataKeyword, String field)	Deprecated, for removal: This API element is subject to removal in a future version.
Meta(String metaDataKeyword, String fieldName)	Deprecated, for removal: This API element is subject to removal in a future version. use the various factory methods. these constructors will go private in a future release.

Method Summary

Modifier and Type	Method	Description
String	getField()
static Meta	indexKey(String field)
static Meta	searchHighlights(String field)
static Meta	searchScore(String field)
static Meta	textScore()	Deprecated, for removal: This API element is subject to removal in a future version.
static Meta	textScore(String field)

Methods inherited from class java.lang.Object

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

Constructor Detail

Meta

@Deprecated(forRemoval=true)
public Meta(String metaDataKeyword,
            String fieldName)

Deprecated, for removal: This API element is subject to removal in a future version.

use the various factory methods. these constructors will go private in a future release.

Specify the meta values to use

Parameters:

metaDataKeyword - metadata keyword to create

fieldName - the field to store the value in

Since:

2.2

Meta

@Deprecated(forRemoval=true)
public Meta(Meta.MetaDataKeyword metaDataKeyword)

Deprecated, for removal: This API element is subject to removal in a future version.

Specify the meta

Parameters:

metaDataKeyword - - metadata keyword to create

Meta

@Deprecated(forRemoval=true)
public Meta(Meta.MetaDataKeyword metaDataKeyword,
            String field)

Deprecated, for removal: This API element is subject to removal in a future version.

Parameters:

metaDataKeyword - - metadata keyword to create

field - - metadata object field name

Method Detail

indexKey

public static Meta indexKey(String field)

Parameters:

field - - the field to project meta data

Returns:

instance of 'indexKey' Meta

Since:

2.2

MongoDB documentation

Query Filter: $meta

MongoDB documentation

Aggregration Expression: $meta

searchHighlights

public static Meta searchHighlights(String field)

Parameters:

field - - the field to project meta data

Returns:

instance of 'searchHighlights' Meta

Since:

2.2

MongoDB documentation

Query Filter: $meta

MongoDB documentation

Aggregration Expression: $meta

searchScore

public static Meta searchScore(String field)

Parameters:

field - - the field to project meta data

Returns:

instance of 'searchScore' Meta

Since:

2.2

MongoDB documentation

Query Filter: $meta

MongoDB documentation

Aggregration Expression: $meta

textScore

public static Meta textScore(String field)

Parameters:

field - - the field to project meta data

Returns:

instance of 'textScore' Meta

Since:

2.2

MongoDB documentation

Query Filter: $meta

MongoDB documentation

Aggregration Expression: $meta

textScore

@Deprecated(forRemoval=true)
public static Meta textScore()

Deprecated, for removal: This API element is subject to removal in a future version.

factory method for textScore metaDataKeyword

Returns:

instance of 'textScore' Meta

getField

public String getField()

Returns:

metadata object field name