com.allanbank.mongodb.builder.expression

Class NaryExpression

java.lang.Object

com.allanbank.mongodb.builder.expression.NaryExpression

All Implemented Interfaces:

ElementAssignable, Expression

public class NaryExpression
extends Object
implements Expression, ElementAssignable

NaryExpression provides an implementation of an Expression with 2-N operands.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2012-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayElement	myExpressions The expression expressed as an ArrayElement.

Constructor Summary

Constructors

Constructor and Description
NaryExpression(String operator, Expression... expressions) Creates a new NaryExpression.

Method Summary

Methods

Modifier and Type	Method and Description
ArrayElement	asElement() Converts the object into an Element.
DocumentElement	toElement(String name) Returns the expression in the form of a BSON element.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

myExpressions

protected final ArrayElement myExpressions

The expression expressed as an ArrayElement.

Constructor Detail

NaryExpression

public NaryExpression(String operator,
              Expression... expressions)

Creates a new NaryExpression.

Parameters:

operator - The operator this object represents.

expressions - The sub expressions.

Method Detail

asElement

public ArrayElement asElement()

Converts the object into an Element.

Overridden to return the sub expressions as a ArrayElement:

 
 "$op" : [ <e1>, <e2>, <e2>, ... ]
 
 

Specified by:

asElement in interface ElementAssignable

Returns:

The object as an Element.

toElement

public DocumentElement toElement(String name)

Returns the expression in the form of a BSON element.

Overridden to return the sub expressions as a document with a nested array element:

 
 { <name> : { "$op" : [ <e1>, <e2>, <e2>, ... ] } }
 
 

Specified by:

toElement in interface Expression

Parameters:

name - The name for the expression's element.

Returns:

The expression in the form of a BSON element.

toString

public String toString()

Overridden to return the expression in JSON format.

 
 "$op" : [ <e1>, <e2>, <e2>, ... ]
 
 

Overrides:

toString in class Object