com.allanbank.mongodb.bson

Interface Element

All Superinterfaces:

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

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-2012, 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.
<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.
<E extends Element> List<E>	queryPath(Class<E> clazz, String... nameRegexs) Deprecated. Use the find(Class,String...) method instead. Will be removed after the 1.1.0 release.
List<Element>	queryPath(String... nameRegexs) Deprecated. Use the find(String...) method instead. Will be removed after the 1.1.0 release.
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.

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.

queryPath

@Deprecated
<E extends Element> List<E> queryPath(Class<E> clazz,
                                               String... nameRegexs)

Deprecated. Use the find(Class,String...) method instead. Will be removed after the 1.1.0 release.

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.

queryPath

@Deprecated
List<Element> queryPath(String... nameRegexs)

Deprecated. Use the find(String...) method instead. Will be removed after the 1.1.0 release.

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.

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.