added AQL query cache options

Author: a-brandt

src/main/java/com/arangodb/BaseCursorProxy.java

@@ -127,4 +127,17 @@ public Long getCursorId() {
 		return baseCursor.getEntity().getCursorId();
 	}
 
+	/**
+	 * a boolean flag indicating whether the query result was served from the
+	 * query cache or not. If the query result is served from the query cache,
+	 * the extra return attribute will not contain any stats sub-attribute and
+	 * no profile sub-attribute. (since ArangoDB 2.7)
+	 * 
+	 * @return true, if the result is cached
+	 * 
+	 */
+	public boolean isCached() {
+		return baseCursor.getEntity().isCached();
+	}
+
 }

src/main/java/com/arangodb/entity/CursorEntity.java

@@ -52,6 +52,14 @@ public class CursorEntity<T> extends BaseEntity implements Iterable<T> {
 	 */
 	long cursorId = -1;
 
+	/**
+	 * a boolean flag indicating whether the query result was served from the
+	 * query cache or not. If the query result is served from the query cache,
+	 * the extra return attribute will not contain any stats sub-attribute and
+	 * no profile sub-attribute. (since ArangoDB 2.7)
+	 */
+	boolean cached = false;
+
 	/**
 	 * A list of bind variables returned by the query
 	 */
@@ -188,4 +196,12 @@ public void setExtra(Map<String, Object> extra) {
 		this.extra = extra;
 	}
 
+	public boolean isCached() {
+		return cached;
+	}
+
+	public void setCached(boolean cached) {
+		this.cached = cached;
+	}
+
 }

src/main/java/com/arangodb/entity/EntityDeserializers.java

@@ -560,6 +560,10 @@ public CursorEntity<?> deserialize(JsonElement json, Type typeOfT, JsonDeseriali
 				entity.cursorId = obj.getAsJsonPrimitive("id").getAsLong();
 			}
 
+			if (obj.has("cached")) {
+				entity.cached = obj.getAsJsonPrimitive("cached").getAsBoolean();
+			}
+
 			if (obj.has("bindVars")) {
 				entity.bindVars = context.deserialize(obj.get("bindVars"), bindVarsType);
 			}

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

@@ -7,6 +7,7 @@ public class AqlQueryOptions implements OptionsInterface {
 	private Boolean count;
 	private Integer batchSize;
 	private Boolean fullCount;
+	private Boolean cache;
 	private Integer ttl;
 
 	/**
@@ -124,6 +125,33 @@ public AqlQueryOptions setTtl(Integer ttl) {
 		return this;
 	}
 
+	/**
+	 * flag to determine whether the AQL query cache shall be used. If set to
+	 * false, then any query cache lookup will be skipped for the query. If set
+	 * to true, it will lead to the query cache being checked for the query if
+	 * the query cache mode is either on or demand. (since ArangoDB 2.7)
+	 * 
+	 * @return boolean flag
+	 */
+	public Boolean getCache() {
+		return fullCount;
+	}
+
+	/**
+	 * flag to determine whether the AQL query cache shall be used. If set to
+	 * false, then any query cache lookup will be skipped for the query. If set
+	 * to true, it will lead to the query cache being checked for the query if
+	 * the query cache mode is either on or demand. (since ArangoDB 2.7)
+	 * 
+	 * @param cache
+	 *            boolean flag
+	 * @return this
+	 */
+	public AqlQueryOptions setCache(Boolean cache) {
+		this.cache = cache;
+		return this;
+	}
+
 	@Override
 	public Map<String, Object> toMap() {
 		MapBuilder mp = new MapBuilder();
@@ -136,6 +164,9 @@ public Map<String, Object> toMap() {
 		if (ttl != null) {
 			mp.put("ttl", ttl);
 		}
+		if (cache != null) {
+			mp.put("cache", cache);
+		}
 
 		MapBuilder optionsMp = new MapBuilder();
 

src/test/java/com/arangodb/ArangoDriverDocumentCursorTest.java

@@ -29,6 +29,7 @@
 import org.slf4j.LoggerFactory;
 
 import com.arangodb.entity.DocumentEntity;
+import com.arangodb.entity.QueryCachePropertiesEntity;
 import com.arangodb.util.AqlQueryOptions;
 import com.arangodb.util.MapBuilder;
 
@@ -151,6 +152,28 @@ public void test3_BatchSize5() throws ArangoException {
 
 	}
 
+	@Test
+	public void test_withCache() throws ArangoException {
+		if (isMinimumVersion(VERSION_2_7)) {
+			QueryCachePropertiesEntity properties = new QueryCachePropertiesEntity();
+			properties.setMode("on");
+			driver.setQueryCacheProperties(properties);
+
+			String query = "FOR t IN unit_test_query_test FILTER t.age >= @age SORT t.age RETURN t";
+			Map<String, Object> bindVars = new MapBuilder().put("age", 90).get();
+
+			AqlQueryOptions aqlQueryOptions = getAqlQueryOptions(true, 5, null);
+			aqlQueryOptions.setCache(true);
+
+			DocumentCursor<TestComplexEntity01> rs = driver.executeDocumentQuery(query, bindVars, aqlQueryOptions,
+				TestComplexEntity01.class);
+
+			rs = driver.executeDocumentQuery(query, bindVars, aqlQueryOptions, TestComplexEntity01.class);
+
+			assertThat(rs.isCached(), is(true));
+		}
+	}
+
 	@Test
 	public void test4_withIterator() throws ArangoException {