miscellaneous fixes (#13)

* use GraphFactory in demo

* improved ArangoDBEdge.stringify()

* throw if incident vertex is not found

* doc review

* fixed SimpleElementIdFactory for non-default collection names

* fixed ArangoDBEdge.stringify()

* java driver v7.22.0

Author: rashtao

README.md

@@ -329,8 +329,8 @@ gremlin:
 
 If `edgeDefinitions` are not configured, the default names will be used:
 
-- `<graphName>_vertex` will be used for the vertex collection
-- `<graphName>_edge` will be used for the edge collection
+- `vertex` will be used for the vertex collection
+- `edge` will be used for the edge collection
 
 Using a `SIMPLE` graph configured as in the example above and creating a new element like:
 
@@ -340,7 +340,8 @@ graph.addVertex("person", T.id, "foo");
 ```
 [//]: <> (@formatter:on)
 
-would result in creating a document in the vertex collection `myGraph_v` with `_id` equals to `myGraph_v/foo`.
+would result in creating a document in the vertex collection `myGraph_v` with `_key` equals to `foo` (and `_id` equals 
+to `myGraph_v/foo`).
 
 ### COMPLEX Graph Type
 
@@ -355,8 +356,7 @@ edge definitions. It has the following advantages:
 
 But on the other side has the following constraints:
 
-- Element IDs must have the format: `<graph>_<label>/<key>`, where:
-  - `<graph>` is the graph name
+- Element IDs must have the format: `<label>/<key>`, where:
   - `<label>` is the element label
   - `<key>` is the database document key
 - Only labels corresponding to graph collections can be used
@@ -385,7 +385,8 @@ graph.addVertex("person", T.id, "foo");
 ```
 [//]: <> (@formatter:on)
 
-would result in creating a document in the vertex collection `myGraph_person` with `_id` equals to `myGraph_person/foo`.
+would result in creating a document in the vertex collection `myGraph_person` with `_key` equals to `foo` (and `_id` 
+equals to `myGraph_person/foo`).
 
 ## Naming Constraints
 
@@ -396,7 +397,6 @@ When using the ArangoDB TinkerPop Provider, be aware of these naming constraints
   cannot be used in:
   - Graph name (`gremlin.arangodb.conf.graph.name`)
   - Labels
-  - Element IDs
 
 ## Persistent Structure
 
@@ -405,7 +405,7 @@ The ArangoDB TinkerPop Provider maps TinkerPop data structures to ArangoDB data
 ### Vertices
 
 Vertices are stored as documents in vertex collections. In a `SIMPLE` graph, all vertices are stored in a single
-collection named `<graphName>_vertex`. In a `COMPLEX` graph, vertices are stored in collections named
+collection, by default named `<graphName>_vertex`. In a `COMPLEX` graph, vertices are stored in collections named
 `<graphName>_<label>`.
 
 Each vertex document contains:
@@ -445,8 +445,8 @@ creates a document like this:
 
 ### Edges
 
-Edges are stored as documents in edge collections. In a `SIMPLE` graph, all edges are stored in a single collection
-named `<graphName>_edge`. In a `COMPLEX` graph, edges are stored in collections named `<graphName>_<label>`.
+Edges are stored as documents in edge collections. In a `SIMPLE` graph, all edges are stored in a single collection, by
+default named `<graphName>_edge`. In a `COMPLEX` graph, edges are stored in collections named `<graphName>_<label>`.
 
 Each edge document contains:
 

demo/README.md

@@ -56,7 +56,7 @@ Configuration conf = new ArangoDBConfigurationBuilder() (1)
         .database(DB_NAME)
         .enableDataDefinition(true)                     (3)
         .build();
-ArangoDBGraph graph = ArangoDBGraph.open(conf);         (4)
+ArangoDBGraph graph = (ArangoDBGraph) GraphFactory.open(conf);  (4)
 GraphTraversalSource g = graph.traversal();             (5)
 ```
 [//]: <> (@formatter:on)

demo/src/main/java/org/example/Main.java

@@ -23,6 +23,7 @@
 import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.__;
 import org.apache.tinkerpop.gremlin.structure.Edge;
 import org.apache.tinkerpop.gremlin.structure.Vertex;
+import org.apache.tinkerpop.gremlin.structure.util.GraphFactory;
 
 import java.util.List;
 import java.util.Map;
@@ -52,7 +53,7 @@ public static void main(String[] args) {
                 .db(DB_NAME)
                 .enableDataDefinition(true)
                 .build();
-        ArangoDBGraph graph = ArangoDBGraph.open(conf);
+        ArangoDBGraph graph = (ArangoDBGraph) GraphFactory.open(conf);
         GraphTraversalSource g = graph.traversal();
 
         // print supported features

pom.xml

@@ -29,7 +29,7 @@
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <arangodb-java-driver.version>7.22.0-SNAPSHOT</arangodb-java-driver.version>
+        <arangodb-java-driver.version>7.22.0</arangodb-java-driver.version>
         <test.graph.type>simple</test.graph.type>
         <sonar.host.url>https://sonarcloud.io</sonar.host.url>
         <sonar.organization>arangodb-1</sonar.organization>

src/main/java/com/arangodb/tinkerpop/gremlin/persistence/ElementIdFactory.java

@@ -30,24 +30,28 @@
 
 
 public abstract class ElementIdFactory {
-    protected final String prefix;
+    protected final ArangoDBGraphConfig config;
 
     public static ElementIdFactory create(ArangoDBGraphConfig config) {
         switch (config.graphType) {
             case SIMPLE:
-                return new SimpleElementIdFactory(config.graphName);
+                return new SimpleElementIdFactory(config);
             case COMPLEX:
-                return new ComplexElementIdFactory(config.graphName);
+                return new ComplexElementIdFactory(config);
             default:
                 throw new IllegalArgumentException("Unsupported graph type: " + config.graphType);
         }
     }
 
-    protected ElementIdFactory(String prefix) {
-        this.prefix = prefix;
+    protected ElementIdFactory(ArangoDBGraphConfig config) {
+        this.config = config;
     }
 
-    protected abstract String inferCollection(final String collection, final String label, final String defaultLabel);
+    protected abstract String defaultVertexCollection();
+
+    protected abstract String defaultEdgeCollection();
+
+    protected abstract String inferCollection(final String collection, final String label, final String defaultCollection);
 
     protected abstract void validateId(String id);
 
@@ -59,24 +63,24 @@ private String extractKey(final String id) {
     }
 
     private String extractCollection(final String id) {
-        String[] parts = id.replaceFirst("^" + prefix + "_", "").split("/");
+        String[] parts = id.replaceFirst("^" + config.prefix, "").split("/");
         if (parts.length > 2) {
             throw new IllegalArgumentException(String.format("key (%s) contains invalid character '/'", id));
         }
         return parts.length == 2 ? parts[0] : null;
     }
 
     public ElementId createVertexId(String label, Object id) {
-        return createId(label, Vertex.DEFAULT_LABEL, id);
+        return createId(label, id, defaultVertexCollection());
     }
 
     public ElementId createEdgeId(String label, Object id) {
-        return createId(label, Edge.DEFAULT_LABEL, id);
+        return createId(label, id, defaultEdgeCollection());
     }
 
     public ElementId parseVertexId(Object id) {
         if (id instanceof String) {
-            return parseWithDefaultLabel((String) id, Vertex.DEFAULT_LABEL);
+            return parseWithDefaultCollection((String) id, defaultVertexCollection());
         } else if (id instanceof Element) {
             return parseVertexId(((Element) id).id());
         } else {
@@ -92,7 +96,7 @@ public List<ElementId> parseVertexIds(Object[] ids) {
 
     public ElementId parseEdgeId(Object id) {
         if (id instanceof String) {
-            return parseWithDefaultLabel((String) id, Edge.DEFAULT_LABEL);
+            return parseWithDefaultCollection((String) id, defaultEdgeCollection());
         } else if (id instanceof Element) {
             return parseEdgeId(((Element) id).id());
         } else {
@@ -109,18 +113,18 @@ public List<ElementId> parseEdgeIds(Object[] ids) {
     public ElementId parseId(String id) {
         String collection = extractCollection(id);
         String key = extractKey(id);
-        return of(prefix, collection, key);
+        return of(config.graphName, collection, key);
     }
 
-    private ElementId parseWithDefaultLabel(String id, String defaultLabel) {
-        String collection = inferCollection(extractCollection(id), null, defaultLabel);
+    private ElementId parseWithDefaultCollection(String id, String defaultCollection) {
+        String collection = inferCollection(extractCollection(id), null, defaultCollection);
         String key = extractKey(id);
-        return of(prefix, collection, key);
+        return of(config.graphName, collection, key);
     }
 
-    private ElementId createId(String label, String defaultLabel, Object nullableId) {
+    private ElementId createId(String label, Object nullableId, String defaultCollection) {
         if (nullableId == null) {
-            return of(prefix, inferCollection(null, label, defaultLabel), null);
+            return of(config.graphName, inferCollection(null, label, defaultCollection), null);
         }
 
         if (!(nullableId instanceof String)) {
@@ -129,13 +133,13 @@ private ElementId createId(String label, String defaultLabel, Object nullableId)
 
         String id = (String) nullableId;
         validateId(id);
-        return of(prefix, inferCollection(extractCollection(id), label, defaultLabel), extractKey(id));
+        return of(config.graphName, inferCollection(extractCollection(id), label, defaultCollection), extractKey(id));
     }
 
-    private ElementId of(String prefix, String collection, String key) {
-        Objects.requireNonNull(prefix);
+    private ElementId of(String graphName, String collection, String key) {
+        Objects.requireNonNull(graphName);
         Objects.requireNonNull(collection);
-        ElementId.validateIdParts(prefix, collection, key);
-        return doCreate(prefix, collection, key);
+        ElementId.validateIdParts(graphName, collection, key);
+        return doCreate(graphName, collection, key);
     }
 }

src/main/java/com/arangodb/tinkerpop/gremlin/persistence/complex/ComplexElementIdFactory.java

@@ -18,16 +18,29 @@
 
 import com.arangodb.tinkerpop.gremlin.persistence.ElementId;
 import com.arangodb.tinkerpop.gremlin.persistence.ElementIdFactory;
+import com.arangodb.tinkerpop.gremlin.structure.ArangoDBGraphConfig;
+import org.apache.tinkerpop.gremlin.structure.Edge;
+import org.apache.tinkerpop.gremlin.structure.Vertex;
 
 
 public class ComplexElementIdFactory extends ElementIdFactory {
 
-    public ComplexElementIdFactory(String prefix) {
-        super(prefix);
+    public ComplexElementIdFactory(ArangoDBGraphConfig config) {
+        super(config);
     }
 
     @Override
-    protected String inferCollection(final String collection, final String label, final String defaultLabel) {
+    protected String defaultVertexCollection() {
+        return Vertex.DEFAULT_LABEL;
+    }
+
+    @Override
+    protected String defaultEdgeCollection() {
+        return Edge.DEFAULT_LABEL;
+    }
+
+    @Override
+    protected String inferCollection(final String collection, final String label, final String defaultCollection) {
         if (collection != null) {
             if (label != null && !label.equals(collection)) {
                 throw new IllegalArgumentException("Mismatching label: [" + label + "] and collection: [" + collection + "]");
@@ -37,12 +50,12 @@ protected String inferCollection(final String collection, final String label, fi
         if (label != null) {
             return label;
         }
-        return defaultLabel;
+        return defaultCollection;
     }
 
     @Override
     protected void validateId(String id) {
-        if (id.replaceFirst("^" + prefix + "_", "").contains("_")) {
+        if (id.replaceFirst("^" + config.prefix, "").contains("_")) {
             throw new IllegalArgumentException(String.format("id (%s) contains invalid character '_'", id));
         }
     }

src/main/java/com/arangodb/tinkerpop/gremlin/persistence/simple/SimpleElementIdFactory.java

@@ -18,17 +18,35 @@
 
 import com.arangodb.tinkerpop.gremlin.persistence.ElementId;
 import com.arangodb.tinkerpop.gremlin.persistence.ElementIdFactory;
+import com.arangodb.tinkerpop.gremlin.structure.ArangoDBGraphConfig;
 
 
 public class SimpleElementIdFactory extends ElementIdFactory {
 
-    public SimpleElementIdFactory(String prefix) {
-        super(prefix);
+    private final String defaultVertexCollection;
+    private final String defaultEdgeCollection;
+
+    public SimpleElementIdFactory(ArangoDBGraphConfig config) {
+        super(config);
+        defaultVertexCollection = config.vertices.iterator().next()
+                .replaceFirst(config.prefix, "");
+        defaultEdgeCollection = config.edges.iterator().next()
+                .replaceFirst(config.prefix, "");
+    }
+
+    @Override
+    protected String defaultVertexCollection() {
+        return defaultVertexCollection;
+    }
+
+    @Override
+    protected String defaultEdgeCollection() {
+        return defaultEdgeCollection;
     }
 
     @Override
-    protected String inferCollection(final String collection, final String label, final String defaultLabel) {
-        return defaultLabel;
+    protected String inferCollection(final String collection, final String label, final String defaultCollection) {
+        return defaultCollection;
     }
 
     @Override

src/main/java/com/arangodb/tinkerpop/gremlin/structure/ArangoDBEdge.java

@@ -18,8 +18,8 @@
 
 import com.arangodb.tinkerpop.gremlin.persistence.EdgeData;
 import com.arangodb.tinkerpop.gremlin.persistence.ElementId;
+import com.arangodb.tinkerpop.gremlin.persistence.VertexData;
 import org.apache.tinkerpop.gremlin.structure.*;
-import org.apache.tinkerpop.gremlin.structure.util.StringFactory;
 import org.apache.tinkerpop.gremlin.util.iterator.IteratorUtils;
 
 import java.util.*;
@@ -53,17 +53,26 @@ public void doInsert() {
 
     @Override
     protected String stringify() {
-        return StringFactory.edgeString(this);
+        return "e[" + id() + "][" + data.getFrom().getId() + "-" + label() + "->" + data.getTo().getId() + "]";
     }
 
     @Override
     public Vertex outVertex() {
-        return new ArangoDBVertex(graph, graph.getClient().readVertex(data.getFrom()));
+        return vertex(data.getFrom());
     }
 
     @Override
     public Vertex inVertex() {
-        return new ArangoDBVertex(graph, graph.getClient().readVertex(data.getTo()));
+        return vertex(data.getTo());
+    }
+
+    private Vertex vertex(ElementId eId) {
+        if (removed()) throw ArangoDBElement.Exceptions.elementAlreadyRemoved(id());
+        VertexData v = graph.getClient().readVertex(eId);
+        if (v == null) {
+            throw ArangoDBElement.Exceptions.elementAlreadyRemoved(eId.getId());
+        }
+        return new ArangoDBVertex(graph, v);
     }
 
     @Override

src/main/java/com/arangodb/tinkerpop/gremlin/structure/ArangoDBElement.java

@@ -33,6 +33,8 @@ public abstract class ArangoDBElement<P, D extends PropertiesContainer<P>> imple
     private boolean removed = false;
 
     ArangoDBElement(ArangoDBGraph graph, D data) {
+        Objects.requireNonNull(graph);
+        Objects.requireNonNull(data);
         this.graph = graph;
         this.data = data;
     }