org.apache.gora.mongodb.utils

Class BSONDecorator

java.lang.Object

org.apache.gora.mongodb.utils.BSONDecorator

public class BSONDecorator
extends Object

Utility class to build DBObject used by MongoDB in an easy way by directly specifying the fully qualified names of fields.

Author:

Fabien Poulard

Constructor Summary

Constructors

Constructor and Description
BSONDecorator(com.mongodb.DBObject obj)

Method Summary

Methods

Modifier and Type	Method and Description
com.mongodb.DBObject	asDBObject() Access the decorated BSONObject.
boolean	containsField(String fieldName) Check if the field passed in parameter exists or not.
Object	get(String fieldName) Access field as an object, no casting.
Boolean	getBoolean(String fieldName) Access field as a boolean.
ByteBuffer	getBytes(String fieldName) Access field as bytes.
Date	getDate(String fieldName) Access field as a date.
com.mongodb.BasicDBList	getDBList(String fieldName) Access field as a BasicDBList.
com.mongodb.BasicDBObject	getDBObject(String fieldName) Access field as a BasicDBObject.
Double	getDouble(String fieldName) Access field as a double.
Integer	getInt(String fieldName) Access field as a int.
Long	getLong(String fieldName) Access field as a long.
org.apache.avro.util.Utf8	getUtf8String(String fieldName) Access field as a Utf8 string.
void	put(String fieldName, Object value) Set field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BSONDecorator

public BSONDecorator(com.mongodb.DBObject obj)

Method Detail

asDBObject

public com.mongodb.DBObject asDBObject()

Access the decorated BSONObject.

Returns:

the decorated DBObject in its actual state

containsField

public boolean containsField(String fieldName)

Check if the field passed in parameter exists or not. The field is passed as a fully qualified name that is the path to the field from the root of the document (for example: "field1" or "parent.child.field2").

Parameters:

fieldName - fully qualified name of the field

Returns:

true if the field and all its parents exists in the decorated DBObject, false otherwise

getDBObject

public com.mongodb.BasicDBObject getDBObject(String fieldName)

Access field as a BasicDBObject.

Parameters:

fieldName - fully qualified name of the field to be accessed

Returns:

value of the field as a BasicDBObject

getDBList

public com.mongodb.BasicDBList getDBList(String fieldName)

Access field as a BasicDBList.

Parameters:

fieldName - fully qualified name of the field to be accessed

Returns:

value of the field as a BasicDBList

getBoolean

public Boolean getBoolean(String fieldName)

Access field as a boolean.

Parameters:

fieldName - fully qualified name of the field to be accessed

Returns:

value of the field as a boolean

getDouble

public Double getDouble(String fieldName)

Access field as a double.

Parameters:

fieldName - fully qualified name of the field to be accessed

Returns:

value of the field as a double

getInt

public Integer getInt(String fieldName)

Access field as a int.

Parameters:

fieldName - fully qualified name of the field to be accessed

Returns:

value of the field as a double

getLong

public Long getLong(String fieldName)

Access field as a long.

Parameters:

fieldName - fully qualified name of the field to be accessed

Returns:

value of the field as a double

getDate

public Date getDate(String fieldName)

Access field as a date.

Parameters:

fieldName - fully qualified name of the field to be accessed

Returns:

value of the field as a date

getUtf8String

public org.apache.avro.util.Utf8 getUtf8String(String fieldName)

Access field as a Utf8 string.

Parameters:

fieldName - fully qualified name of the field to be accessed

Returns:

value of the field as a Utf8 string

getBytes

public ByteBuffer getBytes(String fieldName)

Access field as bytes.

Parameters:

fieldName - fully qualified name of the field to be accessed

Returns:

value of the field

get

public Object get(String fieldName)

Access field as an object, no casting.

Parameters:

fieldName - fully qualified name of the field to be accessed

Returns:

value of the field

put

public void put(String fieldName,
       Object value)

Set field. Create the intermediate levels if necessary as BasicDBObject fields.

Parameters:

fieldName - fully qualified name of the field to be accessed

value - value of the field