sirius.db.mongo

Class Doc

java.lang.Object

sirius.db.mongo.Doc

public class Doc
extends Object

A simple wrapper of a document in Mongo DB.

Constructor Summary

Constructors

Constructor and Description
Doc(org.bson.Document obj) Wraps a result from Mongo DB

Method Summary

Modifier and Type	Method and Description
sirius.kernel.commons.Value	get(Mapping field) Returns the value of the requested field wrapped as Value.
sirius.kernel.commons.Value	get(String field) Returns the value of the requested field wrapped as Value.
List<Object>	getList(Mapping field) Returns the list contained in the given field
List<Object>	getList(String field) Returns the list contained in the given field
org.bson.Document	getObject(Mapping field) Returns the object stored for the given field.
org.bson.Document	getObject(String field) Returns the object stored for the given field.
String	getString(Mapping field) Returns the string contents of the given field
String	getString(String field) Returns the string contents of the given field
List<String>	getStringList(Mapping field) Returns the list of strings contained in the given field
List<String>	getStringList(String field) Returns the list of strings contained in the given field
org.bson.Document	getUnderlyingObject() Retruns the underlying Mongo DB Obect.
sirius.kernel.commons.Value	getValueInObject(Mapping field, String key) Returns the inner value stored in the object in the given field.
sirius.kernel.commons.Value	getValueInObject(String field, String key) Returns the inner value stored in the object in the given field.
String	id() Returns the ID of the document
void	put(Mapping key, Object value) Updates the underlying object, without updating the database.
void	put(String key, Object value) Updates the underlying object, without updating the database.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Doc

public Doc(org.bson.Document obj)

Wraps a result from Mongo DB

Parameters:

obj - the document or object to wrap

Method Detail

id

public String id()

Returns the ID of the document

Returns:

the id as assigned by mongo db

get

public sirius.kernel.commons.Value get(String field)

Returns the value of the requested field wrapped as Value.

Parameters:

field - the field to fetch

Returns:

the value for the given field

get

public sirius.kernel.commons.Value get(Mapping field)

Returns the value of the requested field wrapped as Value.

Parameters:

field - the field to fetch

Returns:

the value for the given field

getString

@Nonnull
public String getString(String field)

Returns the string contents of the given field

Parameters:

field - the field to fetch

Returns:

the string contents or "" if the field is empty

getString

@Nonnull
public String getString(Mapping field)

Returns the string contents of the given field

Parameters:

field - the field to fetch

Returns:

the string contents or "" if the field is empty

getList

public List<Object> getList(String field)

Returns the list contained in the given field

Parameters:

field - the field to fetch

Returns:

the list contained in the given field or an empty list, if the field was empty

getList

public List<Object> getList(Mapping field)

Returns the list contained in the given field

Parameters:

field - the field to fetch

Returns:

the list contained in the given field or an empty list, if the field was empty

getStringList

public List<String> getStringList(String field)

Returns the list of strings contained in the given field

Parameters:

field - the field to fetch

Returns:

the list contained in the given field or an empty list, if the field was empty

getStringList

public List<String> getStringList(Mapping field)

Returns the list of strings contained in the given field

Parameters:

field - the field to fetch

Returns:

the list contained in the given field or an empty list, if the field was empty

getObject

public org.bson.Document getObject(String field)

Returns the object stored for the given field.

If there is no object present or the given field doesn't contain an object, an empty readonly instance is returned.

Parameters:

field - the field to read

Returns:

the object stored for the field

getObject

public org.bson.Document getObject(Mapping field)

Returns the object stored for the given field.

If there is no object present or the given field doesn't contain an object, an empty readonly instance is returned.

Parameters:

field - the field to read

Returns:

the object stored for the field

getValueInObject

public sirius.kernel.commons.Value getValueInObject(String field,
                                                    String key)

Returns the inner value stored in the object in the given field.

Parameters:

field - the field to read the object from

key - the key to read from the object

Returns:

the value within the inner object wrapped as Value

getValueInObject

public sirius.kernel.commons.Value getValueInObject(Mapping field,
                                                    String key)

Returns the inner value stored in the object in the given field.

Parameters:

field - the field to read the object from

key - the key to read from the object

Returns:

the value within the inner object wrapped as Value

put

public void put(String key,
                Object value)

Updates the underlying object, without updating the database.

This can be used to enhance an existing object after an update for further consumers. This is not intended to update or modify the database in any way. Use Mongo.update() instead.

Parameters:

key - the field to update

value - the new value for the field

put

public void put(Mapping key,
                Object value)

Updates the underlying object, without updating the database.

This can be used to enhance an existing object after an update for further consumers. This is not intended to update or modify the database in any way. Use Mongo.update() instead.

Parameters:

key - the field to update

value - the new value for the field

toString

public String toString()

Overrides:

toString in class Object

getUnderlyingObject

public org.bson.Document getUnderlyingObject()

Retruns the underlying Mongo DB Obect.

Returns:

the underlying object