org.eclipse.jnosql.mapping.arangodb.document.ArangoDBTemplate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arangodb-extension Show documentation

Eclipse JNoSQL mapping layer to ArangoDB

There is a newer version: 1.0.0-b4

/*
 *  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.eclipse.jnosql.mapping.arangodb.document;


import jakarta.nosql.mapping.document.DocumentTemplate;

import java.util.Map;
import java.util.stream.Stream;

/**
 * A {@link DocumentTemplate} to arangoDB
 */
public interface ArangoDBTemplate extends DocumentTemplate {

    /**
     * Executes ArangoDB query language, AQL.
     * FOR u IN users FILTER u.status == @status RETURN u 
     *
     * @param     entity class
     * @param query  the query
     * @param values the named queries
     * @return the query result
     * @throws NullPointerException when either query or values are null
     */
     Stream aql(String query, Map values);

    /**
     * Executes ArangoDB query language, AQL.
     * FOR u IN users FILTER u.status == @status RETURN u 
     *
     * @param query     the query
     * @param values    named query
     * @param typeClass The type of the result
     * @param        the type
     * @return the query result
     * @throws NullPointerException when either query or values are null
     */
     Stream aql(String query, Map values, Class typeClass);

    /**
     * Executes ArangoDB query language, AQL.
     * FOR u IN users FILTER u.status == @status RETURN u 
     *
     * @param query     the query
     * @param typeClass The type of the result
     * @param        the type
     * @return the query result
     * @throws NullPointerException when either query or values are null
     */
     Stream aql(String query, Class typeClass);


}