info.pascalkrause.vertx.mongodata.collection

Class MongoCollectionImpl<T>

java.lang.Object

info.pascalkrause.vertx.mongodata.collection.MongoCollectionImpl<T>

All Implemented Interfaces:

MongoCollection<T>

public class MongoCollectionImpl<T>
extends java.lang.Object
implements MongoCollection<T>

Constructor Summary

Constructors

Constructor and Description
MongoCollectionImpl(java.lang.String collectionName, java.util.function.Function<T,io.vertx.core.json.JsonObject> encode, java.util.function.Function<io.vertx.core.json.JsonObject,T> decode, MongoDataSource mds) Important: When implementing the transformations, check that you use the key "_id" for the id.

Method Summary

Modifier and Type	Method and Description
MongoCollectionImpl<T>	bulkInsert(java.util.Collection<T> resources, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>> resultHandler) Inserts many resources into the collection.
MongoCollectionImpl<T>	count(io.vertx.core.json.JsonObject query, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>> resultHandler) Count matching entries in a collection.
MongoCollectionImpl<T>	countAll(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>> resultHandler) Count all entries in a collection.
MongoCollection<T>	createIndex(Index index, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>> resultHandler) Creates an index.
MongoCollection<T>	deleteIndex(java.lang.String name, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>> resultHandler) Deletes an index.
MongoCollectionImpl<T>	drop(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>> resultHandler) Drop the collection.
MongoCollectionImpl<T>	find(io.vertx.core.json.JsonObject query, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<T>>> resultHandler) Finds matching entries in a collection.
MongoCollectionImpl<T>	findAll(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<T>>> resultHandler) Finds all entries in a collection.
java.lang.String	getCollectionName()
MongoCollection<T>	listIndexes(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<Index>>> resultHandler) List all indexes.
MongoCollectionImpl<T>	remove(io.vertx.core.json.JsonObject query, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>> resultHandler) Remove matching entries in a collection.
MongoCollectionImpl<T>	remove(java.lang.String id, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>> resultHandler) Removes the resource with the passed ID from the collection.
MongoCollectionImpl<T>	upsert(T resource, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.String>> resultHandler) Insert or update a resource into the collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoCollectionImpl

public MongoCollectionImpl(java.lang.String collectionName,
                           java.util.function.Function<T,io.vertx.core.json.JsonObject> encode,
                           java.util.function.Function<io.vertx.core.json.JsonObject,T> decode,
                           MongoDataSource mds)

Important: When implementing the transformations, check that you use the key "_id" for the id. For binary types you should use a new JsonObject which contains a key with the name "$binary".

Example:

 {
     JsonObject encoded = new JsonObject();
     encoded.put("_id", resource.getId());
     encoded.put("image", new JsonObject().put("$binary", resource.getImageBytes()));
 }
 

Parameters:

collectionName - The name of the collection in the database.

encode - A method to transform the resource object into a JsonObject which can be handled by the database.

decode - A method to transform the JsonObject return from the database into a resource object.

mds - A MongoDataSource which is used to talk with the Mongo database.

Method Detail

getCollectionName

public java.lang.String getCollectionName()

Specified by:

getCollectionName in interface MongoCollection<T>

Returns:

The name of the collection.

countAll

public MongoCollectionImpl<T> countAll(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>> resultHandler)

Description copied from interface: MongoCollection

Count all entries in a collection.

Specified by:

countAll in interface MongoCollection<T>

Parameters:

resultHandler - A handler to handle the AsnycResult which contains the number of all entries.

Returns:

The actual MongoCollection.

count

public MongoCollectionImpl<T> count(io.vertx.core.json.JsonObject query,
                                    io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>> resultHandler)

Description copied from interface: MongoCollection

Count matching entries in a collection.

Specified by:

count in interface MongoCollection<T>

Parameters:

query - A filter for the count request. For counting all entries in a collection use MongoCollection.countAll(Handler).

resultHandler - A handler to handle the AsnycResult which contains the number of matching entries.

Returns:

The actual MongoCollection.

bulkInsert

public MongoCollectionImpl<T> bulkInsert(java.util.Collection<T> resources,
                                         io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>> resultHandler)

Description copied from interface: MongoCollection

Inserts many resources into the collection.

Specified by:

bulkInsert in interface MongoCollection<T>

Parameters:

resources - A collection of resources to insert into the collection.

resultHandler - A handler to handle the AsnycResult which contains the number of inserted resources.

Returns:

The actual MongoCollection.

upsert

public MongoCollectionImpl<T> upsert(T resource,
                                     io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.String>> resultHandler)

Description copied from interface: MongoCollection

Insert or update a resource into the collection.

Specified by:

upsert in interface MongoCollection<T>

Parameters:

resource - The resource to insert or update.

resultHandler - A handler to handle the AsnycResult which contains a String with the new id (insert), or null (update).

Returns:

The actual MongoCollection.

findAll

public MongoCollectionImpl<T> findAll(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<T>>> resultHandler)

Description copied from interface: MongoCollection

Finds all entries in a collection.

Specified by:

findAll in interface MongoCollection<T>

Parameters:

resultHandler - A handler to handle the AsnycResult which contains a List with all entries.

Returns:

The actual MongoCollection.

find

public MongoCollectionImpl<T> find(io.vertx.core.json.JsonObject query,
                                   io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<T>>> resultHandler)

Description copied from interface: MongoCollection

Finds matching entries in a collection.

Specified by:

find in interface MongoCollection<T>

Parameters:

query - A filter for the find request. For finding all entries in a collection use MongoCollection.findAll(Handler).

resultHandler - A handler to handle the AsnycResult which contains a List with all matching entries.

Returns:

The actual MongoCollection.

remove

public MongoCollectionImpl<T> remove(io.vertx.core.json.JsonObject query,
                                     io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>> resultHandler)

Description copied from interface: MongoCollection

Remove matching entries in a collection.

Specified by:

remove in interface MongoCollection<T>

Parameters:

query - A filter for the remove request.

resultHandler - A handler to handle the AsnycResult which contains the number of deleted entries.

Returns:

The actual MongoCollection.

remove

public MongoCollectionImpl<T> remove(java.lang.String id,
                                     io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Long>> resultHandler)

Description copied from interface: MongoCollection

Removes the resource with the passed ID from the collection.

Specified by:

remove in interface MongoCollection<T>

Parameters:

id - The ID of the resource to delete.

resultHandler - A handler to handle the AsnycResult which contains the number of deleted entries.

Returns:

The actual MongoCollection.

drop

public MongoCollectionImpl<T> drop(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>> resultHandler)

Description copied from interface: MongoCollection

Drop the collection.

Specified by:

drop in interface MongoCollection<T>

Parameters:

resultHandler - A handler which will be called when complete.

Returns:

The actual MongoCollection.

listIndexes

public MongoCollection<T> listIndexes(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<Index>>> resultHandler)

Description copied from interface: MongoCollection

List all indexes.

Specified by:

listIndexes in interface MongoCollection<T>

Parameters:

resultHandler - A handler which contains a list of indexes.

Returns:

The actual MongoCollection.

createIndex

public MongoCollection<T> createIndex(Index index,
                                      io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>> resultHandler)

Description copied from interface: MongoCollection

Creates an index. If there is already an index with this name, it will be overridden.

Specified by:

createIndex in interface MongoCollection<T>

Parameters:

index - An Index object, that represents the index.

resultHandler - A handler which will be called when the index is created.

Returns:

The actual MongoCollection.

deleteIndex

public MongoCollection<T> deleteIndex(java.lang.String name,
                                      io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>> resultHandler)

Description copied from interface: MongoCollection

Deletes an index.

Specified by:

deleteIndex in interface MongoCollection<T>

Parameters:

name - The name of the index which should be deleted.

resultHandler - A handler which will be called when the index is deleted.

Returns:

The actual MongoCollection.