com.allanbank.mongodb.bson.impl

Class AbstractDocument

java.lang.Object

com.allanbank.mongodb.bson.impl.AbstractDocument

All Implemented Interfaces:

Document, DocumentAssignable, Serializable, Iterable<Element>

Direct Known Subclasses:

EmptyDocument, ImmutableDocument, RootDocument

public abstract class AbstractDocument
extends Object
implements Document

AbstractDocument provides a base class for all document implementations with the common functionality.

See Also:

Serialized Form

Copyright ©:

2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
protected static Class<Element>	ELEMENT_TYPE The base type (interface) for all elements.
static List<Element>	EMPTY_ELEMENTS The empty list of elements.

Constructor Summary

Constructors

Constructor and Description
AbstractDocument() Creates a new AbstractDocument.

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(Visitor visitor) Accepts the visitor and calls the Visitor.visitDocument(java.lang.String, java.util.List<com.allanbank.mongodb.bson.Element>) method.
Document	asDocument() Converts the object into a document.
boolean	contains(String name) Returns true if the document contains an element with the specified name.
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.
<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.
<E extends Element> E	get(Class<E> clazz, String name) Returns the element with the specified name and type or null if no element with that name and type exists.
Element	get(String name) Returns the element with the specified name or null if no element with that name exists.
protected abstract Map<String,Element>	getElementMap() Returns the mapping from the names of elements to the element.
abstract List<Element>	getElements() Returns the array of elements that create this document.
int	hashCode() Computes a reasonable hash code.
Iterator<Element>	iterator() Returns an iterator over the documents elements.
String	toString() String form of the object.

Methods inherited from class java.lang.Object

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

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

size

Field Detail

EMPTY_ELEMENTS

public static final List<Element> EMPTY_ELEMENTS

The empty list of elements.

ELEMENT_TYPE

protected static final Class<Element> ELEMENT_TYPE

The base type (interface) for all elements.

Constructor Detail

AbstractDocument

public AbstractDocument()

Creates a new AbstractDocument.

Method Detail

accept

public void accept(Visitor visitor)

Accepts the visitor and calls the Visitor.visitDocument(java.lang.String, java.util.List<com.allanbank.mongodb.bson.Element>) method.

Specified by:

accept in interface Document

Parameters:

visitor - THe visitor for the document.

See Also:

Element.accept(Visitor)

asDocument

public Document asDocument()

Converts the object into a document.

Returns this document.

Specified by:

asDocument in interface DocumentAssignable

Returns:

The object as a Document.

contains

public boolean contains(String name)

Returns true if the document contains an element with the specified name.

Specified by:

contains in interface Document

Parameters:

name - The name of the element to locate.

Returns:

True if the document contains an element with the given name, false otherwise.

See Also:

Document.contains(String)

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 Object

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

find

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

Returns the elements matching the path of regular expressions.

Searches this sub-elements for matching elements on the path and are of the right type.

Specified by:

find in interface Document

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. May be an empty list but will never be null.

See Also:

Document.find(java.lang.Class<E>, java.lang.String...)

find

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

Returns the elements matching the path of regular expressions.

Searches this sub-elements for matching elements on the path.

Specified by:

find in interface Document

Parameters:

nameRegexs - The path of regular expressions.

Returns:

The elements matching the path of regular expressions. May be an empty list but will never be null.

See Also:

Document.find(java.lang.Class<E>, java.lang.String...)

findFirst

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

Returns the first element matching the path of regular expressions.

Note: It is much faster to use the Document.get(Class,String) method on a document than to use the Document.findFirst(String...) with a single nameRegexs.

Searches this sub-elements for matching elements on the path and are of the right type.

Specified by:

findFirst in interface Document

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.

See Also:

Document.findFirst(java.lang.Class<E>, java.lang.String...)

findFirst

public Element findFirst(String... nameRegexs)

Returns the first element matching the path of regular expressions.

Note: It is much faster to use the Document.get(String) method on a document than to use the Document.findFirst(String...) with a single nameRegexs.

Searches this sub-elements for matching elements on the path and are of the right type.

Specified by:

findFirst in interface Document

Parameters:

nameRegexs - The path of regular expressions.

Returns:

The first element matching the path of regular expressions.

See Also:

Document.findFirst(java.lang.Class<E>, java.lang.String...)

get

public <E extends Element> E get(Class<E> clazz,
                        String name)

Returns the element with the specified name and type or null if no element with that name and type exists.

Specified by:

get in interface Document

Type Parameters:

E - The type of element to get.

Parameters:

clazz - The class of element to get.

name - The name of the element to locate.

Returns:

The sub-element in the document with the given name or null if element exists with the given name.

See Also:

Document.get(String)

get

public Element get(String name)

Returns the element with the specified name or null if no element with that name exists.

Specified by:

get in interface Document

Parameters:

name - The name of the element to locate.

Returns:

The sub-element in the document with the given name or null if element exists with the given name.

See Also:

Document.get(String)

getElements

public abstract List<Element> getElements()

Returns the array of elements that create this document.

Specified by:

getElements in interface Document

Returns:

The array of elements that create this document.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class Object

Returns:

The hash code value.

iterator

public Iterator<Element> iterator()

Returns an iterator over the documents elements.

Specified by:

iterator in interface Iterable<Element>

See Also:

Iterable.iterator()

toString

public String toString()

String form of the object.

Overrides:

toString in class Object

Returns:

A human readable form of the object.

See Also:

Object.toString()

getElementMap

protected abstract Map<String,Element> getElementMap()

Returns the mapping from the names of elements to the element.

Returns:

The mapping from the names of elements to the element.