ArangoSearchProperties storedValues

Author: rashtao

ChangeLog.md

@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+- support for `ArangoSearchProperties` value `storedValues` (ArangoDB v3.7)
 - support for `ArangoSearchProperties` value `primarySortCompression` (ArangoDB v3.7)
 - support for `overwriteMode` values `ignore` and `conflict` (ArangoDB v3.7)
 

src/main/java/com/arangodb/entity/arangosearch/ArangoSearchProperties.java

@@ -37,11 +37,13 @@ public class ArangoSearchProperties {
     private final Collection<PrimarySort> primarySorts;
     private final Collection<CollectionLink> links;
     private ArangoSearchCompression primarySortCompression;
+    private final Collection<StoredValue> storedValues;
 
     public ArangoSearchProperties() {
         super();
         links = new ArrayList<>();
         primarySorts = new ArrayList<>();
+        storedValues = new ArrayList<>();
     }
 
     public Long getCommitIntervalMsec() {
@@ -100,4 +102,12 @@ public void setPrimarySortCompression(ArangoSearchCompression primarySortCompres
         this.primarySortCompression = primarySortCompression;
     }
 
+    public Collection<StoredValue> getStoredValues() {
+        return storedValues;
+    }
+
+    public void addStoredValues(final StoredValue... storedValues) {
+        this.storedValues.addAll(Arrays.asList(storedValues));
+    }
+
 }

src/main/java/com/arangodb/entity/arangosearch/ArangoSearchPropertiesEntity.java

@@ -102,4 +102,8 @@ public ArangoSearchCompression getPrimarySortCompression() {
         return properties.getPrimarySortCompression();
     }
 
+    public Collection<StoredValue> getStoredValues() {
+        return properties.getStoredValues();
+    }
+
 }

src/main/java/com/arangodb/entity/arangosearch/StoredValue.java

@@ -0,0 +1,51 @@
+/*
+ * DISCLAIMER
+ *
+ * Copyright 2016 ArangoDB GmbH, Cologne, Germany
+ *
+ * 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.
+ *
+ * Copyright holder is ArangoDB GmbH, Cologne, Germany
+ */
+
+package com.arangodb.entity.arangosearch;
+
+
+import java.util.List;
+
+/**
+ * @author Michele Rastelli
+ */
+public class StoredValue {
+
+    private final List<String> fields;
+    private final ArangoSearchCompression compression;
+
+    public StoredValue(List<String> fields, ArangoSearchCompression compression) {
+        this.fields = fields;
+        this.compression = compression;
+    }
+
+    public StoredValue(List<String> fields) {
+        this(fields, null);
+    }
+
+    public List<String> getFields() {
+        return fields;
+    }
+
+    public ArangoSearchCompression getCompression() {
+        return compression;
+    }
+
+}

src/main/java/com/arangodb/internal/velocypack/VPackDeserializers.java

@@ -33,9 +33,7 @@
 
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
-import java.util.Date;
-import java.util.Iterator;
-import java.util.Map;
+import java.util.*;
 import java.util.Map.Entry;
 
 /**
@@ -205,6 +203,24 @@ public class VPackDeserializers {
             properties.setPrimarySortCompression(ArangoSearchCompression.valueOf(primarySortCompression.getAsString()));
         }
 
+        final VPackSlice storedValues = vpack.get("storedValues");
+        if (storedValues.isArray()) {
+            final Iterator<VPackSlice> storedValueIterator = storedValues.arrayIterator();
+            for (; storedValueIterator.hasNext(); ) {
+                final VPackSlice entry = storedValueIterator.next();
+                if (entry.isObject()) {
+                    VPackSlice fields = entry.get("fields");
+                    VPackSlice compression = entry.get("compression");
+                    if (fields.isArray() && compression.isString()) {
+                        final Iterator<VPackSlice> fieldsIterator = fields.arrayIterator();
+                        List<String> fieldsList = new ArrayList<>();
+                        fieldsIterator.forEachRemaining(it -> fieldsList.add(it.getAsString()));
+                        properties.addStoredValues(new StoredValue(fieldsList, ArangoSearchCompression.valueOf(compression.getAsString())));
+                    }
+                }
+            }
+        }
+
         return properties;
     };
 

src/main/java/com/arangodb/internal/velocypack/VPackSerializers.java

@@ -193,6 +193,23 @@ public class VPackSerializers {
             builder.add("primarySortCompression", primarySortCompression.getValue());
         }
 
+        final Collection<StoredValue> storedValues = value.getStoredValues();
+        if (!storedValues.isEmpty()) {
+            builder.add("storedValues", ValueType.ARRAY); // open array
+            for (final StoredValue storedValue : storedValues) {
+                builder.add(ValueType.OBJECT); // open object
+                builder.add("fields", ValueType.ARRAY);
+                for (final String field : storedValue.getFields()) {
+                    builder.add(field);
+                }
+                builder.close();
+                builder.add("compression", storedValue.getCompression().getValue());
+                builder.close(); // close object
+            }
+            builder.close(); // close array
+        }
+
+
     };
 
     private static void serializeFieldLinks(final VPackBuilder builder, final Collection<FieldLink> links) {

src/main/java/com/arangodb/model/arangosearch/ArangoSearchCreateOptions.java

@@ -126,4 +126,12 @@ public ArangoSearchCreateOptions primarySortCompression(final ArangoSearchCompre
         return this;
     }
 
+    /**
+     * @return options
+     */
+    public ArangoSearchCreateOptions storedValues(final StoredValue... storedValues) {
+        properties.addStoredValues(storedValues);
+        return this;
+    }
+
 }

src/test/java/com/arangodb/ArangoSearchTest.java

@@ -135,6 +135,8 @@ public void createWithPrimarySort() {
         options.primarySort(primarySort);
         options.primarySortCompression(ArangoSearchCompression.none);
         options.consolidationIntervalMsec(666666L);
+        StoredValue storedValue = new StoredValue(Arrays.asList("a", "b"), ArangoSearchCompression.none);
+        options.storedValues(storedValue);
 
         final ArangoSearch view = db.arangoSearch(viewName);
         final ViewEntity info = view.create(options);
@@ -146,6 +148,13 @@ public void createWithPrimarySort() {
 
         final ArangoSearchPropertiesEntity properties = view.getProperties();
         assertThat(properties.getPrimarySortCompression(), is(ArangoSearchCompression.none));
+        Collection<StoredValue> retrievedStoredValues = properties.getStoredValues();
+        assertThat(retrievedStoredValues, is(notNullValue()));
+        assertThat(retrievedStoredValues.size(), is(1));
+        StoredValue retrievedStoredValue = retrievedStoredValues.iterator().next();
+        assertThat(retrievedStoredValue, is(notNullValue()));
+        assertThat(retrievedStoredValue.getFields(), is(storedValue.getFields()));
+        assertThat(retrievedStoredValue.getCompression(), is(storedValue.getCompression()));
     }
 
     @Test