com.allanbank.mongodb.bson

Interface Visitor

All Known Implementing Classes:

JsonSerializationVisitor, QueryVersionVisitor, SizeOfVisitor, VisitorAdapter

public interface Visitor

Interface for callbacks to navigate the document structure. The accept method of each Element calls the appropriate Visit method in this interface The user is responsible for recursively navigating the structure.

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	visit(List<Element> elements) Visit the root document.
void	visitArray(String name, List<Element> elements) Visits an array of elements.
void	visitBinary(String name, byte subType, byte[] data) Visits a binary element.
void	visitBoolean(String name, boolean value) Visits a boolean element.
void	visitDBPointer(String name, String databaseName, String collectionName, ObjectId id) Visits a deprecated DBPointer element.
void	visitDocument(String name, List<Element> elements) Visits a sub-document element.
void	visitDouble(String name, double value) Visits a double element.
void	visitInteger(String name, int value) Visits a integer (32-bit signed) element.
void	visitJavaScript(String name, String code) Visits a JavaScript element.
void	visitJavaScript(String name, String code, Document scope) Visits a JavaScript with Scope element.
void	visitLong(String name, long value) Visits a long (64-bit signed) element.
void	visitMaxKey(String name) Visits a minimum key value element.
void	visitMinKey(String name) Visits a minimum key value element.
void	visitMongoTimestamp(String name, long value) Visits a MongoDB Timestamp element.
void	visitNull(String name) Visits a null valued element.
void	visitObjectId(String name, ObjectId id) Visits an ObjectId element.
void	visitRegularExpression(String name, String pattern, String options) Visits a regular expression element.
void	visitString(String name, String value) Visits a string element.
void	visitSymbol(String name, String symbol) Visits a symbol element.
void	visitTimestamp(String name, long timestamp) Visits a timestamp element.

Method Detail

visit

void visit(List<Element> elements)

Visit the root document.

Implementations of Document may see a significant performance enhancement if they ensure that the list of elements is the same list. (Identify check instead of Object.equals(Object).

Parameters:

elements - The sub elements of the document.

visitArray

void visitArray(String name,
              List<Element> elements)

Visits an array of elements.

The ArrayElement implementation ensures that the list of elements is always the same list. Visitors may use this fact to cache intermediate results.

Parameters:

name - The name of the element.

elements - The elements in the array.

visitBinary

void visitBinary(String name,
               byte subType,
               byte[] data)

Visits a binary element.

Parameters:

name - The name of the element.

subType - The binary data sub type.

data - The binary data.

visitBoolean

void visitBoolean(String name,
                boolean value)

Visits a boolean element.

Parameters:

name - The name of the element.

value - The boolean value.

visitDBPointer

void visitDBPointer(String name,
                  String databaseName,
                  String collectionName,
                  ObjectId id)

Visits a deprecated DBPointer element.

Parameters:

name - The name of the element.

databaseName - The name of the database containing the document.

collectionName - The name of the collection containing the document.

id - The id for the document.

visitDocument

void visitDocument(String name,
                 List<Element> elements)

Visits a sub-document element.

The DocumentElement implementation ensures that the list of elements is always the same list. Visitors may use this fact to cache intermediate results.

Parameters:

name - The name of the element.

elements - The sub elements of the document.

visitDouble

void visitDouble(String name,
               double value)

Visits a double element.

Parameters:

name - The name of the element.

value - The double value.

visitInteger

void visitInteger(String name,
                int value)

Visits a integer (32-bit signed) element.

Parameters:

name - The name of the element.

value - The integer value.

visitJavaScript

void visitJavaScript(String name,
                   String code)

Visits a JavaScript element.

Parameters:

name - The name of the element.

code - The java script code.

visitJavaScript

void visitJavaScript(String name,
                   String code,
                   Document scope)

Visits a JavaScript with Scope element.

Parameters:

name - The name of the element.

code - The java script code.

scope - The scope for the JacaScript code.

visitLong

void visitLong(String name,
             long value)

Visits a long (64-bit signed) element.

Parameters:

name - The name of the element.

value - The long value.

visitMaxKey

void visitMaxKey(String name)

Visits a minimum key value element. Used as an absolute upper bounds.

Parameters:

name - The name of the element.

visitMinKey

void visitMinKey(String name)

Visits a minimum key value element. Used as an absolute lower bounds.

Parameters:

name - The name of the element.

visitMongoTimestamp

void visitMongoTimestamp(String name,
                       long value)

Visits a MongoDB Timestamp element.

Parameters:

name - The name of the element.

value - The mongoDB timstamp value.

visitNull

void visitNull(String name)

Visits a null valued element.

Parameters:

name - The name of the element.

visitObjectId

void visitObjectId(String name,
                 ObjectId id)

Visits an ObjectId element.

Parameters:

name - The name of the element.

id - The object id.

visitRegularExpression

void visitRegularExpression(String name,
                          String pattern,
                          String options)

Visits a regular expression element.

Parameters:

name - The name of the element.

pattern - The pattern for the regular expression.

options - The regular expression options. See the BSON specification for details.

visitString

void visitString(String name,
               String value)

Visits a string element.

Parameters:

name - The name of the element.

value - The string value.

visitSymbol

void visitSymbol(String name,
               String symbol)

Visits a symbol element.

Parameters:

name - The name of the element.

symbol - The symbol value.

visitTimestamp

void visitTimestamp(String name,
                  long timestamp)

Visits a timestamp element. The timestamp is the number of milliseconds since the Unix epoch.

Parameters:

name - The name of the element.

timestamp - The number of milliseconds since the Unix epoch.