com.landawn.abacus.util

Class MongoDB

java.lang.Object

com.landawn.abacus.util.MongoDB

public final class MongoDB
extends java.lang.Object

It's a simple wrapper of MongoDB Java client.
We recommend to define "id" property in java entity/bean as the object "_id" in MongoDB to keep things as simple as possible.

Since:

0.8

Author:

Haiyang Li

See Also:

com.mongodb.client.model.Filters, com.mongodb.client.model.Aggregates, com.mongodb.client.model.Accumulators, com.mongodb.client.model.Projections, com.mongodb.client.model.Sorts

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_ID It's name of object id set in Map/Object array.
static java.lang.String	ID Property name of id.

Constructor Summary

Constructors

Constructor and Description
MongoDB(com.mongodb.client.MongoDatabase mongoDB)
MongoDB(com.mongodb.client.MongoDatabase mongoDB, AsyncExecutor asyncExecutor)

Method Summary

Modifier and Type	Method and Description
<T> com.mongodb.client.MongoCollection<T>	collection(java.lang.Class<T> targetClass, java.lang.String collectionName)
com.mongodb.client.MongoCollection<org.bson.Document>	collection(java.lang.String collectionName)
MongoCollectionExecutor	collExecutor(java.lang.String collectionName)
<T> MongoCollectionMapper<T>	collMapper(java.lang.Class<T> targetClass)
<T> MongoCollectionMapper<T>	collMapper(java.lang.Class<T> targetClass, java.lang.String collectionName)
com.mongodb.client.MongoDatabase	db()
static DataSet	extractData(java.lang.Class<?> targetClass, com.mongodb.client.MongoIterable<?> findIterable)
static DataSet	extractData(com.mongodb.client.MongoIterable<?> findIterable)
static <T> T	fromJSON(java.lang.Class<T> targetClass, java.lang.String json) Returns an instance of the specified target class with the property values from the specified JSON String.
static void	registerIdProeprty(java.lang.Class<?> cls, java.lang.String idPropertyName) The object id ("_id") property will be read from/write to the specified property
static org.bson.conversions.Bson	toBson(java.lang.Object... a) Create a new document with specified parameter(s).
static org.bson.conversions.Bson	toBson(java.lang.Object obj)
static org.bson.BasicBSONObject	toBSONObject(java.lang.Object... a)
static org.bson.BasicBSONObject	toBSONObject(java.lang.Object obj)
static com.mongodb.BasicDBObject	toDBObject(java.lang.Object... a)
static com.mongodb.BasicDBObject	toDBObject(java.lang.Object obj)
static org.bson.Document	toDocument(java.lang.Object... a) Create a new document with specified parameter(s).
static org.bson.Document	toDocument(java.lang.Object obj)
static <T> T	toEntity(java.lang.Class<T> targetClass, org.bson.Document doc) The id in the specified doc will be set to the returned object if and only if the id is not null or empty and it's acceptable to the targetClass.
static java.lang.String	toJSON(com.mongodb.BasicDBObject bsonObject)
static java.lang.String	toJSON(org.bson.conversions.Bson bson)
static java.lang.String	toJSON(org.bson.BSONObject bsonObject)
static <T> java.util.List<T>	toList(java.lang.Class<T> targetClass, com.mongodb.client.MongoIterable<?> findIterable)

Methods inherited from class java.lang.Object

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

Field Detail

_ID

public static final java.lang.String _ID

It's name of object id set in Map/Object array.

See Also:

Constant Field Values

ID

public static final java.lang.String ID

Property name of id.

See Also:

Constant Field Values

Constructor Detail

MongoDB

public MongoDB(com.mongodb.client.MongoDatabase mongoDB)

MongoDB

public MongoDB(com.mongodb.client.MongoDatabase mongoDB,
               AsyncExecutor asyncExecutor)

Method Detail

db

public com.mongodb.client.MongoDatabase db()

collection

public com.mongodb.client.MongoCollection<org.bson.Document> collection(java.lang.String collectionName)

collection

public <T> com.mongodb.client.MongoCollection<T> collection(java.lang.Class<T> targetClass,
                                                            java.lang.String collectionName)

collExecutor

public MongoCollectionExecutor collExecutor(java.lang.String collectionName)

collMapper

public <T> MongoCollectionMapper<T> collMapper(java.lang.Class<T> targetClass)

collMapper

public <T> MongoCollectionMapper<T> collMapper(java.lang.Class<T> targetClass,
                                               java.lang.String collectionName)

registerIdProeprty

public static void registerIdProeprty(java.lang.Class<?> cls,
                                      java.lang.String idPropertyName)

The object id ("_id") property will be read from/write to the specified property

Parameters:

cls -

idPropertyName -

extractData

public static DataSet extractData(com.mongodb.client.MongoIterable<?> findIterable)

extractData

public static DataSet extractData(java.lang.Class<?> targetClass,
                                  com.mongodb.client.MongoIterable<?> findIterable)

Parameters:

targetClass - an entity class with getter/setter method or Map.class/Document.class

findIterable -

Returns:

toList

public static <T> java.util.List<T> toList(java.lang.Class<T> targetClass,
                                           com.mongodb.client.MongoIterable<?> findIterable)

Parameters:

targetClass - an entity class with getter/setter method, Map.class or basic single value type(Primitive/String/Date...)

findIterable -

Returns:

toEntity

public static <T> T toEntity(java.lang.Class<T> targetClass,
                             org.bson.Document doc)

The id in the specified doc will be set to the returned object if and only if the id is not null or empty and it's acceptable to the targetClass.

Parameters:

targetClass - an entity class with getter/setter method, or Map.class.

doc -

Returns:

toJSON

public static java.lang.String toJSON(org.bson.conversions.Bson bson)

toJSON

public static java.lang.String toJSON(org.bson.BSONObject bsonObject)

toJSON

public static java.lang.String toJSON(com.mongodb.BasicDBObject bsonObject)

fromJSON

public static <T> T fromJSON(java.lang.Class<T> targetClass,
                             java.lang.String json)

Returns an instance of the specified target class with the property values from the specified JSON String.

Parameters:

targetClass - Bson.class, Document.class, BasicBSONObject.class, BasicDBObject.class

json -

Returns:

toBson

public static org.bson.conversions.Bson toBson(java.lang.Object obj)

Parameters:

obj - an array of pairs of property name and value/Map or an entity with getter/setter methods.

Returns:

toBson

@SafeVarargs
public static org.bson.conversions.Bson toBson(java.lang.Object... a)

Create a new document with specified parameter(s). It could an array of property name and value, or a map, or an entity.

Parameters:

a -

Returns:

toDocument

public static org.bson.Document toDocument(java.lang.Object obj)

Parameters:

obj - an array of pairs of property name and value/Map or an entity with getter/setter methods.

Returns:

toDocument

@SafeVarargs
public static org.bson.Document toDocument(java.lang.Object... a)

Create a new document with specified parameter(s). It could an array of property name and value, or a map, or an entity.

Parameters:

a -

Returns:

toBSONObject

public static org.bson.BasicBSONObject toBSONObject(java.lang.Object obj)

Parameters:

obj - an array of pairs of property name and value/Map or an entity with getter/setter methods.

Returns:

toBSONObject

@SafeVarargs
public static org.bson.BasicBSONObject toBSONObject(java.lang.Object... a)

toDBObject

public static com.mongodb.BasicDBObject toDBObject(java.lang.Object obj)

Parameters:

obj - an array of pairs of property name and value/Map or an entity with getter/setter methods.

Returns:

toDBObject

@SafeVarargs
public static com.mongodb.BasicDBObject toDBObject(java.lang.Object... a)