javadoc upd

Author: rashtao

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

@@ -23,9 +23,19 @@
 
 /**
  * @author Michele Rastelli
+ * @see <a href="https://www.arangodb.com/docs/stable/http/views-arangosearch.html">API Documentation</a>
+ * @since ArangoDB 3.7
  */
 public enum ArangoSearchCompression {
+
+    /**
+     * (default): use LZ4 fast compression.
+     */
     lz4("lz4"),
+
+    /**
+     * disable compression to trade space for speed.
+     */
     none("none");
 
     private final String value;

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

@@ -27,6 +27,8 @@
 /**
  * @author Mark Vollmary
  * @author Heiko Kernbach
+ * @author Michele Rastelli
+ * @see <a href="https://www.arangodb.com/docs/stable/http/views-arangosearch.html">API Documentation</a>
  */
 public class ArangoSearchProperties {
 
@@ -94,6 +96,11 @@ public void addPrimarySort(final PrimarySort... primarySorts) {
         this.primarySorts.addAll(Arrays.asList(primarySorts));
     }
 
+    /**
+     * @return Defines how to compress the primary sort data (introduced in v3.7.0). ArangoDB v3.5 and v3.6 always
+     * compress the index using LZ4.
+     * @since ArangoDB 3.7
+     */
     public ArangoSearchCompression getPrimarySortCompression() {
         return primarySortCompression;
     }
@@ -102,6 +109,12 @@ public void setPrimarySortCompression(ArangoSearchCompression primarySortCompres
         this.primarySortCompression = primarySortCompression;
     }
 
+    /**
+     * @return An array of objects to describe which document attributes to store in the View index. It can then cover
+     * search queries, which means the data can be taken from the index directly and accessing the storage engine can be
+     * avoided.
+     * @since ArangoDB 3.7
+     */
     public Collection<StoredValue> getStoredValues() {
         return storedValues;
     }

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

@@ -27,6 +27,8 @@
 
 /**
  * @author Mark Vollmary
+ * @author Michele Rastelli
+ * @see <a href="https://www.arangodb.com/docs/stable/http/views-arangosearch.html">API Documentation</a>
  */
 public class ArangoSearchPropertiesEntity extends ViewEntity {
 
@@ -96,12 +98,20 @@ public Collection<PrimarySort> getPrimarySort() {
     }
 
     /**
-     * @return how to compress the primary sort data
+     * @return Defines how to compress the primary sort data (introduced in v3.7.0). ArangoDB v3.5 and v3.6 always
+     * compress the index using LZ4.
+     * @since ArangoDB 3.7
      */
     public ArangoSearchCompression getPrimarySortCompression() {
         return properties.getPrimarySortCompression();
     }
 
+    /**
+     * @return An array of objects to describe which document attributes to store in the View index. It can then cover
+     * search queries, which means the data can be taken from the index directly and accessing the storage engine can be
+     * avoided.
+     * @since ArangoDB 3.7
+     */
     public Collection<StoredValue> getStoredValues() {
         return properties.getStoredValues();
     }

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

@@ -25,6 +25,8 @@
 
 /**
  * @author Michele Rastelli
+ * @see <a href="https://www.arangodb.com/docs/stable/http/views-arangosearch.html">API Documentation</a>
+ * @since ArangoDB 3.7
  */
 public class StoredValue {
 
@@ -40,10 +42,18 @@ public StoredValue(List<String> fields) {
         this(fields, null);
     }
 
+    /**
+     * @return an array of strings with one or more document attribute paths. The specified attributes are placed into a
+     * single column of the index. A column with all fields that are involved in common search queries is ideal for
+     * performance. The column should not include too many unneeded fields however.
+     */
     public List<String> getFields() {
         return fields;
     }
 
+    /**
+     * @return defines the compression type used for the internal column-store
+     */
     public ArangoSearchCompression getCompression() {
         return compression;
     }