org.mongodb.morphia.aggregation

Class Projection

java.lang.Object

org.mongodb.morphia.aggregation.Projection

public final class Projection
extends Object

Defines a projection for use in aggregation

MongoDB documentation

$project

Method Summary

Modifier and Type	Method and Description
static Projection	add(Object... args) Creates an addition projection
static Projection	divide(Object arg1, Object arg2) Creates a division projection
static Projection	expression(String operator, Object... args) Provides access to arbitrary expressions taking an array of arguments, such as $concat
List<Object>	getArguments()
List<Projection>	getProjections()
String	getSource()
String	getTarget()
boolean	isSuppressed()
static Projection	list(Object... args) Creates a list projection
static Projection	mod(Object arg1, Object arg2) Creates a modulo projection
static Projection	multiply(Object... args) Creates a multiplication projection
static Projection	projection(String field) Creates a projection on a field
static Projection	projection(String field, Projection projection, Projection... subsequent) Creates a projection on a field with subsequent projects applied.
static Projection	projection(String field, String projectedField) Creates a projection on a field and renames it
static Projection	subtract(Object arg1, Object arg2) Creates a subtraction projection
Projection	suppress() Marks this field to be suppressed from the output of this stage
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

projection

public static Projection projection(String field)

Creates a projection on a field

Parameters:

field - the field

Returns:

the projection

projection

public static Projection projection(String field,
                                    String projectedField)

Creates a projection on a field and renames it

Parameters:

field - the field

projectedField - the new field name

Returns:

the projection

projection

public static Projection projection(String field,
                                    Projection projection,
                                    Projection... subsequent)

Creates a projection on a field with subsequent projects applied.

Parameters:

field - the field

projection - the project to apply

subsequent - the other projections to apply

Returns:

the projection

expression

public static Projection expression(String operator,
                                    Object... args)

Provides access to arbitrary expressions taking an array of arguments, such as $concat

Parameters:

operator - the operator for the projection

args - the projection arguments

Returns:

the projection

list

public static Projection list(Object... args)

Creates a list projection

Parameters:

args - the projection arguments

Returns:

the projection

add

public static Projection add(Object... args)

Creates an addition projection

Parameters:

args - the projection arguments

Returns:

the projection

MongoDB documentation

$add

subtract

public static Projection subtract(Object arg1,
                                  Object arg2)

Creates a subtraction projection

Parameters:

arg1 - subtraction argument

arg2 - subtraction argument

Returns:

the projection

MongoDB documentation

$subtract

multiply

public static Projection multiply(Object... args)

Creates a multiplication projection

Parameters:

args - the projection arguments

Returns:

the projection

MongoDB documentation

$multiply

divide

public static Projection divide(Object arg1,
                                Object arg2)

Creates a division projection

Parameters:

arg1 - subtraction argument

arg2 - subtraction argument

Returns:

the projection

MongoDB documentation

$divide

mod

public static Projection mod(Object arg1,
                             Object arg2)

Creates a modulo projection

Parameters:

arg1 - subtraction argument

arg2 - subtraction argument

Returns:

the projection

MongoDB documentation

$mod

getArguments

public List<Object> getArguments()

Returns:

the arguments for the projection

getSource

public String getSource()

Returns:

the projected field name

getProjections

public List<Projection> getProjections()

Returns:

any projections applied to this field

getTarget

public String getTarget()

Returns:

the source field of the projection

isSuppressed

public boolean isSuppressed()

Returns:

true if this field is suppressed from the output

suppress

public Projection suppress()

Marks this field to be suppressed from the output of this stage

Returns:

this

toString

public String toString()

Overrides:

toString in class Object