Uses of Interface
com.allanbank.mongodb.bson.Element

Packages that use Element

Package	Description
com.allanbank.mongodb	Provides a Java driver for the MongoDB document store that allows asynchronous invocation of requests.
com.allanbank.mongodb.bson	Strongly typed, immutable implementation of the BSON Specification.
com.allanbank.mongodb.bson.builder	Provides the interfaces for builders to aid in constructing BSON Documents.
com.allanbank.mongodb.bson.builder.impl	Provides the implementations for builders to aid in constructing BSON Documents.
com.allanbank.mongodb.bson.element	Provides the complete set of BSON Elements used to construct Documents.
com.allanbank.mongodb.bson.impl	Provides the implementation of a top level BSON Document.
com.allanbank.mongodb.bson.io	Provides the ability to serialize and deserialize BSON Documents.
com.allanbank.mongodb.builder	Provides domain classes and builders for queries and the common MongoDB commands.
com.allanbank.mongodb.builder.expression	Provides support for construction of expressions for use with aggregate command's $project operator.
com.allanbank.mongodb.client	Provides implementations of the main client interfaces and classes to translate the Reply(s) from the server.

Uses of Element in com.allanbank.mongodb

Methods in com.allanbank.mongodb with parameters of type Element

Modifier and Type	Method and Description
void	MongoCollection.createIndex(boolean unique, Element... keys) Creates an index with a generated name, across the keys specified and if unique is true ensuring entries are unique.
void	MongoCollection.createIndex(DocumentAssignable options, Element... keys) Creates an index with a generated name, across the keys specified allowing duplicate entries.
void	MongoCollection.createIndex(Element... keys) Creates an index with a generated name, across the keys specified allowing duplicate entries.
void	MongoCollection.createIndex(String name, boolean unique, Element... keys) Creates an index with the specified name, across the keys specified and if unique is true ensuring entries are unique.
void	MongoCollection.createIndex(String name, DocumentAssignable options, Element... keys) Creates an index with a generated name, across the keys specified allowing duplicate entries.

Uses of Element in com.allanbank.mongodb.bson

Subinterfaces of Element in com.allanbank.mongodb.bson

Modifier and Type	Interface and Description
interface	NumericElement NumericElement provides a common interface for all numeric Elements.

Methods in com.allanbank.mongodb.bson with type parameters of type Element

Modifier and Type	Method and Description
<E extends Element> List<E>	Document.find(Class<E> clazz, String... nameRegexs) Returns the elements matching the path of regular expressions.
<E extends Element> List<E>	Element.find(Class<E> clazz, String... nameRegexs) Returns the elements matching the path of regular expressions.
<E extends Element> E	Document.findFirst(Class<E> clazz, String... nameRegexs) Returns the first element matching the path of regular expressions.
<E extends Element> E	Element.findFirst(Class<E> clazz, String... nameRegexs) Returns the first element matching the path of regular expressions.
<E extends Element> E	Document.get(Class<E> clazz, String name) Returns the element with the specified name or null if no element with that name exists.
<E extends Element> List<E>	Document.queryPath(Class<E> clazz, String... nameRegexs) Deprecated. Use the Document.find(Class,String...) method instead. Will be removed after the 1.1.0 release.
<E extends Element> List<E>	Element.queryPath(Class<E> clazz, String... nameRegexs) Deprecated. Use the find(Class,String...) method instead. Will be removed after the 1.1.0 release.

Methods in com.allanbank.mongodb.bson that return Element

Modifier and Type	Method and Description
Element	ElementAssignable.asElement() Converts the object into an Element.
Element	Document.findFirst(String... nameRegexs) Returns the first element matching the path of regular expressions.
Element	Element.findFirst(String... nameRegexs) Returns the first element matching the path of regular expressions.
Element	Document.get(String name) Returns the element with the specified name or null if no element with that name exists.
Element	DocumentReference.getId() Returns the id of the document being referenced.
Element	Element.withName(String name) Creates a new element with the same type and value as this element but with the specified name.

Methods in com.allanbank.mongodb.bson that return types with arguments of type Element

Modifier and Type	Method and Description
List<Element>	Document.find(String... nameRegexs) Returns the elements matching the path of regular expressions.
List<Element>	Element.find(String... nameRegexs) Returns the elements matching the path of regular expressions.
List<Element>	Document.getElements() Returns the array of elements that create this document.
List<Element>	Document.queryPath(String... nameRegexs) Deprecated. Use the Document.find(String...) method instead. Will be removed after the 1.1.0 release.
List<Element>	Element.queryPath(String... nameRegexs) Deprecated. Use the find(String...) method instead. Will be removed after the 1.1.0 release.

Method parameters in com.allanbank.mongodb.bson with type arguments of type Element

Modifier and Type	Method and Description
void	Visitor.visit(List<Element> elements) Visit the root document.
void	Visitor.visitArray(String name, List<Element> elements) Visits an array of elements.
void	Visitor.visitDocument(String name, List<Element> elements) Visits a sub-document element.

Constructors in com.allanbank.mongodb.bson with parameters of type Element

Constructor and Description
DocumentReference(String collectionName, Element id) Creates a new DocumentReference.
DocumentReference(String databaseName, String collectionName, Element id) Creates a new DocumentReference.

Uses of Element in com.allanbank.mongodb.bson.builder

Methods in com.allanbank.mongodb.bson.builder that return Element

Modifier and Type	Method and Description
Element[]	ArrayBuilder.build() Returns the array of Elements being constructed.

Uses of Element in com.allanbank.mongodb.bson.builder.impl

Classes in com.allanbank.mongodb.bson.builder.impl that implement Element

Modifier and Type	Class and Description
static class	AbstractBuilder.BuilderElement A temporary Element to stand in for a element being constructed with a builder.

Fields in com.allanbank.mongodb.bson.builder.impl with type parameters of type Element

Modifier and Type	Field and Description
protected List<Element>	AbstractBuilder.myElements The list of elements in the builder.

Methods in com.allanbank.mongodb.bson.builder.impl that return Element

Modifier and Type	Method and Description
Element	AbstractBuilder.BuilderElement.build() Constructs the final form of the element being constructed by the encapsulated builder.
Element[]	ArrayBuilderImpl.build() Returns the array of Elements being constructed.
protected abstract Element	AbstractBuilder.build(String name) Constructs the final form of the element being constructed.
protected Element	DocumentBuilderImpl.build(String name) Constructs the final form of the element being constructed.
protected Element	AbstractBuilder.coerse(String name, Object value) Performs type coersion on the value into the best possible element type.

Methods in com.allanbank.mongodb.bson.builder.impl that return types with arguments of type Element

Modifier and Type	Method and Description
protected List<Element>	AbstractBuilder.subElements() Renders the final form of the sub elements in the builder replacing all AbstractBuilder.BuilderElements with the final element form.

Uses of Element in com.allanbank.mongodb.bson.element

Classes in com.allanbank.mongodb.bson.element that implement Element

Modifier and Type	Class and Description
class	AbstractElement A base class for the basic BSON types.
class	ArrayElement A wrapper for a BSON array.
class	BinaryElement A wrapper for a BSON binary.
class	BooleanElement A wrapper for a BSON boolean.
class	DBPointerElement Deprecated. See BSON Specification.
class	DocumentElement Wraps a single BSON document that may contain nested documents.
class	DoubleElement A wrapper for a BSON double.
class	IntegerElement A wrapper for a BSON (signed 32-bit) integer.
class	JavaScriptElement A wrapper for a BSON JavaScript.
class	JavaScriptWithScopeElement A wrapper for a BSON JavaScript with Scope.
class	LongElement A wrapper for a BSON (signed 64-bit) integer or long.
class	MaxKeyElement A wrapper for a BSON maximum key element.
class	MinKeyElement A wrapper for a BSON minimum key element.
class	MongoTimestampElement A wrapper for a BSON (signed 64-bit) Mongo timestamp as 4 byte increment and 4 byte timestamp.
class	NullElement A wrapper for a BSON null.
class	ObjectIdElement A wrapper for a BSON Object Id.
class	RegularExpressionElement A wrapper for a BSON regular expression.
class	StringElement A wrapper for a BSON string.
class	SymbolElement A wrapper for a BSON symbol.
class	TimestampElement A wrapper for a BSON timestamp as the milliseconds since the epoch.
class	UuidElement UuidElement provides a helper element for handling UUID BinaryElement sub-types.

Fields in com.allanbank.mongodb.bson.element with type parameters of type Element

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

Methods in com.allanbank.mongodb.bson.element with type parameters of type Element

Modifier and Type	Method and Description
<E extends Element> List<E>	DocumentElement.find(Class<E> clazz, String... nameRegexs) Returns the elements matching the path of regular expressions.
<E extends Element> List<E>	AbstractElement.find(Class<E> clazz, String... nameRegexs) Returns the elements matching the path of regular expressions.
<E extends Element> List<E>	ArrayElement.find(Class<E> clazz, String... nameRegexs) Returns the elements matching the path of regular expressions.
<E extends Element> E	DocumentElement.findFirst(Class<E> clazz, String... nameRegexs) Returns the first element matching the path of regular expressions.
<E extends Element> E	AbstractElement.findFirst(Class<E> clazz, String... nameRegexs) Returns the first element matching the path of regular expressions.
<E extends Element> E	ArrayElement.findFirst(Class<E> clazz, String... nameRegexs) Returns the first element matching the path of regular expressions.
<E extends Element> E	DocumentElement.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.
<E extends Element> List<E>	AbstractElement.queryPath(Class<E> clazz, String... nameRegexs) Deprecated. Use the replacement method, AbstractElement.find(Class, String...). Will be removed after the 1.1.0 release.

Methods in com.allanbank.mongodb.bson.element that return Element

Modifier and Type	Method and Description
Element	AbstractElement.asElement() Converts the object into an Element.
Element	AbstractElement.findFirst(String... nameRegexs) Returns the first element matching the path of regular expressions.
Element	DocumentElement.get(String name) Returns the element with the specified name or null if no element with that name exists.
Element[]	ArrayElement.getValueAsObject() Returns the value for BSON element as a Java Object type.

Methods in com.allanbank.mongodb.bson.element that return types with arguments of type Element

Modifier and Type	Method and Description
List<Element>	AbstractElement.find(String... nameRegexs) Returns the elements matching the path of regular expressions.
List<Element>	DocumentElement.getElements() Returns the elements in the document.
List<Element>	ArrayElement.getEntries() Returns the entries in the array.
Iterator<Element>	DocumentElement.iterator() Returns an iterator over the documents elements.
List<Element>	AbstractElement.queryPath(String... nameRegexs) Deprecated. Use the replacement method, AbstractElement.find(String...). Will be removed after the 1.1.0 release.

Method parameters in com.allanbank.mongodb.bson.element with type arguments of type Element

Modifier and Type	Method and Description
void	JsonSerializationVisitor.visit(List<Element> elements) Visit the root document.
void	JsonSerializationVisitor.visitArray(String name, List<Element> elements) Visits an array of elements.
void	JsonSerializationVisitor.visitDocument(String name, List<Element> elements) Visits a sub-document element.

Constructors in com.allanbank.mongodb.bson.element with parameters of type Element

Constructor and Description
ArrayElement(String name, Element... entries) Constructs a new ArrayElement.
DocumentElement(String name, Element... elements) Constructs a new DocumentElement.

Constructor parameters in com.allanbank.mongodb.bson.element with type arguments of type Element

Constructor and Description
ArrayElement(String name, List<Element> entries) Constructs a new ArrayElement.
DocumentElement(String name, Collection<Element> elements) Constructs a new DocumentElement.
DocumentElement(String name, List<Element> elements) Constructs a new DocumentElement.
DocumentElement(String name, List<Element> elements, boolean takeOwnership) Constructs a new DocumentElement.

Uses of Element in com.allanbank.mongodb.bson.impl

Fields in com.allanbank.mongodb.bson.impl with type parameters of type Element

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

Methods in com.allanbank.mongodb.bson.impl with type parameters of type Element

Modifier and Type	Method and Description
<E extends Element> List<E>	EmptyDocument.find(Class<E> clazz, String... nameRegexs) Returns the elements matching the path of regular expressions.
<E extends Element> List<E>	RootDocument.find(Class<E> clazz, String... nameRegexs) Returns the elements matching the path of regular expressions.
<E extends Element> E	EmptyDocument.findFirst(Class<E> clazz, String... nameRegexs) Returns the first element matching the path of regular expressions.
<E extends Element> E	RootDocument.findFirst(Class<E> clazz, String... nameRegexs) Returns the first element matching the path of regular expressions.
<E extends Element> E	EmptyDocument.get(Class<E> clazz, String name) Returns an empty list of elements.
<E extends Element> E	RootDocument.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.
<E extends Element> List<E>	EmptyDocument.queryPath(Class<E> clazz, String... nameRegexs) Deprecated. Use the EmptyDocument.find(Class,String...) method instead. Will be removed after the 1.1.0 release.
<E extends Element> List<E>	RootDocument.queryPath(Class<E> clazz, String... nameRegexs) Deprecated. Use the RootDocument.find(Class,String...) method instead. Will be removed after the 1.1.0 release.

Methods in com.allanbank.mongodb.bson.impl that return Element

Modifier and Type	Method and Description
Element	EmptyDocument.findFirst(String... nameRegexs) Returns the first element matching the path of regular expressions.
Element	RootDocument.findFirst(String... nameRegexs) Returns the first element matching the path of regular expressions.
Element	EmptyDocument.get(String name) Returns an empty list of elements.
Element	RootDocument.get(String name) Returns the element with the specified name or null if no element with that name exists.

Methods in com.allanbank.mongodb.bson.impl that return types with arguments of type Element

Modifier and Type	Method and Description
List<Element>	EmptyDocument.find(String... nameRegexs) Returns the elements matching the path of regular expressions.
List<Element>	RootDocument.find(String... nameRegexs) Returns the elements matching the path of regular expressions.
List<Element>	EmptyDocument.getElements() Returns an empty list of elements.
List<Element>	RootDocument.getElements() Returns the elements in the document.
Iterator<Element>	EmptyDocument.iterator() Returns an iterator over an empty list of elements.
Iterator<Element>	RootDocument.iterator() Returns an iterator over the documents elements.
List<Element>	EmptyDocument.queryPath(String... nameRegexs) Deprecated. Use the EmptyDocument.find(Class,String...) method instead. Will be removed after the 1.1.0 release.
List<Element>	RootDocument.queryPath(String... nameRegexs) Deprecated. Use the RootDocument.find(Class,String...) method instead. Will be removed after the 1.1.0 release.

Constructors in com.allanbank.mongodb.bson.impl with parameters of type Element

Constructor and Description
RootDocument(Element... elements) Constructs a new RootDocument.

Constructor parameters in com.allanbank.mongodb.bson.impl with type arguments of type Element

Constructor and Description
RootDocument(List<Element> elements) Constructs a new RootDocument.
RootDocument(List<Element> elements, boolean idPresent) Constructs a new RootDocument.

Uses of Element in com.allanbank.mongodb.bson.io

Methods in com.allanbank.mongodb.bson.io that return Element

Modifier and Type	Method and Description
protected Element	BsonInputStream.readElement(byte token) Reads the element:

Methods in com.allanbank.mongodb.bson.io that return types with arguments of type Element

Modifier and Type	Method and Description
List<Element>	SizeOfVisitor.CachedSizeNode.getElements() Returns the elements value.
protected List<Element>	BsonInputStream.readElements() Reads a BSON element list (e_list):

Method parameters in com.allanbank.mongodb.bson.io with type arguments of type Element

Modifier and Type	Method and Description
void	SizeOfVisitor.visit(List<Element> elements) Visit the root document.
void	SizeOfVisitor.visitArray(String name, List<Element> elements) Visits an array of elements.
void	SizeOfVisitor.visitDocument(String name, List<Element> elements) Visits a sub-document element.

Constructor parameters in com.allanbank.mongodb.bson.io with type arguments of type Element

Constructor and Description
SizeOfVisitor.CachedSizeNode(List<Element> elements) Creates a new CachedSizeNode.

Uses of Element in com.allanbank.mongodb.builder

Methods in com.allanbank.mongodb.builder that return Element

Modifier and Type	Method and Description
Element	AggregationGroupField.toElement() Returns the element for the group operator's field.
Element	AggregationGroupId.toElement() Returns the element for the group operator's id.

Methods in com.allanbank.mongodb.builder that return types with arguments of type Element

Modifier and Type	Method and Description
List<Element>	Aggregate.getPipeline() Returns the pipeline of operations to apply.

Methods in com.allanbank.mongodb.builder with parameters of type Element

Modifier and Type	Method and Description
ConditionBuilder	ConditionBuilder.all(Element... elements) Specify the values that must all be in the fields array.
Find.Builder	Find.Builder.hint(Element... indexFields) Sets the value of hint as to which index should be used to execute the query.
ConditionBuilder	ConditionBuilder.in(Element... elements) Specify the values that one must match the fields value.
ConditionBuilder	ConditionBuilder.notIn(Element... elements) Specify the values that must not must not match the fields value.
Aggregate.Builder	Aggregate.Builder.project(AggregationProjectFields fields, Element... elements) Adds a $project operation to the pipeline to create a projection of the documents passing this point in the pipeline.
Find.Builder	Find.Builder.setHint(Element... indexFields) Sets the value of hint as to which index should be used to execute the query.
Aggregate.Builder	Aggregate.Builder.step(String operator, Element... elements) Adds a generic step to the builder's pipeline.

Method parameters in com.allanbank.mongodb.builder with type arguments of type Element

Modifier and Type	Method and Description
Aggregate.Builder	Aggregate.Builder.step(String operator, List<Element> elements) Adds a generic step to the builder's pipeline.

Uses of Element in com.allanbank.mongodb.builder.expression

Methods in com.allanbank.mongodb.builder.expression that return Element

Modifier and Type	Method and Description
Element	UnaryExpression.asElement() Converts the object into an Element.
static Element	Expressions.set(String name, DocumentAssignable document) Returns an element to set the value to.
static Element	Expressions.set(String name, Expression expression) Returns an element to set the value to.
Element	Expression.toElement(String name) Returns the expression in the form of a BSON element.
Element	Constant.toElement(String name) Returns the expression in the form of a BSON element.

Constructors in com.allanbank.mongodb.builder.expression with parameters of type Element

Constructor and Description
Constant(Element constant) Creates a new Constant.

Uses of Element in com.allanbank.mongodb.client

Methods in com.allanbank.mongodb.client with parameters of type Element

Modifier and Type	Method and Description
protected String	AbstractValidatingReplyCallback.asString(Element errorMessageElem) Converts the Element to a string.
protected String	AbstractMongoCollection.buildIndexName(Element... keys) Generates a name for the index based on the keys.
void	AbstractMongoCollection.createIndex(boolean unique, Element... keys) Creates an index with a generated name, across the keys specified and if unique is true ensuring entries are unique.
void	AbstractMongoCollection.createIndex(DocumentAssignable options, Element... keys) Creates an index with a generated name, across the keys specified allowing duplicate entries.
void	AbstractMongoCollection.createIndex(Element... keys) Creates an index with a generated name, across the keys specified allowing duplicate entries.
void	AbstractMongoCollection.createIndex(String name, boolean unique, Element... keys) Creates an index with the specified name, across the keys specified and if unique is true ensuring entries are unique.
abstract void	AbstractMongoCollection.createIndex(String name, DocumentAssignable options, Element... keys) Creates an index with a generated name, across the keys specified allowing duplicate entries.
void	MongoCollectionImpl.createIndex(String name, DocumentAssignable options, Element... keys) Creates an index with a generated name, across the keys specified allowing duplicate entries.
protected int	AbstractValidatingReplyCallback.toInt(Element element) Converts a NumericElementinto an int value.