Documentation updates

Author: a-brandt

pom.xml

@@ -29,12 +29,12 @@
   	<dependency>
   		<groupId>org.codehaus.jettison</groupId>
   		<artifactId>jettison</artifactId>
-  		<version>1.3.3</version>
+  		<version>1.3.5</version>
   	</dependency>
   	<dependency>
   		<groupId>log4j</groupId>
   		<artifactId>log4j</artifactId>
-  		<version>1.2.16</version>
+  		<version>1.2.17</version>
   	</dependency>
   	<dependency>
   		<groupId>junit</groupId>
@@ -50,12 +50,12 @@
     <dependency>
     	<groupId>com.google.guava</groupId>
     	<artifactId>guava</artifactId>
-    	<version>16.0.1</version>
+    	<version>17.0</version>
     </dependency>
     <dependency>
     	<groupId>org.apache.commons</groupId>
     	<artifactId>commons-lang3</artifactId>
-    	<version>3.2.1</version>
+    	<version>3.3.2</version>
     </dependency>
   </dependencies>
     <build>

src/main/java/com/tinkerpop/blueprints/impls/arangodb/ArangoDBEdge.java

@@ -8,152 +8,153 @@
 
 package com.tinkerpop.blueprints.impls.arangodb;
 
-import com.tinkerpop.blueprints.impls.arangodb.client.*;
-
 import com.tinkerpop.blueprints.Direction;
 import com.tinkerpop.blueprints.Edge;
 import com.tinkerpop.blueprints.Vertex;
+import com.tinkerpop.blueprints.impls.arangodb.client.ArangoDBException;
+import com.tinkerpop.blueprints.impls.arangodb.client.ArangoDBSimpleEdge;
 import com.tinkerpop.blueprints.util.ExceptionFactory;
 import com.tinkerpop.blueprints.util.StringFactory;
 
 /**
+ * The arangodb edge class
+ * 
  * @author Achim Brandt (http://www.triagens.de)
  * @author Johannes Gocke (http://www.triagens.de)
+ * @author Guido Schwab (http://www.triagens.de)
  */
 
-public class ArangoDBEdge extends ArangoDBElement implements Edge
-{
+public class ArangoDBEdge extends ArangoDBElement implements Edge {
 	/**
-	 * the _from vertex 
+	 * the _from vertex
 	 */
 	private Vertex outVertex = null;
-	
+
 	/**
-	 * the _to vertex 
+	 * the _to vertex
 	 */
 	private Vertex inVertex = null;
-	
-	static ArangoDBEdge create (ArangoDBGraph graph, Object id, Vertex outVertex, Vertex inVertex, String label) {
-		String key = (id != null) ? id.toString() : null; 
-		
+
+	static ArangoDBEdge create(ArangoDBGraph graph, Object id, Vertex outVertex, Vertex inVertex, String label) {
+		String key = (id != null) ? id.toString() : null;
+
 		if (outVertex instanceof ArangoDBVertex && inVertex instanceof ArangoDBVertex) {
 			ArangoDBVertex from = (ArangoDBVertex) outVertex;
 			ArangoDBVertex to = (ArangoDBVertex) inVertex;
-			
+
 			try {
-				ArangoDBSimpleEdge v = graph.client.createEdge(graph.getRawGraph(), key, label, from.getRawVertex(), to.getRawVertex(), null);
+				ArangoDBSimpleEdge v = graph.client.createEdge(graph.getRawGraph(), key, label, from.getRawVertex(),
+						to.getRawVertex(), null);
 				return build(graph, v, outVertex, inVertex);
 			} catch (ArangoDBException e) {
 				if (e.errorNumber() == 1210) {
 					throw ExceptionFactory.vertexWithIdAlreadyExists(id);
 				}
 				throw new IllegalArgumentException(e.getMessage());
-			}								
+			}
 		}
 		throw new IllegalArgumentException("Wrong vertex class.");
-		
+
 	}
-    
-	static ArangoDBEdge load (ArangoDBGraph graph, Object id) {
+
+	static ArangoDBEdge load(ArangoDBGraph graph, Object id) {
 		if (id == null) {
 			throw ExceptionFactory.edgeIdCanNotBeNull();
 		}
-		
-		String key = id.toString(); 
+
+		String key = id.toString();
 
 		ArangoDBEdge edge = graph.edgeCache.get(key);
 		if (edge != null) {
 			return edge;
 		}
-		
+
 		try {
 			ArangoDBSimpleEdge v = graph.client.getEdge(graph.getRawGraph(), key);
-			return build(graph, v,  null ,null);			
+			return build(graph, v, null, null);
 		} catch (ArangoDBException e) {
 			// do nothing
 			return null;
-		}		
+		}
 	}
-	
-	static ArangoDBEdge build (ArangoDBGraph graph, ArangoDBSimpleEdge simpleEdge, Vertex outVertex, Vertex inVertex) {
+
+	static ArangoDBEdge build(ArangoDBGraph graph, ArangoDBSimpleEdge simpleEdge, Vertex outVertex, Vertex inVertex) {
 		String id = simpleEdge.getDocumentKey();
-		
+
 		ArangoDBEdge vert = graph.edgeCache.get(id);
 		if (vert != null) {
 			vert.setDocument(simpleEdge);
 			return vert;
 		}
-		
+
 		ArangoDBEdge newEdge = new ArangoDBEdge(graph, simpleEdge, outVertex, inVertex);
 		graph.edgeCache.put(newEdge.getRaw().getDocumentKey(), newEdge);
-		return newEdge;							
+		return newEdge;
 	}
 
 	private ArangoDBEdge(ArangoDBGraph graph, ArangoDBSimpleEdge edge, Vertex outVertex, Vertex inVertex) {
 		this.graph = graph;
 		this.document = edge;
 		this.outVertex = outVertex;
-		this.inVertex= inVertex;
+		this.inVertex = inVertex;
 	}
-	
-	public Vertex getVertex(Direction direction) throws IllegalArgumentException 
-	{
-        if (direction.equals(Direction.IN))
-        {
-        	if (inVertex == null) {
-            	Object id = document.getProperty(ArangoDBSimpleEdge._TO);
-            	inVertex = graph.getVertex(getKey(id));
-        	}        	
-    		return inVertex;
-        }
-        else if (direction.equals(Direction.OUT))
-        {
-        	if (outVertex == null) {
-            	Object id = document.getProperty(ArangoDBSimpleEdge._FROM);
-            	outVertex = graph.getVertex(getKey(id));        		
-        	}
-        	return outVertex;
-        }
-        else
-        {
-        	throw ExceptionFactory.bothIsNotSupported();
-        }
+
+	public Vertex getVertex(Direction direction) throws IllegalArgumentException {
+		if (direction.equals(Direction.IN)) {
+			if (inVertex == null) {
+				Object id = document.getProperty(ArangoDBSimpleEdge._TO);
+				inVertex = graph.getVertex(getKey(id));
+			}
+			return inVertex;
+		} else if (direction.equals(Direction.OUT)) {
+			if (outVertex == null) {
+				Object id = document.getProperty(ArangoDBSimpleEdge._FROM);
+				outVertex = graph.getVertex(getKey(id));
+			}
+			return outVertex;
+		} else {
+			throw ExceptionFactory.bothIsNotSupported();
+		}
 	}
-	
-	private String getKey (Object id) {
-		if (id == null) {			
+
+	private String getKey(Object id) {
+		if (id == null) {
 			return "";
 		}
-		
+
 		String[] parts = id.toString().split("/");
-		
+
 		if (parts.length > 1) {
 			return parts[1];
 		}
-		
+
 		return parts[0];
 	}
 
-	public String getLabel() 
-	{
+	public String getLabel() {
 		Object l = document.getProperty(ArangoDBSimpleEdge._LABEL);
 		if (l != null) {
 			return l.toString();
 		}
-		
+
 		return null;
 	}
-	
-	public ArangoDBSimpleEdge getRawEdge () {
+
+	/**
+	 * Returns the arangodb raw edge
+	 * 
+	 * @return a ArangoDBSimpleEdge
+	 */
+	public ArangoDBSimpleEdge getRawEdge() {
 		return (ArangoDBSimpleEdge) document;
 	}
-	
+
 	@Override
-    public String toString() {
-        return StringFactory.edgeString(this);
-    }
-    
-	public void remove () {
+	public String toString() {
+		return StringFactory.edgeString(this);
+	}
+
+	public void remove() {
 		if (document.isDeleted()) {
 			return;
 		}
@@ -165,12 +166,12 @@ public void remove () {
 		}
 		graph.edgeCache.remove(key);
 	}
-    
-	public void save () throws ArangoDBException {
+
+	public void save() throws ArangoDBException {
 		if (document.isDeleted()) {
 			return;
 		}
 		graph.client.saveEdge(graph.getRawGraph(), (ArangoDBSimpleEdge) document);
 	}
-	
+
 }