com.allanbank.mongodb.bson.element

Class JavaScriptWithScopeElement

java.lang.Object

com.allanbank.mongodb.bson.element.AbstractElement

com.allanbank.mongodb.bson.element.JavaScriptElement

com.allanbank.mongodb.bson.element.JavaScriptWithScopeElement

All Implemented Interfaces:

Element, ElementAssignable, Serializable, Comparable<Element>

public class JavaScriptWithScopeElement
extends JavaScriptElement

A wrapper for a BSON JavaScript with Scope.

See Also:

Serialized Form

API Notice:

This class is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

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

Field Summary

Fields

Modifier and Type	Field and Description
static ElementType	TYPE The BSON type for a string.

Fields inherited from class com.allanbank.mongodb.bson.element.AbstractElement

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
JavaScriptWithScopeElement(String name, String javaScript, Document scope) Constructs a new JavaScriptWithScopeElement.
JavaScriptWithScopeElement(String name, String javaScript, Document scope, long size) Constructs a new JavaScriptWithScopeElement.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accepts the visitor and calls the Visitor.visitJavaScript(String,String,Document) method.
int	compareTo(Element otherElement)
boolean	equals(Object object) Determines if the passed object is of this same type as this object and if so that its fields are equal.
Document	getScope() Returns the BSON JavaScript scope.
ElementType	getType() Returns the type for the BSON type.
Document	getValueAsObject() Returns the value for BSON element as a Java Object type.
int	hashCode() Computes a reasonable hash code.
JavaScriptWithScopeElement	withName(String name) Creates a new element with the same type and value as this element but with the specified name.

Methods inherited from class com.allanbank.mongodb.bson.element.JavaScriptElement

getJavaScript

Methods inherited from class com.allanbank.mongodb.bson.element.AbstractElement

asElement, find, find, findFirst, findFirst, getName, getValueAsString, nullSafeEquals, size, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final ElementType TYPE

The BSON type for a string.

Constructor Detail

JavaScriptWithScopeElement

public JavaScriptWithScopeElement(String name,
                          String javaScript,
                          Document scope)

Constructs a new JavaScriptWithScopeElement.

Parameters:

name - The name for the BSON string.

javaScript - The BSON JavaScript value.

scope - The scope for the JavaScript

Throws:

IllegalArgumentException - If the name, javaScript, or scope is null.

JavaScriptWithScopeElement

public JavaScriptWithScopeElement(String name,
                          String javaScript,
                          Document scope,
                          long size)

Constructs a new JavaScriptWithScopeElement.

Parameters:

name - The name for the BSON string.

javaScript - The BSON JavaScript value.

scope - The scope for the JavaScript

size - The size of the element when encoded in bytes. If not known then use the JavaScriptWithScopeElement(String, String, Document) constructor instead.

Throws:

IllegalArgumentException - If the name, javaScript, or scope is null.

Method Detail

accept

public void accept(Visitor visitor)

Accepts the visitor and calls the Visitor.visitJavaScript(String,String,Document) method.

Specified by:

accept in interface Element

Overrides:

accept in class JavaScriptElement

Parameters:

visitor - The visitor for the element.

See Also:

Element.accept(Visitor)

compareTo

public int compareTo(Element otherElement)

Overridden to compare the elements based on the tuple (name, type, value).

Overridden to compare the elements based on the tuple (name, type). Derived classes are responsible for the value portion of the full comparison.

Overridden to compare the Java Script (as text) if the base class comparison is equals.

Overridden to compare the Java Script (as text) if the base class comparison is equals.

Specified by:

compareTo in interface Element

Specified by:

compareTo in interface Comparable<Element>

Overrides:

compareTo in class JavaScriptElement

equals

public boolean equals(Object object)

Determines if the passed object is of this same type as this object and if so that its fields are equal.

Overrides:

equals in class JavaScriptElement

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

getScope

public Document getScope()

Returns the BSON JavaScript scope.

Returns:

The BSON JavaScript scope.

getType

public ElementType getType()

Returns the type for the BSON type.

Specified by:

getType in interface Element

Overrides:

getType in class JavaScriptElement

Returns:

The type for the BSON type.

getValueAsObject

public Document getValueAsObject()

Returns the value for BSON element as a Java Object type.

Automatic conversion from the Object-ified value to an element is provided via the DocumentBuilder.add(String, Object) method. Not all element types will be successfully converted to the same element duing a Element-->Object value-->Element conversion. This cases are noted in the appropriate sub-type's JavaDoc.

Sub-types will also overload this method with the appropriate type returned. e.g., The StringElement.getValueAsObject() method signature returns a String.

Returns the result of JavaScriptElement.getJavaScript().

Implementation Note: The return type cannot be a String here as JavaScriptWithScopeElement returns a Document.

Returns a document representing the code and scope similar to the strict JSON encoding.

Note: This value will not be recreated is a Object-->Element conversion. A more generic sub-document is created instead.

Specified by:

getValueAsObject in interface Element

Overrides:

getValueAsObject in class JavaScriptElement

Returns:

The value for BSON element as a Java Object type.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class JavaScriptElement

Returns:

The hash code value.

withName

public JavaScriptWithScopeElement withName(String name)

Creates a new element with the same type and value as this element but with the specified name. This is useful when creating a query across a set of collections where the filed name changes in the collections but the values must be identical.

Returns a new JavaScriptElement.

Returns a new JavaScriptElement.

Specified by:

withName in interface Element

Overrides:

withName in class JavaScriptElement

Parameters:

name - The new name for the element.

Returns:

The created element.