Replace graph_edge function with aql

Author: Mark

src/main/java/com/arangodb/ArangoDriver.java

@@ -79,6 +79,7 @@
 import com.arangodb.util.AqlQueryOptions;
 import com.arangodb.util.DumpHandler;
 import com.arangodb.util.GraphEdgesOptions;
+import com.arangodb.util.GraphQueryUtil;
 import com.arangodb.util.GraphVerticesOptions;
 import com.arangodb.util.JsonUtils;
 import com.arangodb.util.MapBuilder;
@@ -3516,7 +3517,22 @@ public void deleteGraph(final String graphName, final Boolean dropCollections) t
 	 * @throws ArangoException
 	 */
 	public List<String> graphGetVertexCollections(final String graphName) throws ArangoException {
-		return graphDriver.getVertexCollections(getDefaultDatabase(), graphName);
+		return graphGetVertexCollections(graphName, false);
+	}
+
+	/**
+	 * Returns a list of all vertex collection of a graph that are defined in
+	 * the graphs edgeDefinitions (in "from", "to", and "orphanCollections")
+	 *
+	 * @param graphName
+	 *            The graph name.
+	 * @param excludeOrphan
+	 * @return List<String> List of the names of the vertex collections
+	 * @throws ArangoException
+	 */
+	public List<String> graphGetVertexCollections(final String graphName, final boolean excludeOrphan)
+			throws ArangoException {
+		return graphDriver.getVertexCollections(getDefaultDatabase(), graphName, excludeOrphan);
 	}
 
 	/**
@@ -4368,6 +4384,7 @@ public <T> VertexCursor<T> executeVertexQuery(
 	 * @return EdgeCursor<T>
 	 * @throws ArangoException
 	 */
+	@SuppressWarnings("unchecked")
 	public <T> EdgeCursor<T> graphGetEdgeCursor(
 		final String graphName,
 		final Class<T> clazz,
@@ -4382,17 +4399,20 @@ public <T> EdgeCursor<T> graphGetEdgeCursor(
 
 		validateCollectionName(graphName);
 
-		final String query = "for i in graph_edges(@graphName, @vertexExample, @options) return i";
-		final Map<String, Object> bindVars = new MapBuilder().put(GRAPH_NAME, graphName)
-				.put(VERTEX_EXAMPLE, JsonUtils.convertNullToMap(vertexExample))
-				.put("options", JsonUtils.convertNullToMap(tmpGraphEdgesOptions)).get();
+		final MapBuilder mapBuilder = new MapBuilder();
+		final String query = GraphQueryUtil.createEdgeQuery(this, graphName, clazz, vertexExample, tmpGraphEdgesOptions,
+			mapBuilder);
+		final Map<String, Object> bindVars = mapBuilder.get();
 
 		AqlQueryOptions tmpAqlQueryOptions = aqlQueryOptions;
 		if (tmpAqlQueryOptions == null) {
 			tmpAqlQueryOptions = getDefaultAqlQueryOptions().setCount(true);
 		}
 
-		return executeEdgeQuery(query, bindVars, tmpAqlQueryOptions, clazz);
+		DocumentCursorResult<T, EdgeEntity<T>> cursor = executeAqlQueryWithDocumentCursorResult(query, bindVars,
+			tmpAqlQueryOptions, EdgeEntity.class, clazz);
+
+		return new EdgeCursor<T>(cursor);
 	}
 
 	/**

src/main/java/com/arangodb/InternalGraphDriver.java

@@ -112,7 +112,8 @@ GraphEntity createGraph(
 	 * @return List<String>
 	 * @throws ArangoException
 	 */
-	List<String> getVertexCollections(String databaseName, String graphName) throws ArangoException;
+	List<String> getVertexCollections(String databaseName, String graphName, boolean excludeOrphan)
+			throws ArangoException;
 
 	/**
 	 * 

src/main/java/com/arangodb/impl/InternalGraphDriverImpl.java

@@ -53,6 +53,7 @@ public class InternalGraphDriverImpl extends BaseArangoDriverWithCursorImpl
 	private static final String UNKNOWN_ERROR = "unknown error";
 	private static final String VERTEX = "/vertex";
 	private static final String EDGE = "/edge";
+	private static final String EXCLUDE_ORPHAN = "excludeOrphan";
 
 	InternalGraphDriverImpl(final ArangoConfigure configure, final InternalCursorDriver cursorDriver,
 		final HttpManager httpManager) {
@@ -146,10 +147,14 @@ public DeletedEntity deleteGraph(final String databaseName, final String graphNa
 	}
 
 	@Override
-	public List<String> getVertexCollections(final String databaseName, final String graphName) throws ArangoException {
+	public List<String> getVertexCollections(
+		final String databaseName,
+		final String graphName,
+		final boolean excludeOrphan) throws ArangoException {
 		validateCollectionName(graphName);
-		final HttpResponseEntity res = httpManager
-				.doGet(createGharialEndpointUrl(databaseName, StringUtils.encodeUrl(graphName), VERTEX));
+		final HttpResponseEntity res = httpManager.doGet(
+			createGharialEndpointUrl(databaseName, StringUtils.encodeUrl(graphName), VERTEX),
+			new MapBuilder().put(EXCLUDE_ORPHAN, excludeOrphan).get());
 
 		if (wrongResult(res)) {
 			throw new ArangoException(UNKNOWN_ERROR);

src/main/java/com/arangodb/util/GraphEdgesOptions.java

@@ -15,8 +15,8 @@ public class GraphEdgesOptions extends AbstractOptions implements OptionsInterfa
 	private Object neighborExamples;
 	private Integer minDepth;
 	private Integer maxDepth;
-	private Integer maxIterations;
-	private Boolean includeData = Boolean.TRUE;
+	private Integer limit;
+	private Boolean includeData = Boolean.TRUE;// false = i._id, true = i
 
 	/**
 	 * The direction of the edges as a string. Possible values are outbound,
@@ -194,25 +194,12 @@ public GraphEdgesOptions setMaxDepth(Integer maxDepth) {
 		return this;
 	}
 
-	/**
-	 * the maximum number of iterations that the traversal is allowed to
-	 * perform. It is sensible to set this number so unbounded traversals
-	 * 
-	 * @return the maximum number of iterations
-	 */
-	public Integer getMaxIterations() {
-		return maxIterations;
+	public Integer getLimit() {
+		return limit;
 	}
 
-	/**
-	 * the maximum number of iterations that the traversal is allowed to
-	 * perform. It is sensible to set this number so unbounded traversals
-	 * 
-	 * @return this
-	 * @param maxIterations
-	 */
-	public GraphEdgesOptions setMaxIterations(Integer maxIterations) {
-		this.maxIterations = maxIterations;
+	public GraphEdgesOptions setLimit(Integer limit) {
+		this.limit = limit;
 		return this;
 	}
 
@@ -248,7 +235,6 @@ public Map<String, Object> toMap() {
 		putAttribute(mp, "neighborExamples", neighborExamples);
 		putAttribute(mp, "minDepth", minDepth);
 		putAttribute(mp, "maxDepth", maxDepth);
-		putAttribute(mp, "maxIterations", maxIterations);
 		putAttribute(mp, "includeData", includeData);
 
 		return mp.get();

src/main/java/com/arangodb/util/GraphQueryUtil.java

@@ -0,0 +1,150 @@
+package com.arangodb.util;
+
+import java.util.List;
+import java.util.Map.Entry;
+import java.util.Set;
+
+import com.arangodb.ArangoDriver;
+import com.arangodb.ArangoException;
+import com.arangodb.Direction;
+import com.google.gson.Gson;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
+
+/**
+ * @author Mark - [email protected]
+ *
+ */
+public class GraphQueryUtil {
+
+	private static final String AND = " && ";
+	private static final String GRAPH_NAME = "graphName";
+	private static final String VERTEX_EXAMPLE = "vertexExample";
+
+	public static String createEdgeQuery(
+		final ArangoDriver driver,
+		final String graphName,
+		final Class<?> clazz,
+		final Object vertexExample,
+		final GraphEdgesOptions graphEdgesOptions,
+		final MapBuilder bindVars) throws ArangoException {
+
+		final StringBuilder sb = new StringBuilder();
+		if (vertexExample != null && String.class.isAssignableFrom(vertexExample.getClass())) {
+			sb.append("FOR v,i IN ");
+			appendDepth(graphEdgesOptions, sb);
+			appendDirection(graphEdgesOptions, sb);
+			sb.append(" @");
+			sb.append(VERTEX_EXAMPLE);
+			bindVars.put(VERTEX_EXAMPLE, JsonUtils.convertNullToMap(vertexExample));
+		} else {
+			final List<String> vertexCollections = driver.graphGetVertexCollections(graphName, true);
+			if (vertexCollections.size() == 1) {
+				sb.append("FOR start IN `");
+				sb.append(vertexCollections.get(0));
+				sb.append("`");
+				appendFilter(vertexExample, sb);
+			} else {
+				sb.append("FOR start IN UNION (");
+				for (String vertexCollection : vertexCollections) {
+					sb.append("(FOR start IN `");
+					sb.append(vertexCollection);
+					sb.append("`");
+					appendFilter(vertexExample, sb);
+					sb.append(" RETURN start),");
+				}
+				// remove last ,
+				sb.deleteCharAt(sb.length() - 1);
+				sb.append(")");
+			}
+			sb.append(" FOR v,i IN ");
+			appendDepth(graphEdgesOptions, sb);
+			appendDirection(graphEdgesOptions, sb);
+			sb.append(" start");
+		}
+		sb.append(" ");
+		final List<String> edgeCollectionRestriction = graphEdgesOptions.getEdgeCollectionRestriction();
+		if (edgeCollectionRestriction != null && edgeCollectionRestriction.size() > 0) {
+			for (String edgeCollection : edgeCollectionRestriction) {
+				sb.append(edgeCollection);
+				sb.append(",");
+			}
+			// remove last ,
+			sb.deleteCharAt(sb.length() - 1);
+		} else {
+			sb.append("GRAPH @");
+			sb.append(GRAPH_NAME);
+			bindVars.put(GRAPH_NAME, graphName);
+		}
+		final Integer limit = graphEdgesOptions.getLimit();
+		if (limit != null) {
+			sb.append(" LIMIT ");
+			sb.append(limit.intValue());
+		}
+		sb.append(" RETURN distinct i");
+		if (graphEdgesOptions.getIncludeData() != null && !graphEdgesOptions.getIncludeData().booleanValue()) {
+			sb.append(".id");
+		}
+
+		final String query = sb.toString();
+		return query;
+	}
+
+	private static void appendDepth(final GraphEdgesOptions graphEdgesOptions, final StringBuilder sb) {
+		final Integer minDepth = graphEdgesOptions.getMinDepth();
+		final Integer maxDepth = graphEdgesOptions.getMaxDepth();
+		if (minDepth != null || maxDepth != null) {
+			sb.append(minDepth != null ? minDepth : 1);
+			sb.append("..");
+			sb.append(maxDepth != null ? maxDepth : 1);
+			sb.append(" ");
+		}
+	}
+
+	private static void appendDirection(final GraphEdgesOptions graphEdgesOptions, final StringBuilder sb) {
+		final String direction = graphEdgesOptions.getDirection() != null ? graphEdgesOptions.getDirection().name()
+				: Direction.ANY.name();
+		sb.append(direction);
+	}
+
+	private static void appendFilter(final Object vertexExample, final StringBuilder sb) {
+		Gson gson = new Gson();
+		final JsonElement json = gson.toJsonTree(vertexExample);
+		if (json.isJsonObject()) {
+			sb.append(" FILTER ");
+			final JsonObject jsonObject = json.getAsJsonObject();
+			final Set<Entry<String, JsonElement>> entrySet = jsonObject.entrySet();
+			for (Entry<String, JsonElement> entry : entrySet) {
+				sb.append("start.`");
+				sb.append(entry.getKey());
+				sb.append("` == ");
+				sb.append(entry.getValue().toString());
+				sb.append(AND);
+			}
+			sb.delete(sb.length() - AND.length(), sb.length() - 1);
+		}
+	}
+
+	public static String createVerticesQuery(
+		final ArangoDriver driver,
+		final String graphName,
+		final Class<?> clazz,
+		final Object vertexExample,
+		final GraphVerticesOptions graphVerticesOptions,
+		final MapBuilder bindVars) throws ArangoException {
+		return null;
+	}
+
+	public static String createShortestPathQuery(
+		final ArangoDriver driver,
+		final String database,
+		final String graphName,
+		final Object startVertexExample,
+		final Object endVertexExample,
+		final ShortestPathOptions shortestPathOptions,
+		final Class<?> vertexClass,
+		final Class<?> edgeClass,
+		final MapBuilder bindVars) {
+		return null;
+	}
+}

src/test/java/com/arangodb/ArangoDriverGraphEdgesGetCursorTest.java

@@ -37,7 +37,7 @@
 import com.arangodb.entity.ShortestPathEntity;
 import com.arangodb.entity.marker.VertexEntity;
 import com.arangodb.util.AqlQueryOptions;
-import com.arangodb.util.MapBuilder;
+import com.arangodb.util.GraphEdgesOptions;
 import com.arangodb.util.ShortestPathOptions;
 
 /**
@@ -228,16 +228,16 @@ public void batchSizeAndLimitTest() throws ArangoException {
 		final Boolean count = true;
 		final Boolean fullCount = true;
 
-		final String query = "for i in graph_edges(@graphName, null, {includeData: true}) LIMIT 3 return i";
-		final Map<String, Object> bindVars = new MapBuilder().put("graphName", GRAPH_NAME).get();
+		GraphEdgesOptions graphEdgesOptions = new GraphEdgesOptions();
+		graphEdgesOptions.setLimit(3);
 
-		final EdgeCursor<TestComplexEntity02> cursor = driver.executeEdgeQuery(query, bindVars,
-			getAqlQueryOptions(count, batchSize, fullCount), TestComplexEntity02.class);
+		final EdgeCursor<TestComplexEntity02> cursor = driver.graphGetEdgeCursor(GRAPH_NAME, TestComplexEntity02.class,
+			null, graphEdgesOptions, getAqlQueryOptions(count, batchSize, fullCount));
 
 		assertEquals(3, cursor.getCount());
 		assertEquals(201, cursor.getCode());
 		assertTrue(cursor.hasMore());
-		assertEquals(4, cursor.getFullCount());
+		assertEquals(8, cursor.getFullCount());
 		assertTrue(cursor.getCursorId() > -1L);
 	}
 
@@ -270,36 +270,28 @@ public void edgesAqlTest() throws ArangoException {
 		final Boolean count = true;
 		final Boolean fullCount = true;
 
-		// get outbound vertices of vertex1 (the should be 2)
-		final String query = "for i in graph_edges(@graphName, @vertex, @options) return i";
-
-		// options bindVars
-		final Map<String, Object> options = new MapBuilder().put("direction", "outbound").put("includeData", true)
-				.get();
-
-		// bindVars
-		Map<String, Object> bindVars = new MapBuilder().put("graphName", GRAPH_NAME)
-				.put("vertex", vertex1.getDocumentHandle()).put("options", options).get();
-
-		EdgeCursor<TestComplexEntity02> cursor = driver.executeEdgeQuery(query, bindVars,
-			getAqlQueryOptions(count, batchSize, fullCount), TestComplexEntity02.class);
-
-		assertEquals(2, cursor.getCount());
-		assertEquals(201, cursor.getCode());
-		assertFalse(cursor.hasMore());
-		assertEquals(new Long(-1L), cursor.getCursorId());
-
-		// get outbound vertices of vertex2 (the should be no)
-		bindVars = new MapBuilder().put("graphName", GRAPH_NAME).put("vertex", vertex2.getDocumentHandle())
-				.put("options", options).get();
-
-		cursor = driver.executeEdgeQuery(query, bindVars, getAqlQueryOptions(count, batchSize, fullCount),
-			TestComplexEntity02.class);
-
-		assertEquals(0, cursor.getCount());
-		assertEquals(201, cursor.getCode());
-		assertFalse(cursor.hasMore());
-		assertEquals(new Long(-1L), cursor.getCursorId());
+		GraphEdgesOptions graphEdgesOptions = new GraphEdgesOptions();
+		graphEdgesOptions.setDirection(Direction.OUTBOUND);
+		graphEdgesOptions.setIncludeData(true);
+		{
+			EdgeCursor<TestComplexEntity02> cursor = driver.graphGetEdgeCursor(GRAPH_NAME, TestComplexEntity02.class,
+				vertex1.getDocumentHandle(), graphEdgesOptions, getAqlQueryOptions(count, batchSize, fullCount));
+
+			assertEquals(2, cursor.getCount());
+			assertEquals(201, cursor.getCode());
+			assertFalse(cursor.hasMore());
+			assertEquals(new Long(-1L), cursor.getCursorId());
+		}
+		{
+			// get outbound vertices of vertex2 (the should be no)
+			EdgeCursor<TestComplexEntity02> cursor = driver.graphGetEdgeCursor(GRAPH_NAME, TestComplexEntity02.class,
+				vertex2.getDocumentHandle(), graphEdgesOptions, getAqlQueryOptions(count, batchSize, fullCount));
+
+			assertEquals(0, cursor.getCount());
+			assertEquals(201, cursor.getCode());
+			assertFalse(cursor.hasMore());
+			assertEquals(new Long(-1L), cursor.getCursorId());
+		}
 
 	}