added warning messages to cursor result

Author: a-brandt

src/main/java/com/arangodb/CursorResult.java

@@ -22,6 +22,7 @@
 import java.util.NoSuchElementException;
 
 import com.arangodb.entity.CursorEntity;
+import com.arangodb.entity.WarningEntity;
 
 /**
  * @author tamtam180 - kirscheless at gmail.com
@@ -174,4 +175,22 @@ public void remove() {
 
 	}
 
+	/**
+	 * Returns true, if there are AQL warnings
+	 * 
+	 * @return true, if there are AQL warnings
+	 */
+	public boolean hasWarning() {
+		return entity.hasWarnings();
+	}
+
+	/**
+	 * Returns a list of AQL warnings (code and message)
+	 * 
+	 * @return list of AQL warnings
+	 */
+	public List<WarningEntity> getWarnings() {
+		return entity.getWarnings();
+	}
+
 }

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

@@ -75,6 +75,11 @@ public class CursorEntity<T> extends BaseEntity implements Iterable<T> {
 	 */
 	List<? extends T> results;
 
+	/**
+	 * A list of warnings
+	 */
+	List<WarningEntity> warnings;
+
 	@SuppressWarnings("unchecked")
 	@Override
 	public Iterator<T> iterator() {
@@ -204,4 +209,15 @@ public void setCached(boolean cached) {
 		this.cached = cached;
 	}
 
+	public List<WarningEntity> getWarnings() {
+		return warnings;
+	}
+
+	public void setWarnings(List<WarningEntity> warnings) {
+		this.warnings = warnings;
+	}
+
+	public boolean hasWarnings() {
+		return CollectionUtils.isNotEmpty(this.warnings);
+	}
 }

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

@@ -568,6 +568,7 @@ public CursorEntity<?> deserialize(JsonElement json, Type typeOfT, JsonDeseriali
 				entity.bindVars = context.deserialize(obj.get("bindVars"), bindVarsType);
 			}
 
+			entity.warnings = new ArrayList<WarningEntity>();
 			if (obj.has("extra")) {
 				entity.extra = context.deserialize(obj.get("extra"), extraType);
 
@@ -585,6 +586,24 @@ public CursorEntity<?> deserialize(JsonElement json, Type typeOfT, JsonDeseriali
 						}
 					}
 				}
+				if (entity.extra.containsKey("warnings")) {
+					Object object = entity.extra.get("warnings");
+					if (object instanceof List<?>) {
+						List<?> l = (List<?>) entity.extra.get("warnings");
+						for (Object o : l) {
+							if (o instanceof Map<?, ?>) {
+								Map<?, ?> m = (Map<?, ?>) o;
+								if (m.containsKey("code") && m.get("code") instanceof Double && m.containsKey("message")
+										&& m.get("message") instanceof String) {
+									Long code = ((Double) m.get("code")).longValue();
+									String message = (String) m.get("message");
+									entity.warnings.add(new WarningEntity(code, message));
+								}
+							}
+						}
+					}
+				}
+
 			}
 
 			return entity;

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

@@ -0,0 +1,73 @@
+/*
+ * Copyright (C) 2012,2013 tamtam180
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.arangodb.entity;
+
+/**
+ * @author a-brandt
+ */
+public class WarningEntity {
+
+	/**
+	 * a warning code
+	 */
+	Long code;
+
+	/**
+	 * a warning message
+	 */
+	String message;
+
+	public WarningEntity() {
+	}
+
+	public WarningEntity(Long code, String message) {
+		this.code = code;
+		this.message = message;
+	}
+
+	/**
+	 * returns the warning code
+	 * 
+	 * @return a warning code
+	 */
+	public Long getCode() {
+		return code;
+	}
+
+	public void setCode(Long code) {
+		this.code = code;
+	}
+
+	/**
+	 * returns a warning message
+	 * 
+	 * @return a warning message
+	 */
+	public String getMessage() {
+		return message;
+	}
+
+	public void setMessage(String message) {
+		this.message = message;
+	}
+
+	@Override
+	public String toString() {
+		return "WarningEntity [code=" + code + ", message=" + message + "]";
+	}
+
+}

src/test/java/com/arangodb/ArangoDriverCursorTest.java

@@ -22,12 +22,15 @@
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertThat;
 
+import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 import org.junit.Ignore;
 import org.junit.Test;
 
 import com.arangodb.entity.CursorEntity;
+import com.arangodb.entity.WarningEntity;
 import com.arangodb.util.MapBuilder;
 
 /**
@@ -44,8 +47,9 @@ public ArangoDriverCursorTest(ArangoConfigure configure, ArangoDriver driver) {
 	public void test_validateQuery() throws ArangoException {
 
 		CursorEntity<?> entity = driver.validateQuery(
-		// "SELECT t FROM unit_test_cursor t WHERE t.name == @name@ && t.age >= @age@"
-				"FOR t IN unit_test_cursor FILTER t.name == @name && t.age >= @age RETURN t");
+			// "SELECT t FROM unit_test_cursor t WHERE t.name == @name@ && t.age
+			// >= @age@"
+			"FOR t IN unit_test_cursor FILTER t.name == @name && t.age >= @age RETURN t");
 
 		assertThat(entity.getCode(), is(200));
 		assertThat(entity.getBindVars().size(), is(2));
@@ -60,8 +64,8 @@ public void test_validateQuery_400_1() throws ArangoException {
 		// =じゃなくて==じゃないとダメ。文法間違いエラー
 		try {
 			driver.validateQuery(
-			// "SELECT t FROM unit_test_cursor t WHERE t.name = @name@"
-			"FOR t IN unit_test_cursor FILTER t.name = @name@");
+				// "SELECT t FROM unit_test_cursor t WHERE t.name = @name@"
+				"FOR t IN unit_test_cursor FILTER t.name = @name@");
 
 		} catch (ArangoException e) {
 			assertThat(e.getCode(), is(400));
@@ -258,4 +262,23 @@ public void test_executeQueryUniqueResult() throws ArangoException {
 			assertThat(entity.getAge(), is(10));
 		}
 	}
+
+	@Test
+	public void test_warning() throws ArangoException {
+		String collectionName = "unit_test_query_test";
+		try {
+			driver.createCollection(collectionName);
+		} catch (ArangoException e) {
+		}
+		driver.truncateCollection(collectionName);
+
+		String query = "return _users + 1";
+		Map<String, Object> bindVars = new HashMap<String, Object>();
+		CursorResult<Map> cursor = driver.executeAqlQuery(query, bindVars, null, Map.class);
+		assertThat(cursor.hasWarning(), is(true));
+
+		List<WarningEntity> warnings = cursor.getWarnings();
+		assertThat(warnings.size(), is(1));
+	}
+
 }