org.jnosql.artemis.document.query.DocumentMapperQueryBuild Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of artemis-document Show documentation
Eclipse JNoSQL Mapping, Artemis API, to document NoSQL databases
The newest version!
/*
 *  Copyright (c) 2017 Otávio Santana and others
 *   All rights reserved. This program and the accompanying materials
 *   are made available under the terms of the Eclipse Public License v1.0
 *   and Apache License v2.0 which accompanies this distribution.
 *   The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 *   and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
 *
 *   You may elect to redistribute this code under either of these licenses.
 *
 *   Contributors:
 *
 *   Otavio Santana
 */
package org.jnosql.artemis.document.query;

import org.jnosql.artemis.Page;
import org.jnosql.artemis.Pagination;
import org.jnosql.artemis.document.DocumentTemplate;
import org.jnosql.artemis.document.DocumentTemplateAsync;
import org.jnosql.diana.api.document.DocumentQuery;

import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;


/**
 * The last step to the build of {@link org.jnosql.diana.api.document.DocumentQuery}.
 * It either can return a new {@link org.jnosql.diana.api.document.DocumentQuery} instance or execute a query with
 * {@link DocumentTemplate}
 * and {@link DocumentTemplateAsync}
 */
public interface DocumentMapperQueryBuild {

    /**
     * Creates a new instance of {@link DocumentQuery}
     *
     * @return a new {@link DocumentQuery} instance
     */
    DocumentQuery build();

    /**
     * Creates a new instance of {@link DocumentQuery} from {@link Pagination}
     *
     * @param pagination the pagination
     * @return a new {@link DocumentQuery} instance from {@link Pagination}
     */
    DocumentQuery build(Pagination pagination);

    /**
     * Executes {@link DocumentTemplate#select(DocumentQuery)}
     *
     * @param       the entity type
     * @param template the template to document
     * @return the result of {@link DocumentTemplate#select(DocumentQuery)}
     * @throws NullPointerException when manager is null
     */
     List execute(DocumentTemplate template);

    /**
     * Executes {@link DocumentTemplate#singleResult(DocumentQuery)}
     *
     * @param       the entity type
     * @param template the template to document
     * @return the result of {@link DocumentTemplate#singleResult(DocumentQuery)}
     * @throws NullPointerException when manager is null
     */
     Optional executeSingle(DocumentTemplate template);

    /**
     * Executes {@link DocumentTemplate#select(DocumentQuery)} using {@link Pagination}
     *
     * @param         the entity type
     * @param template   the document template
     * @param pagination the pagination
     * @return the result of {@link DocumentTemplate#select(DocumentQuery)}
     * @throws NullPointerException when there are null parameters
     */
     List execute(DocumentTemplate template, Pagination pagination);

    /**
     * Executes {@link DocumentTemplate#singleResult(DocumentQuery)} using {@link Pagination}
     *
     * @param         the entity type
     * @param template   the document template
     * @param pagination the pagination
     * @return the result of {@link DocumentTemplate#singleResult(DocumentQuery)}
     * @throws NullPointerException when there are null parameters
     */
     Optional executeSingle(DocumentTemplate template, Pagination pagination);

    /**
     * Executes {@link DocumentTemplateAsync#select(DocumentQuery, Consumer)}
     *
     * @param            the entity type
     * @param templateAsync the templateAsync
     * @param callback      the callback
     * @throws NullPointerException when there is null parameter
     */
     void execute(DocumentTemplateAsync templateAsync, Consumer> callback);

    /**
     * Executes {@link DocumentTemplateAsync#singleResult(DocumentQuery, Consumer)}
     *
     * @param            the entity type
     * @param templateAsync the templateAsync
     * @param callback      the callback
     * @throws NullPointerException when there is null parameter
     */
     void executeSingle(DocumentTemplateAsync templateAsync, Consumer> callback);

    /**
     * Creates a {@link Page} from pagination
     *
     * @param pagination the pagination
     * @param template   the template
     * @param         the type
     * @return a {@link Page} from instance
     * @throws NullPointerException when there are null parameters
     */
     Page page(DocumentTemplate template, Pagination pagination);

}