Interface QueryFactory

core/src/main/java/dev/morphia/query/QueryFactory.java:14–67

A factory for queries. @see Query

 * @see Query
 */
public interface QueryFactory {

    /**
     * Creates a new query for the given type.
     *
     * @param datastore the datastore
     * @param type      the query type
     * @param <T>       the query type
     * @return the new query
     */
    default <T> Query<T> createQuery(Datastore datastore, Class<T> type, FindOptions options) {
        return createQuery(datastore, type, options, null);
    }

    /**
     * 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 type      the type of the result
     * @param query     the Document containing the query structure
     * @param <T>       the type of the result
     * @return the query
     */
    <T> Query<T> createQuery(Datastore datastore, Class<T> type, FindOptions options, @Nullable Document query);

    /**
     * Creates and returns a {@link Query} for the given arguments. Default implementations of this method will simply delegate to {@link
     * #createQuery(Datastore, Class, FindOptions)} with the last argument being {@code null}.
     *
     * @param datastore  the Datastore to use
     * @param collection the actual collection to query. This overrides any mapped on collection on type.
     * @param type       the type of the result
     * @param <T>        the type of the result
     * @return the query
     * @see #createQuery(Datastore, Class, FindOptions)
     * @deprecated use {@link #createQuery(Datastore, Class, FindOptions, Document)}
     */
    default <T> Query<T> createQuery(Datastore datastore, String collection, Class<T> type) {
        return createQuery(datastore, type, new FindOptions().collection(collection), null);
    }

    /**
     * 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
     * @deprecated this method is no longer used
     */
    @Deprecated(forRemoval = true)
    default <T> Query<T> createQuery(Datastore datastore) {
        throw new UnsupportedOperationException();
    }
}