io.mangoo.persistence.interfaces.Datastore Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mangooio-core Show documentation
The newest version!
package io.mangoo.persistence.interfaces;

import com.mongodb.client.MongoCollection;
import com.mongodb.client.model.IndexOptions;
import com.mongodb.client.result.DeleteResult;
import org.bson.conversions.Bson;

import java.util.List;

public interface Datastore {

    /**
     * Retrieves a MongoDB entity from the database by the given query
     *
     * @param clazz The corresponding class
     * @param query The query to use
     * @param  Type
     *
     * @return The requested object from MongoDB or null if not found
     */
     T find(Class clazz, Bson query);

    /**
     * Retrieves the first MongoDB entity from the database sorted
     * by the given Bson sort
     *
     * @param clazz The corresponding class
     * @param sort The sort to use
     * @param  Type
     *
     * @return The requested object from MongoDB or null if not found
     */
     T findFirst(Class clazz, Bson sort);

    /**
     * Retrieves a MongoDB entity from the database
     *
     * @param clazz The corresponding class
     * @param query The query to use
     * @param sort The sort to use
     * @param  Type
     *
     * @return A list of MongoDB objects or an empty list if none found
     */
     List findAll(Class clazz, Bson query, Bson sort);

    /**
     * Retrieves a MongoDB entity from the database
     *
     * @param clazz The corresponding class
     * @param query The query to use
     * @param sort The sort to use
     * @param limit The limit of returned entities
     * @param  Type
     *
     * @return A list of MongoDB objects or an empty list if none found
     */
     List findAll(Class clazz, Bson query, Bson sort, int limit);

    /**
     * Retrieves MongoDB entities from the database
     *
     * @param clazz The corresponding class
     * @param  Type
     *
     * @return A list of MongoDB objects or an empty list if none found
     */
     List findAll(Class clazz);

    /**
     * Retrieves a MongoDB entity from the database
     *
     * @param clazz The corresponding class
     * @param sort The sort to use
     * @param  Type
     *
     * @return A list of MongoDB objects or an empty list if none found
     */
     List findAll(Class clazz, Bson sort);

    /**
     * Counts all objected of a MongoDB entity based on the given query
     *
     * @param clazz The corresponding class
     * @param  Type
     *
     * @return The number of objects in MongoDB or -1 if count failed
     */
     long countAll(Class clazz, Bson query);

    /**
     * Counts all objected of a MongoDB entity
     *
     * @param clazz The corresponding class
     * @param  Type
     *
     * @return The number of objects in MongoDB or -1 if count failed
     */
     long countAll(Class clazz);

    /**
     * Saves am entity to MongoDB
     *
     * @param object The object to save
     * @return The objectId of the stored entity or null if save failed
     */
    String save(Object object);

    /**
     * Saves a list of MongoDB entitiesB
     *
     * @param objects The list of objects
     * @param  Type
     */
     void saveAll(List objects);

    /**
     * Returns a collection to execute a query against the MongoDB database
     *
     * @param clazz The POJO entity class to query against
     * @param  Type
     * @return MongoCollection
     */
    @SuppressWarnings("rawtypes")
     MongoCollection query(Class clazz);

    /**
     * Returns a collection to execute a query against the MongoDB database
     *
     * @param collection The name of the collection
     * @return MongoCollection
     */
    @SuppressWarnings("rawtypes")
    MongoCollection query(String collection);

    /**
     * Deletes one object from the database
     *
     * @param object The object to delete
     * @return The DeleteResult
     */
    DeleteResult delete(Object object);

    /**
     * Deletes all given objects from the database
     *
     * @param objects The objects to delete
     */
    void deleteAll(List