[DE-379] inverted indexes documentation

Author: rashtao

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

@@ -28,8 +28,6 @@
 import java.util.Set;
 
 /**
- * TODO: add documentation
- *
  * @author Michele Rastelli
  * @see <a href="https://www.arangodb.com/docs/stable/http/indexes-inverted.html">API Documentation</a>
  * @since ArangoDB 3.10

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

@@ -5,8 +5,6 @@
 import java.util.*;
 
 /**
- * TODO: add documentation
- *
  * @author Michele Rastelli
  * @see <a href="https://www.arangodb.com/docs/stable/http/indexes-inverted.html">API Documentation</a>
  * @since ArangoDB 3.10
@@ -24,6 +22,10 @@ public String getName() {
         return name;
     }
 
+    /**
+     * @param name An attribute path. The . character denotes sub-attributes.
+     * @return this
+     */
     public InvertedIndexField name(String name) {
         this.name = name;
         return this;
@@ -33,6 +35,11 @@ public String getAnalyzer() {
         return analyzer;
     }
 
+    /**
+     * @param analyzer The name of an Analyzer to use for this field. Default: the value defined by the top-level
+     *                 analyzer option, or if not set, the default identity Analyzer.
+     * @return this
+     */
     public InvertedIndexField analyzer(String analyzer) {
         this.analyzer = analyzer;
         return this;
@@ -42,6 +49,15 @@ public Boolean getIncludeAllFields() {
         return includeAllFields;
     }
 
+    /**
+     * @param includeAllFields This option only applies if you use the inverted index in a search-alias Views. If set to
+     *                         true, then all sub-attributes of this field are indexed, excluding any sub-attributes
+     *                         that are configured separately by other elements in the fields array (and their
+     *                         sub-attributes). The analyzer and features properties apply to the sub-attributes. If set
+     *                         to false, then sub-attributes are ignored. The default value is defined by the top-level
+     *                         includeAllFields option, or false if not set.
+     * @return this
+     */
     public InvertedIndexField includeAllFields(Boolean includeAllFields) {
         this.includeAllFields = includeAllFields;
         return this;
@@ -51,6 +67,18 @@ public Boolean getSearchField() {
         return searchField;
     }
 
+    /**
+     * @param searchField This option only applies if you use the inverted index in a search-alias Views. You can set
+     *                    the option to true to get the same behavior as with arangosearch Views regarding the indexing
+     *                    of array values for this field. If enabled, both, array and primitive values (strings,
+     *                    numbers, etc.) are accepted. Every element of an array is indexed according to the
+     *                    trackListPositions option. If set to false, it depends on the attribute path. If it explicitly
+     *                    expand an array ([*]), then the elements are indexed separately. Otherwise, the array is
+     *                    indexed as a whole, but only geopoint and aql Analyzers accept array inputs. You cannot use an
+     *                    array expansion if searchField is enabled. Default: the value defined by the top-level
+     *                    searchField option, or false if not set.
+     * @return this
+     */
     public InvertedIndexField searchField(Boolean searchField) {
         this.searchField = searchField;
         return this;
@@ -60,6 +88,16 @@ public Boolean getTrackListPositions() {
         return trackListPositions;
     }
 
+    /**
+     * @param trackListPositions This option only applies if you use the inverted index in a search-alias Views. If set
+     *                           to true, then track the value position in arrays for array values. For example, when
+     *                           querying a document like { attr: [ "valueX", "valueY", "valueZ" ] }, you need to
+     *                           specify the array element, e.g. doc.attr[1] == "valueY". If set to false, all values in
+     *                           an array are treated as equal alternatives. You don’t specify an array element in
+     *                           queries, e.g. doc.attr == "valueY", and all elements are searched for a match. Default:
+     *                           the value defined by the top-level trackListPositions option, or false if not set.
+     * @return this
+     */
     public InvertedIndexField trackListPositions(Boolean trackListPositions) {
         this.trackListPositions = trackListPositions;
         return this;
@@ -69,6 +107,11 @@ public Set<AnalyzerFeature> getFeatures() {
         return features;
     }
 
+    /**
+     * @param features A list of Analyzer features to use for this field. They define what features are enabled for the
+     *                 analyzer.
+     * @return this
+     */
     public InvertedIndexField features(AnalyzerFeature... features) {
         Collections.addAll(this.features, features);
         return this;
@@ -78,8 +121,15 @@ public Collection<InvertedIndexField> getNested() {
         return nested;
     }
 
+    /**
+     * @param nested Index the specified sub-objects that are stored in an array. Other than with the fields property,
+     *               the values get indexed in a way that lets you query for co-occurring values. For example, you can
+     *               search the sub-objects and all the conditions need to be met by a single sub-object instead of
+     *               across all of them. This property is available in the Enterprise Edition only.
+     * @return this
+     */
     public InvertedIndexField nested(InvertedIndexField... nested) {
-        if(this.nested == null) this.nested = new ArrayList<>();
+        if (this.nested == null) this.nested = new ArrayList<>();
         Collections.addAll(this.nested, nested);
         return this;
     }

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

@@ -8,8 +8,6 @@
 import java.util.Objects;
 
 /**
- * TODO: add documentation
- *
  * @author Michele Rastelli
  * @see <a href="https://www.arangodb.com/docs/stable/http/indexes-inverted.html">API Documentation</a>
  * @since ArangoDB 3.10
@@ -22,6 +20,10 @@ public List<Field> getFields() {
         return fields;
     }
 
+    /**
+     * @param fields An array of the fields to sort the index by and the direction to sort each field in.
+     * @return this
+     */
     public InvertedIndexPrimarySort fields(Field... fields) {
         Collections.addAll(this.fields, fields);
         return this;
@@ -31,6 +33,10 @@ public ArangoSearchCompression getCompression() {
         return compression;
     }
 
+    /**
+     * @param compression Defines how to compress the primary sort data.
+     * @return this
+     */
     public InvertedIndexPrimarySort compression(ArangoSearchCompression compression) {
         this.compression = compression;
         return this;
@@ -53,6 +59,10 @@ public static class Field {
         private final String field;
         private final Direction direction;
 
+        /**
+         * @param field     An attribute path. The . character denotes sub-attributes.
+         * @param direction The sorting direction.
+         */
         public Field(String field, Direction direction) {
             this.field = field;
             this.direction = direction;

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

@@ -34,6 +34,10 @@ public class StoredValue {
     private final List<String> fields;
     private final ArangoSearchCompression compression;
 
+    /**
+     * @param fields      A list of attribute paths. The . character denotes sub-attributes.
+     * @param compression Defines how to compress the attribute values.
+     */
     public StoredValue(List<String> fields, ArangoSearchCompression compression) {
         this.fields = fields;
         this.compression = compression;
@@ -43,18 +47,10 @@ 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;
     }