package org.mongodb.morphia.query;

import com.mongodb.DBCollection;
import com.mongodb.DBObject;
import org.mongodb.morphia.Datastore;

A factory for Queryies. /**
 * A factory for {@link Query}ies.
 */
public interface QueryFactory {

    
Creates and returns a Query for the given arguments. Default implementations of this method will simply delegate to createQuery(Datastore, DBCollection, Class<Object>, DBObject) with the last argument being null. 
Params:
datastore –  the Datastore to use
collection – the collection to query
type –       the type of the result
Type parameters:
<T> –        the type of the result
See Also:
createQuery(Datastore, DBCollection, Class<Object>, DBObject)
Returns:
the query/**
     * Creates and returns a {@link Query} for the given arguments. Default implementations of this method will simply delegate to {@link
     * #createQuery(Datastore, DBCollection, Class, DBObject)} with the last argument being {@code null}.
     *
     * @param datastore  the Datastore to use
     * @param collection the collection to query
     * @param type       the type of the result
     * @param <T>        the type of the result
     * @return the query
     * @see #createQuery(Datastore, DBCollection, Class, DBObject)
     */
    <T> Query<T> createQuery(Datastore datastore, DBCollection collection, Class<T> type);

    
Creates and returns a Query for the given arguments. The last argument is optional and may be null. 
Params:
datastore –  the Datastore to use
collection – the collection to query
type –       the type of the result
query –      the DBObject containing the query structure
Type parameters:
<T> –        the type of the result
Returns:
the query/**
     * Creates and returns a {@link Query} for the given arguments. The last argument is optional and may be {@code null}.
     *
     * @param datastore  the Datastore to use
     * @param collection the collection to query
     * @param type       the type of the result
     * @param query      the DBObject containing the query structure
     * @param <T>        the type of the result
     * @return the query
     */
    <T> Query<T> createQuery(Datastore datastore, DBCollection collection, Class<T> type, DBObject query);

    
Creates an unvalidated Query typically for use in aggregation pipelines. 
Params:
datastore – the Datastore to use
Type parameters:
<T> –       the type of the result
Returns:
the query/**
     * Creates an unvalidated {@link Query} typically for use in aggregation pipelines.
     *
     * @param datastore the Datastore to use
     * @param <T>       the type of the result
     * @return the query
     */
    <T> Query<T> createQuery(Datastore datastore);
}