Added batch loading of objects (#7)

Added batch loading of objects which allows all sub-objects to be loaded
in parallel.

Author: tfaulkes

README.md

@@ -1910,4 +1910,3 @@ Note: At the moment not all CDT operations are supported, and if the underlying
 - handle object graph circularities (A->B->C). Be careful of: A->B(Lazy), A->C->B: B should end up fully hydrated in both instances, not lazy in both instances
 - Consider the items on virtual list which return a list to be able to return a map as well (ELEMENT_LIST, ELEMENT_MAP) 
 - Test a constructor which requires a sub-object. For example, Account has a Property, Property has an Address. All 3 a referenced objects. Constructor for Property requires Address
-- Create a batch get method which loads sub-objects in parallel

src/main/java/com/aerospike/mapper/annotations/AerospikeEmbed.java

@@ -6,7 +6,7 @@
 import java.lang.annotation.Target;
 
 /**
- * Bins marked with AerospikeExclude will not be mapped to the database, irrespective of other annotations.
+ * Bins marked with AerospikeEmbed will have the objects they reference embedded in the parent object, either as a list or a map
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.FIELD)

src/main/java/com/aerospike/mapper/tools/AeroMapper.java

@@ -2,6 +2,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.lang.reflect.Array;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -248,7 +249,6 @@ public <T> T translateFromAerospike(@NotNull Object obj, @NotNull Class<T> expec
 		return result;
     }
 
-
     /**
      * Save each object in the database. This method will perform a REPLACE on the existing record so any existing
      * data will be overwritten by the data in the passed object. This is a convenience method for
@@ -339,6 +339,13 @@ public <T> T read(Policy readPolicy, @NotNull Class<T> clazz, @NotNull Object us
         return read(readPolicy, clazz, key, entry, resolveDependencies);
     }
 
+    /**
+     * Read a record from the repository and map it to an instance of the passed class.
+     * @param clazz - The type of be returned.
+     * @param userKey - The key of the record. The namespace and set will be derived from the values specified on the passed class.
+     * @return The returned mapped record.
+     * @throws AerospikeException an AerospikeException will be thrown in case of an error.
+     */
     public <T> T read(@NotNull Class<T> clazz, @NotNull Object userKey) throws AerospikeException {
     	return this.read(clazz, userKey, true);
     }
@@ -364,7 +371,7 @@ private <T> T read(Policy readPolicy, @NotNull Class<T> clazz, @NotNull Key key,
         } else {
             try {
             	ThreadLocalKeySaver.save(key);
-                T result = (T) convertToObject(clazz, record, entry, resolveDepenencies);
+                T result = convertToObject(clazz, record, entry, resolveDepenencies);
                 return result;
             } catch (ReflectiveOperationException e) {
                 throw new AerospikeException(e);
@@ -375,7 +382,68 @@ private <T> T read(Policy readPolicy, @NotNull Class<T> clazz, @NotNull Key key,
         }
     }
 
-    
+    /**
+     * Read a batch of records from the repository and map them to an instance of the passed class.
+     * @param clazz - The type of be returned.
+     * @param userKeys - The keys of the record. The namespace and set will be derived from the values specified on the passed class.
+     * @return The returned mapped records.
+     * @throws AerospikeException an AerospikeException will be thrown in case of an error.
+     */
+    public <T> T[] read(@NotNull Class<T> clazz, @NotNull Object ... userKeys) throws AerospikeException {
+    	return this.read(null, clazz, userKeys);
+    }
+
+    /**
+     * Read a batch of records from the repository and map them to an instance of the passed class.
+     * @param batchPolicy A given batch policy.
+     * @param clazz - The type of be returned.
+     * @param userKeys - The keys of the record. The namespace and set will be derived from the values specified on the passed class.
+     * @return The returned mapped records.
+     * @throws AerospikeException an AerospikeException will be thrown in case of an error.
+     */
+    public <T> T[] read(BatchPolicy batchPolicy, @NotNull Class<T> clazz, @NotNull Object ... userKeys) throws AerospikeException {
+        ClassCacheEntry<T> entry = getEntryAndValidateNamespace(clazz);
+        String set = entry.getSetName();
+        Key[] keys = new Key[userKeys.length];
+        for (int i = 0; i < userKeys.length; i++) {
+        	if (userKeys[i] == null) {
+        		throw new AerospikeException("Cannot pass null to object " + i + " in multi-read call");
+        	}
+        	else {
+        		keys[i] = new Key(entry.getNamespace(), set, Value.get(entry.translateKeyToAerospikeKey(userKeys[i])));
+        	}
+        }
+        		
+    	return this.readBatch(batchPolicy, clazz, keys, entry);
+    }
+
+    private <T> T[] readBatch(BatchPolicy batchPolicy, @NotNull Class<T> clazz, @NotNull Key[] keys, @NotNull ClassCacheEntry<T> entry) {
+    	if (batchPolicy == null) {
+    		batchPolicy = entry.getBatchPolicy();
+    	}
+        Record[] records = mClient.get(batchPolicy, keys);
+        T[] results = (T[])Array.newInstance(clazz, records.length);
+        for (int i = 0; i < records.length; i++) {
+        	if (records[i] == null) {
+        		results[i] = null;
+        	}
+        	else {
+                try {
+                	ThreadLocalKeySaver.save(keys[i]);
+                    T result = convertToObject(clazz, records[i], entry, false);
+                    results[i] = result;
+                } catch (ReflectiveOperationException e) {
+                    throw new AerospikeException(e);
+                }
+                finally {
+                	ThreadLocalKeySaver.clear();
+                }
+        	}
+        }
+        resolveDependencies(entry);
+        return results;
+    }
+
     public <T> boolean delete(@NotNull Class<T> clazz, @NotNull Object userKey) throws AerospikeException {
     	return this.delete(null, clazz, userKey);
     }

src/test/java/com/aerospike/mapper/AeroMapperBaseTest.java

@@ -35,13 +35,22 @@ public void clearCache() {
 		ClassCache.getInstance().clear();
 
     }
-    
+
     public void compare(Object original, Object read) {
+    	this.compare(original, read, false);
+    }
+
+    public void compare(Object original, Object read, boolean showObjects) {
     	try {
 			ObjectWriter objectWriter = new ObjectMapper().writerWithDefaultPrettyPrinter();
 			String readString = objectWriter.writeValueAsString(read);
-			System.out.println(readString);
+			if (showObjects) {
+				System.out.println("------ Read Data -----\n" + readString);
+			}
 			String originalObject = objectWriter.writeValueAsString(original);
+			if (showObjects) {
+				System.out.println("------ Original Data -----\n" + originalObject);
+			}
 			assertEquals(originalObject, readString);
     	} catch (JsonProcessingException jpe) {
     		throw new RuntimeException(jpe);

src/test/java/com/aerospike/mapper/BatchLoadTest.java

@@ -3,24 +3,81 @@
 import com.aerospike.mapper.annotations.AerospikeKey;
 import com.aerospike.mapper.annotations.AerospikeRecord;
 import com.aerospike.mapper.annotations.ParamFrom;
+import com.aerospike.mapper.tools.AeroMapper;
+import org.junit.Test;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
 
 public class BatchLoadTest extends AeroMapperBaseTest {
-	@AerospikeRecord(namespace = "test", set = "C")
-	public static class C {
+
+	@AerospikeRecord(namespace = "test", set = "B")
+	public static class B {
 		@AerospikeKey
 		public int id;
 		public String name;
 
-		public C(@ParamFrom("id") int id, @ParamFrom("name") String name) {
-			super();
+		public B(@ParamFrom("id") int id, @ParamFrom("name") String name) {
 			this.id = id;
 			this.name = name;
 		}
 	}
-	
-	@AerospikeRecord(namespace = "test", set = "B")
-	public static class B {
+
+	@AerospikeRecord(namespace = "test", set = "A")
+	public static class A {
 		@AerospikeKey
 		public int id;
+		public String name;
+		public List<B> data;
+
+		public A(int id, String name) {
+			this.id = id;
+			this.name = name;
+			data = new ArrayList<>();
+		}
+
+		public void setBList(List<B> bees) {
+			data = bees;
+		}
+		
+		public A() {}
+	}
+
+	@Test
+	public void testBatchLoad() {
+		AeroMapper mapper = new AeroMapper.Builder(client).build();
+
+		B[] bees = new B[100];
+		for (int i = 0; i < 100; i++) {
+			bees[i] = new B(i, "B-" + i);
+		}
+
+		A[] as = new A[10];
+		for (int i = 0; i < 10; i++) {
+			as[i] = new A(100 + i, "A-" + i);
+			as[i].setBList(Arrays.asList(
+					Arrays.copyOfRange(bees, i * 10, (i + 1) * 10)));
+		}
+
+		mapper.save((Object[])bees);
+		mapper.save((Object[])as);
+
+		System.out.println("--- Reading single object (bees[1]) ---");
+		B resultB = mapper.read(B.class, bees[1].id);
+		compare(bees[1], resultB);
+
+		System.out.println("--- Reading single object (a[1]) ---");
+		A resultA = mapper.read(A.class, as[1].id);
+		compare(as[1], resultA);
+
+		System.out.println("--- Reading batch object with 6 keys ---");
+		A[] results = mapper.read(A.class, as[4].id, as[7].id, as[5].id, as[0].id, as[1].id, 3000);
+		compare(results[0], as[4]);
+		compare(results[1], as[7]);
+		compare(results[2], as[5]);
+		compare(results[3], as[0]);
+		compare(results[4], as[1]);
+		compare(results[5], null);
 	}
 }