org.nuxeo.ecm.core.storage.mongodb

Class MongoDBConverter

java.lang.Object

org.nuxeo.ecm.core.storage.mongodb.MongoDBConverter

public class MongoDBConverter
extends Object

Converts between MongoDB types (bson) and DBS types (diff, state, list, serializable).

The MongoDB native "_id" can optionally be translated into a custom id in memory (usually "ecm:id"). Otherwise it is stripped from returned results.

Since:

9.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MongoDBConverter.UpdateBuilder Update list builder to prevent several updates of the same field.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	idKey The key to use in memory to map the database native "_id".

Constructor Summary

Constructors

Constructor and Description
MongoDBConverter() Constructor for a converter that does not map the MongoDB native "_id".
MongoDBConverter(String idKey) Constructor for a converter that also knows to optionally translate the native MongoDB "_id" into a custom id.

Method Summary

Modifier and Type	Method and Description
String	bsonToKey(String key)
State	bsonToState(org.bson.Document doc)
Serializable	bsonToValue(Object value)
List<org.bson.Document>	diffToBson(State.StateDiff diff) Constructs a list of MongoDB updates from the given State.StateDiff.
String	keyToBson(String key)
List<Object>	listToBson(List<Object> values)
Serializable	scalarToSerializable(Object val)
Class<?>	scalarToSerializableClass(Class<?> klass)
Object	serializableToBson(Object value)
org.bson.Document	stateToBson(State state)
Object	valueToBson(Object value)

Methods inherited from class java.lang.Object

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

Field Detail

idKey

protected final String idKey

The key to use in memory to map the database native "_id".

Constructor Detail

MongoDBConverter

public MongoDBConverter()

Constructor for a converter that does not map the MongoDB native "_id".

Since:

10.3

MongoDBConverter

public MongoDBConverter(String idKey)

Constructor for a converter that also knows to optionally translate the native MongoDB "_id" into a custom id.

Parameters:

idKey - the key to use to map the native "_id" in memory, if not null

Method Detail

diffToBson

public List<org.bson.Document> diffToBson(State.StateDiff diff)

Constructs a list of MongoDB updates from the given State.StateDiff.

We need a list because some cases need two operations to avoid conflicts.

keyToBson

public String keyToBson(String key)

valueToBson

public Object valueToBson(Object value)

stateToBson

public org.bson.Document stateToBson(State state)

listToBson

public List<Object> listToBson(List<Object> values)

bsonToKey

public String bsonToKey(String key)

bsonToState

public State bsonToState(org.bson.Document doc)

bsonToValue

public Serializable bsonToValue(Object value)

serializableToBson

public Object serializableToBson(Object value)

scalarToSerializable

public Serializable scalarToSerializable(Object val)

scalarToSerializableClass

public Class<?> scalarToSerializableClass(Class<?> klass)