added support for sparse indexes

Author: Jan Steemann

src/main/java/com/arangodb/ArangoDriver.java

@@ -1977,6 +1977,22 @@ public IndexEntity createIndex(long collectionId, IndexType type, boolean unique
       throws ArangoException {
     return createIndex(String.valueOf(collectionId), type, unique, fields);
   }
+  
+  /**
+   * This method creates an index for a collection.
+   *
+   * @param collectionId The collection id.
+   * @param type the index type.
+   * @param unique if set to true the index will be a unique index
+   * @param sparse if set to true the index will be sparse
+   * @param fields the fields (document attributes) the index is created on
+   * @return IndexEntity
+   * @throws ArangoException
+   */
+  public IndexEntity createIndex(long collectionId, IndexType type, boolean unique, boolean sparse, String... fields)
+      throws ArangoException {
+    return createIndex(String.valueOf(collectionId), type, unique, sparse, fields);
+  }
 
   /**
    * This method creates an index for a collection.
@@ -1992,6 +2008,22 @@ public IndexEntity createIndex(String collectionName, IndexType type, boolean un
       throws ArangoException {
     return indexDriver.createIndex(getDefaultDatabase(), collectionName, type, unique, fields);
   }
+  
+  /**
+   * This method creates an index for a collection.
+   *
+   * @param collectionName The collection name.
+   * @param type the index type.
+   * @param unique if set to true the index will be a unique index
+   * @param sparse if set to true the index will be sparse
+   * @param fields the fields (document attributes) the index is created on
+   * @return IndexEntity
+   * @throws ArangoException
+   */
+  public IndexEntity createIndex(String collectionName, IndexType type, boolean unique, boolean sparse, String... fields)
+      throws ArangoException {
+    return indexDriver.createIndex(getDefaultDatabase(), collectionName, type, unique, sparse, fields);
+  }
 
   /**
    * This method creates a hash index for a collection.
@@ -2005,6 +2037,20 @@ public IndexEntity createIndex(String collectionName, IndexType type, boolean un
   public IndexEntity createHashIndex(String collectionName, boolean unique, String... fields) throws ArangoException {
     return indexDriver.createIndex(getDefaultDatabase(), collectionName, IndexType.HASH, unique, fields);
   }
+  
+  /**
+   * This method creates a hash index for a collection.
+   *
+   * @param collectionName The collection name.
+   * @param unique if set to true the index will be a unique index
+   * @param sparse if set to true the index will be sparse
+   * @param fields the fields (document attributes) the index is created on
+   * @return IndexEntity
+   * @throws ArangoException
+   */
+  public IndexEntity createHashIndex(String collectionName, boolean unique, boolean sparse, String... fields) throws ArangoException {
+    return indexDriver.createIndex(getDefaultDatabase(), collectionName, IndexType.HASH, unique, sparse, fields);
+  }
 
   /**
    * This method creates a geo index for a collection.
@@ -2032,6 +2078,21 @@ public IndexEntity createSkipListIndex(String collectionName, boolean unique, St
       throws ArangoException {
     return indexDriver.createIndex(getDefaultDatabase(), collectionName, IndexType.SKIPLIST, unique, fields);
   }
+  
+  /**
+   * This method creates a skip list index for a collection.
+   *
+   * @param collectionName The collection name.
+   * @param unique if set to true the index will be a unique index
+   * @param sparse if set to true the index will be sparse
+   * @param fields the fields (document attributes) the index is created on
+   * @return IndexEntity
+   * @throws ArangoException
+   */
+  public IndexEntity createSkipListIndex(String collectionName, boolean unique, boolean sparse, String... fields)
+      throws ArangoException {
+    return indexDriver.createIndex(getDefaultDatabase(), collectionName, IndexType.SKIPLIST, unique, sparse, fields);
+  }
 
   /**
    * This method creates a capped index for a collection.

src/main/java/com/arangodb/InternalIndexDriver.java

@@ -9,6 +9,8 @@
  * Created by fbartels on 10/27/14.
  */
 public interface InternalIndexDriver  extends BaseDriverInterface {
+  IndexEntity createIndex(String database, String collectionName, IndexType type, boolean unique, boolean sparse, String... fields) throws ArangoException;
+
   IndexEntity createIndex(String database, String collectionName, IndexType type, boolean unique, String... fields) throws ArangoException;
 
   IndexEntity createCappedIndex(String database, String collectionName, int size) throws ArangoException;

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

@@ -748,6 +748,10 @@ public IndexEntity deserialize(JsonElement json, Type typeOfT, JsonDeserializati
       if (obj.has("unique")) {
         entity.unique = obj.getAsJsonPrimitive("unique").getAsBoolean();
       }
+      
+      if (obj.has("sparse")) {
+        entity.sparse = obj.getAsJsonPrimitive("sparse").getAsBoolean();
+      }
 
       if (obj.has("size")) {
         entity.size = obj.getAsJsonPrimitive("size").getAsInt();
@@ -756,6 +760,10 @@ public IndexEntity deserialize(JsonElement json, Type typeOfT, JsonDeserializati
       if (obj.has("minLength")) {
         entity.minLength = obj.getAsJsonPrimitive("minLength").getAsInt();
       }
+      
+      if (obj.has("selectivityEstimate")) {
+        entity.selectivityEstimate = obj.getAsJsonPrimitive("selectivityEstimate").getAsDouble();
+      }
 
       return entity;
     }

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

@@ -57,6 +57,11 @@ public class IndexEntity extends BaseEntity {
    * if true the index is a unique index.
    */
   boolean unique;
+  
+  /**
+   * if true the index is sparse
+   */
+  boolean sparse;
 
   /**
    * the maximum amount of documents in case the index type is capped
@@ -67,6 +72,11 @@ public class IndexEntity extends BaseEntity {
    * minimum character length of words to index in case the index type is a fulltext
    */
   int minLength;
+  
+  /**
+   * index selectivity estimate (if provided by the index)
+   */
+  double selectivityEstimate;
 
   public String getId() {
     return id;
@@ -86,9 +96,15 @@ public boolean isNewlyCreated() {
   public boolean isUnique() {
     return unique;
   }
+  public boolean isSparse() {
+    return sparse;
+  }
   public int getSize() {
     return size;
   }
+  public double getSelectivityEstimate() {
+    return selectivityEstimate;
+  }
   public void setId(String id) {
     this.id = id;
   }
@@ -107,6 +123,9 @@ public void setNewlyCreated(boolean isNewlyCreated) {
   public void setUnique(boolean unique) {
     this.unique = unique;
   }
+  public void setSparse(boolean sparse) {
+    this.sparse = sparse;
+  }
   public void setSize(int size) {
     this.size = size;
   }
@@ -116,5 +135,8 @@ public int getMinLength() {
   public void setMinLength(int minLength) {
     this.minLength = minLength;
   }
+  public void setSelectivityEstimate(double selectivityEstimate) {
+    this.selectivityEstimate = selectivityEstimate;
+  }
 
 }

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

@@ -24,6 +24,8 @@
 public enum IndexType {
   /** Primary Index */
   PRIMARY,
+  /** Edge Index */
+  EDGE,
   /** Cap Index */
   CAP,
   /** Geo Index */

src/main/java/com/arangodb/impl/InternalIndexDriverImpl.java

@@ -39,11 +39,14 @@ public class InternalIndexDriverImpl extends BaseArangoDriverWithCursorImpl impl
   }
 
   @Override
-  public IndexEntity createIndex(String database, String collectionName, IndexType type, boolean unique, String... fields) throws ArangoException {
+  public IndexEntity createIndex(String database, String collectionName, IndexType type, boolean unique, boolean sparse, String... fields) throws ArangoException {
 
     if (type == IndexType.PRIMARY) {
       throw new IllegalArgumentException("cannot create primary index.");
     }
+    if (type == IndexType.EDGE) {
+      throw new IllegalArgumentException("cannot create edge index.");
+    }
     if (type == IndexType.CAP) {
       throw new IllegalArgumentException("cannot create cap index. use createCappedIndex.");
     }
@@ -56,6 +59,7 @@ public IndexEntity createIndex(String database, String collectionName, IndexType
             new MapBuilder()
             .put("type", type.name().toLowerCase(Locale.US))
             .put("unique", unique)
+            .put("sparse", sparse)
             .put("fields", fields)
             .get()));
 
@@ -69,6 +73,12 @@ public IndexEntity createIndex(String database, String collectionName, IndexType
     }
 
   }
+  
+  
+  @Override
+  public IndexEntity createIndex(String database, String collectionName, IndexType type, boolean unique, String... fields) throws ArangoException {
+    return createIndex(database, collectionName, type, unique, false, fields);
+  }
 
   @Override
   public IndexEntity createCappedIndex(String database, String collectionName, int size) throws ArangoException {