com.arangodb.InternalCursorDriver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of arangodb-java-driver Show documentation
ArangoDB Java Driver
There is a newer version: 7.15.0
package com.arangodb;

import java.util.Map;

import com.arangodb.entity.CursorEntity;
import com.arangodb.entity.DefaultEntity;
import com.arangodb.entity.DocumentEntity;
import com.arangodb.entity.ShortestPathEntity;
import com.arangodb.impl.BaseDriverInterface;
import com.arangodb.util.AqlQueryOptions;
import com.arangodb.util.ShortestPathOptions;

/**
 * Created by fbartels on 10/27/14.
 * 
 */
public interface InternalCursorDriver extends BaseDriverInterface {

	CursorEntity validateQuery(String database, String query) throws ArangoException;

	// request without DocumentEntity
	 CursorEntity executeCursorEntityQuery(
		String database,
		String query,
		Map bindVars,
		AqlQueryOptions aqlQueryOptions,
		Class... clazz) throws ArangoException;

	 CursorEntity continueQuery(String database, long cursorId, Class... clazz) throws ArangoException;

	DefaultEntity finishQuery(String database, long cursorId) throws ArangoException;

	// request a cursor without DocumentEntity
	 CursorResult executeAqlQuery(
		String database,
		String query,
		Map bindVars,
		AqlQueryOptions aqlQueryOptions,
		Class clazz) throws ArangoException;

	// request a cursor with DocumentEntity
	> DocumentCursorResult executeBaseCursorQuery(
		String database,
		String query,
		Map bindVars,
		AqlQueryOptions aqlQueryOptions,
		Class classDocumentEntity,
		Class clazz) throws ArangoException;

	/**
	 * Get the shortest path from a vertex to another vertex
	 * 
	 * @param database
	 *            the database name
	 * @param graphName
	 *            the graph name
	 * @param startVertexExample
	 *            a start vertex example object (or null)
	 * @param endVertexExample
	 *            a start vertex example object (or null)
	 * @param shortestPathOptions
	 *            shortest path options
	 * @param aqlQueryOptions
	 *            AQL query options
	 * @param vertexClass
	 *            the vertex class
	 * @param edgeClass
	 *            the edge class
	 * @return a ShortestPathEntity object
	 * @throws ArangoException
	 */
	public  ShortestPathEntity getShortestPath(
		String database,
		String graphName,
		Object startVertexExample,
		Object endVertexExample,
		ShortestPathOptions shortestPathOptions,
		AqlQueryOptions aqlQueryOptions,
		Class vertexClass,
		Class edgeClass) throws ArangoException;

	@Deprecated
	 CursorEntity executeQuery(
		String database,
		String query,
		Map bindVars,
		Class clazz,
		Boolean calcCount,
		Integer batchSize,
		Boolean fullCount) throws ArangoException;

	@Deprecated
	 CursorResultSet executeQueryWithResultSet(
		String database,
		String query,
		Map bindVars,
		Class clazz,
		Boolean calcCount,
		Integer batchSize,
		Boolean fullCount) throws ArangoException;

	@Deprecated
	 CursorResultSet executeQueryWithResultSet(
		String database,
		String query,
		Map bindVars,
		Class clazz,
		Boolean calcCount,
		Integer batchSize) throws ArangoException;
}