changed readme.md. Renamed classes & interfaces

Author: DvirDukhan

README.md

@@ -94,14 +94,14 @@ import java.util.List;
 public class RedisGraphExample {
     public static void main(String[] args) {
         // general context api. Not bound to graph key or connection
-        RedisGraphGeneralContext api = new RedisGraph();
+        RedisGraph graph = new RedisGraph();
 
         // send queries to a specific graph called "social"
-        api.query("social","CREATE (:person{name:'roi',age:32})");
-        api.query("social","CREATE (:person{name:%s,age:%d})", "amit", 30);
-        api.query("social","MATCH (a:person), (b:person) WHERE (a.name = 'roi' AND b.name='amit') CREATE (a)-[:knows]->(b)");
+        graph.query("social","CREATE (:person{name:'roi',age:32})");
+        graph.query("social","CREATE (:person{name:%s,age:%d})", "amit", 30);
+        graph.query("social","MATCH (a:person), (b:person) WHERE (a.name = 'roi' AND b.name='amit') CREATE (a)-[:knows]->(b)");
 
-        ResultSet resultSet = api.query("social", "MATCH (a:person)-[r:knows]->(b:person) RETURN a, r, b");
+        ResultSet resultSet = graph.query("social", "MATCH (a:person)-[r:knows]->(b:person) RETURN a, r, b");
         while(resultSet.hasNext()) {
             Record record = resultSet.next();
             // get values
@@ -113,16 +113,16 @@ public class RedisGraphExample {
         }
 
         // delete graph
-        api.deleteGraph("social");
+        graph.deleteGraph("social");
 
         // get connection context
-        RedisGraphContexted contextApi = api.getContextedAPI();
-        contextApi.query("contextSocial","CREATE (:person{name:'roi',age:32})");
-        contextApi.query("contextSocial","CREATE (:person{name:%s,age:%d})", "amit", 30);
-        contextApi.query("contextSocial", "MATCH (a:person), (b:person) WHERE (a.name = 'roi' AND b.name='amit') CREATE (a)-[:knows]->(b)");
+        RedisGraphContext context = graph.getContext();
+        context.query("contextSocial","CREATE (:person{name:'roi',age:32})");
+        context.query("contextSocial","CREATE (:person{name:%s,age:%d})", "amit", 30);
+        context.query("contextSocial", "MATCH (a:person), (b:person) WHERE (a.name = 'roi' AND b.name='amit') CREATE (a)-[:knows]->(b)");
         // WATCH/MULTI/EXEC
-        contextApi.watch("contextSocial");
-        RedisGraphTransaction t = contextApi.multi();
+        context.watch("contextSocial");
+        RedisGraphTransaction t = context.multi();
         t.query("contextSocial", "MATCH (a:person)-[r:knows]->(b:person) RETURN a, r, b");
         // support for Redis/Jedis native commands in transaction
         t.set("x", "1");
@@ -131,7 +131,7 @@ public class RedisGraphExample {
         List<Object> execResults =  t.exec();
         System.out.println(execResults.toString());
 
-        contextApi.deleteGraph("contextSocial");
+        context.deleteGraph("contextSocial");
     }
 }
 

src/main/java/com/redislabs/redisgraph/RedisGraphContexted.java renamed to src/main/java/com/redislabs/redisgraph/RedisGraphContext.java

@@ -2,7 +2,7 @@
 
 import redis.clients.jedis.Jedis;
 
-public interface RedisGraphContexted extends RedisGraph {
+public interface RedisGraphContext extends RedisGraph {
 
 
     /**

src/main/java/com/redislabs/redisgraph/RedisGraphGeneralContext.java renamed to src/main/java/com/redislabs/redisgraph/RedisGraphContextGenerator.java

@@ -1,11 +1,11 @@
 package com.redislabs.redisgraph;
 
-public interface RedisGraphGeneralContext extends RedisGraph {
+public interface RedisGraphContextGenerator extends RedisGraph {
 
     /**
      * Generate a connection bounded api
      * @return a connection bounded api
      */
-    RedisGraphContexted getContextedAPI();
+    RedisGraphContext getContext();
 
 }

src/main/java/com/redislabs/redisgraph/impl/api/ContextedRedisGraph.java

@@ -1,6 +1,6 @@
 package com.redislabs.redisgraph.impl.api;
 
-import com.redislabs.redisgraph.RedisGraphContexted;
+import com.redislabs.redisgraph.RedisGraphContext;
 import com.redislabs.redisgraph.ResultSet;
 import com.redislabs.redisgraph.impl.Utils;
 import com.redislabs.redisgraph.impl.graph_cache.RedisGraphCaches;
@@ -12,10 +12,10 @@
 import java.util.List;
 
 /**
- * An implementaion of RedisGraphContexted. Allows sending RedisGraph and some Redis commands,
+ * An implementaion of RedisGraphContext. Allows sending RedisGraph and some Redis commands,
  * within a specific connection context
  */
-public class ContextedRedisGraph extends AbstractRedisGraph implements RedisGraphContexted, RedisGraphCacheHolder {
+public class ContextedRedisGraph extends AbstractRedisGraph implements RedisGraphContext, RedisGraphCacheHolder {
 
     private Jedis connectionContext;
     private RedisGraphCaches caches;

src/main/java/com/redislabs/redisgraph/impl/api/RedisGraph.java

@@ -1,7 +1,7 @@
 package com.redislabs.redisgraph.impl.api;
 
-import com.redislabs.redisgraph.RedisGraphContexted;
-import com.redislabs.redisgraph.RedisGraphGeneralContext;
+import com.redislabs.redisgraph.RedisGraphContext;
+import com.redislabs.redisgraph.RedisGraphContextGenerator;
 import com.redislabs.redisgraph.ResultSet;
 import com.redislabs.redisgraph.impl.graph_cache.RedisGraphCaches;
 import redis.clients.jedis.Jedis;
@@ -12,7 +12,7 @@
 /**
  *
  */
-public class RedisGraph extends AbstractRedisGraph implements RedisGraphGeneralContext {
+public class RedisGraph extends AbstractRedisGraph implements RedisGraphContextGenerator {
 
     private final Pool<Jedis> client;
     private RedisGraphCaches caches = new RedisGraphCaches();
@@ -99,7 +99,7 @@ public String deleteGraph(String graphId) {
      * @return ContextedRedisGraph
      */
     @Override
-    public RedisGraphContexted getContextedAPI() {
+    public RedisGraphContext getContext() {
         ContextedRedisGraph contextedRedisGraph =  new ContextedRedisGraph(getConnection());
         contextedRedisGraph.setRedisGraphCaches(this.caches);
         return contextedRedisGraph;

src/test/java/com/redislabs/redisgraph/RedisGraphAPITest.java

@@ -23,7 +23,7 @@
 import static com.redislabs.redisgraph.Header.ResultSetColumnTypes.*;
 
 public class RedisGraphAPITest {
-    private RedisGraphGeneralContext api;
+    private RedisGraphContextGenerator api;
 
     public RedisGraphAPITest() {
     }
@@ -504,7 +504,7 @@ public void testEscapedQuery() {
 
     @Test
     public void testMultiExec(){
-        RedisGraphTransaction transaction = api.getContextedAPI().multi();
+        RedisGraphTransaction transaction = api.getContext().multi();
 
         transaction.set("x", "1");
         transaction.query("social", "CREATE (:Person {name:'a'})");
@@ -651,7 +651,7 @@ public void testContextedAPI(){
         expectedEdge.addProperty(falseBooleanProperty);
         expectedEdge.addProperty(nullProperty);
 
-        RedisGraphContexted c = api.getContextedAPI();
+        RedisGraphContext c = api.getContext();
 
         Assert.assertNotNull(c.query("social", "CREATE (:person{name:%s',age:%d, doubleValue:%f, boolValue:%b, nullValue:null})", name, age, doubleValue, boolValue));
         Assert.assertNotNull(c.query("social", "CREATE (:person{name:'amit',age:30})"));
@@ -719,8 +719,8 @@ public void testContextedAPI(){
     @Test
     public void testWriteTransactionWatch(){
 
-        RedisGraphContexted c1 = api.getContextedAPI();
-        RedisGraphContexted c2 = api.getContextedAPI();
+        RedisGraphContext c1 = api.getContext();
+        RedisGraphContext c2 = api.getContext();
 
         c1.watch("social");
         RedisGraphTransaction t1 = c1.multi();
@@ -747,8 +747,8 @@ public void testWriteTransactionWatch(){
     @Test
     public void testReadTransactionWatch(){
 
-        RedisGraphContexted c1 = api.getContextedAPI();
-        RedisGraphContexted c2 = api.getContextedAPI();
+        RedisGraphContext c1 = api.getContext();
+        RedisGraphContext c2 = api.getContext();
         Assert.assertNotEquals(c1.getConnectionContext(), c2.getConnectionContext());
         c1.query("social", "CREATE (:Person {name:'a'})");
         c1.watch("social");