org.litote.kmongo

Class ProjectionsKt

org.litote.kmongo.ProjectionsKt

public class ProjectionsKt

Constructor Detail

ProjectionsKt

public ProjectionsKt()

Method Detail

getProjection

@NotNull
public static <T> java.lang.String getProjection(@NotNull
                                                          kotlin.reflect.KProperty<? extends T> $this$projection)

The projection of the property.

getProjection

@NotNull
public static java.lang.String getProjection(@NotNull
                                                      java.lang.String $this$projection)

The projection of the property.

from

@NotNull
public static <T> org.bson.conversions.Bson from(@NotNull
                                                          kotlin.reflect.KProperty<? extends T> $this$from,
                                                          T expression)

Creates a projection of a property whose value is computed from the given expression.

Parameters:

expression - the expression

Returns:

the projection

from

@NotNull
public static org.bson.conversions.Bson from(@NotNull
                                                      org.litote.kmongo.MongoOperator $this$from,
                                                      @NotNull
                                                      java.lang.Object expression)

Builds Bson for the MongoOperator and the specified expression.

from

@NotNull
public static org.bson.conversions.Bson from(@NotNull
                                                      java.lang.String $this$from,
                                                      @NotNull
                                                      java.lang.Object expression)

Builds Bson from this String format and the specified expression.

include

@NotNull
public static org.bson.conversions.Bson include(@NotNull
                                                         kotlin.reflect.KProperty... properties)

Creates a projection that includes all of the given properties.

Parameters:

properties - the field names

Returns:

the projection

include

@NotNull
public static org.bson.conversions.Bson include(@NotNull
                                                         java.lang.Iterable<? extends kotlin.reflect.KProperty<?>> properties)

Creates a projection that includes all of the given properties.

Parameters:

properties - the field names

Returns:

the projection

exclude

@NotNull
public static org.bson.conversions.Bson exclude(@NotNull
                                                         kotlin.reflect.KProperty... properties)

Creates a projection that excludes all of the given properties.

Parameters:

properties - the field names

Returns:

the projection

exclude

@NotNull
public static org.bson.conversions.Bson exclude(@NotNull
                                                         java.lang.Iterable<? extends kotlin.reflect.KProperty<?>> properties)

Creates a projection that excludes all of the given properties.

Parameters:

properties - the field names

Returns:

the projection

excludeId

@NotNull
public static org.bson.conversions.Bson excludeId()

Creates a projection that excludes the _id field. This suppresses the automatic inclusion of _id that is the default, even when other fields are explicitly included.

Returns:

the projection

elemMatchProj

@NotNull
public static <T> org.bson.conversions.Bson elemMatchProj(@NotNull
                                                                   kotlin.reflect.KProperty<? extends T> $this$elemMatchProj)

Creates a projection that includes for the given property only the first element of an array that matches the query filter. This is referred to as the positional $ operator.

Returns:

the projection

elemMatchProj

@NotNull
public static <T> org.bson.conversions.Bson elemMatchProj(@NotNull
                                                                   kotlin.reflect.KProperty<? extends T> $this$elemMatchProj,
                                                                   @NotNull
                                                                   org.bson.conversions.Bson filter)

Creates a projection that includes for the given property only the first element of the array value of that field that matches the given query filter.

Parameters:

filter - the filter to apply

Returns:

the projection

metaTextScore

@NotNull
public static <T> org.bson.conversions.Bson metaTextScore(@NotNull
                                                                   kotlin.reflect.KProperty<? extends T> $this$metaTextScore)

Creates a projection to the given property of the textScore, for use with text queries.

Returns:

the projection

slice

@NotNull
public static <T> org.bson.conversions.Bson slice(@NotNull
                                                           kotlin.reflect.KProperty<? extends T> $this$slice,
                                                           int limit)

Creates a projection to the given property of a slice of the array value of that field.

Parameters:

limit - the number of elements to project.

Returns:

the projection

slice

@NotNull
public static <T> org.bson.conversions.Bson slice(@NotNull
                                                           kotlin.reflect.KProperty<? extends T> $this$slice,
                                                           int skip,
                                                           int limit)

Creates a projection to the given property of a slice of the array value of that field.

Parameters:

skip - the number of elements to skip before applying the limit

limit - the number of elements to project

Returns:

the projection

fields

@NotNull
public static org.bson.conversions.Bson fields(@NotNull
                                                        org.bson.conversions.Bson... projections)

Creates a projection that combines the list of projections into a single one. If there are duplicate keys, the last one takes precedence.

Parameters:

projections - the list of projections to combine

Returns:

the combined projection

fields

@NotNull
public static org.bson.conversions.Bson fields(@NotNull
                                                        java.util.List<? extends org.bson.conversions.Bson> projections)

Creates a projection that combines the list of projections into a single one. If there are duplicate keys, the last one takes precedence.

Parameters:

projections - the list of projections to combine

Returns:

the combined projection