com.allanbank.mongodb.bson

Interface Element

All Superinterfaces:

Comparable<Element>, ElementAssignable, Serializable

All Known Subinterfaces:

NumericElement

All Known Implementing Classes:

AbstractBuilder.BuilderElement, AbstractElement, ArrayElement, BinaryElement, BooleanElement, DBPointerElement, DocumentElement, DoubleElement, IntegerElement, JavaScriptElement, JavaScriptWithScopeElement, LongElement, MaxKeyElement, MinKeyElement, MongoTimestampElement, NullElement, ObjectIdElement, RegularExpressionElement, StringElement, SymbolElement, TimestampElement, UuidElement

public interface Element
extends Serializable, ElementAssignable, Comparable<Element>

A common interface for the basic BSON types used to construct Documents and arrays.

API Notice:

This interface 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

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accepts the visitor and calls the appropriate method on the visitor based on the element type.
int	compareTo(Element otherElement)
<E extends Element> List<E>	find(Class<E> clazz, String... nameRegexs) Returns the elements matching the path of regular expressions.
List<Element>	find(String... nameRegexs) Returns the elements matching the path of regular expressions.
<E extends Element> E	findFirst(Class<E> clazz, String... nameRegexs) Returns the first element matching the path of regular expressions.
Element	findFirst(String... nameRegexs) Returns the first element matching the path of regular expressions.
String	getName() Returns the name for the BSON type.
ElementType	getType() Returns the type for the BSON type.
Object	getValueAsObject() Returns the value for BSON element as a Java Object type.
String	getValueAsString() Returns the value for BSON element as a Java String.
long	size() Returns the number of bytes that are used to encode the element.
Element	withName(String name) Creates a new element with the same type and value as this element but with the specified name.

Methods inherited from interface com.allanbank.mongodb.bson.ElementAssignable

asElement

Method Detail

accept

void accept(Visitor visitor)

Accepts the visitor and calls the appropriate method on the visitor based on the element type.

Parameters:

visitor - The visitor for the element.

compareTo

int compareTo(Element otherElement)

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

Specified by:

compareTo in interface Comparable<Element>

find

<E extends Element> List<E> find(Class<E> clazz,
                               String... nameRegexs)

Returns the elements matching the path of regular expressions.

Type Parameters:

E - The type of element to match.

Parameters:

clazz - The class of elements to match.

nameRegexs - The path of regular expressions.

Returns:

The elements matching the path of regular expressions.

find

List<Element> find(String... nameRegexs)

Returns the elements matching the path of regular expressions.

Parameters:

nameRegexs - The path of regular expressions.

Returns:

The elements matching the path of regular expressions.

findFirst

<E extends Element> E findFirst(Class<E> clazz,
                              String... nameRegexs)

Returns the first element matching the path of regular expressions.

Type Parameters:

E - The type of element to match.

Parameters:

clazz - The class of element to match.

nameRegexs - The path of regular expressions.

Returns:

The first element matching the path of regular expressions.

findFirst

Element findFirst(String... nameRegexs)

Returns the first element matching the path of regular expressions.

Parameters:

nameRegexs - The path of regular expressions.

Returns:

The first element matching the path of regular expressions.

getName

String getName()

Returns the name for the BSON type.

Returns:

The name for the BSON type.

getType

ElementType getType()

Returns the type for the BSON type.

Returns:

The type for the BSON type.

getValueAsObject

Object 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 value for BSON element as a Java Object type.

getValueAsString

String getValueAsString()

Returns the value for BSON element as a Java String. Automatic conversion from the string value back to an Element is not provided.

Generally the string returned will be the expected value. As an example for a LongElement with the value 101 the returned string will be "101". In those cases where there is not canonical form for the value (e.g., a TimestampElement the returned string will match the value when converted to JSON by the JsonSerializationVisitor. For a TimestampElement that is a string of the form "ISODate('1970-01-01T00:00:00.000+0000')".

Returns:

The value for BSON element as a String.

size

long size()

Returns the number of bytes that are used to encode the element.

Returns:

The bytes that are used to encode the element.

withName

Element 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.

Parameters:

name - The new name for the element.

Returns:

The created element.