InvertedIndexOptions

Author: rashtao

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

@@ -50,5 +50,10 @@ public enum IndexType {
 
     ttl,
 
-    zkd
+    zkd,
+
+    /**
+     * @since ArangoDB 3.10
+     */
+    inverted
 }

src/main/java/com/arangodb/model/InvertedIndexOptions.java

@@ -0,0 +1,287 @@
+/*
+ * 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.model;
+
+import com.arangodb.entity.IndexType;
+import com.arangodb.entity.arangosearch.*;
+
+import java.util.*;
+
+/**
+ * TODO: document, see https://github.com/arangodb/docs/pull/1109
+ *
+ * @author Michele Rastelli
+ * @see <a href="https://www.arangodb.com/docs/stable/http/indexes-inverted.html">API Documentation</a>
+ * @since ArangoDB 3.10
+ */
+public class InvertedIndexOptions extends IndexOptions<InvertedIndexOptions> {
+
+    protected final IndexType type = IndexType.inverted;
+    private Integer parallelism;
+    private PrimarySort primarySort;
+    private final Collection<StoredValue> storedValues = new ArrayList<>();
+    private String analyzer;
+    private final Collection<AnalyzerFeature> features = new ArrayList<>();
+    private Boolean includeAllFields;
+    private Boolean trackListPositions;
+    private Boolean searchField;
+    private final Collection<InvertedIndexField> fields = new ArrayList<>();
+
+    public InvertedIndexOptions() {
+        super();
+    }
+
+    @Override
+    protected InvertedIndexOptions getThis() {
+        return this;
+    }
+
+    protected IndexType getType() {
+        return type;
+    }
+
+    public Integer getParallelism() {
+        return parallelism;
+    }
+
+    public InvertedIndexOptions parallelism(Integer parallelism) {
+        this.parallelism = parallelism;
+        return this;
+    }
+
+    public PrimarySort getPrimarySort() {
+        return primarySort;
+    }
+
+    public InvertedIndexOptions primarySort(PrimarySort primarySort) {
+        this.primarySort = primarySort;
+        return this;
+    }
+
+    public Collection<StoredValue> getStoredValues() {
+        return storedValues;
+    }
+
+    public InvertedIndexOptions storedValues(StoredValue... storedValues) {
+        Collections.addAll(this.storedValues, storedValues);
+        return this;
+    }
+
+    public String getAnalyzer() {
+        return analyzer;
+    }
+
+    public InvertedIndexOptions analyzer(String analyzer) {
+        this.analyzer = analyzer;
+        return this;
+    }
+
+    public Collection<AnalyzerFeature> getFeatures() {
+        return features;
+    }
+
+    public InvertedIndexOptions features(AnalyzerFeature... features) {
+        Collections.addAll(this.features, features);
+        return this;
+    }
+
+    public Boolean getIncludeAllFields() {
+        return includeAllFields;
+    }
+
+    public InvertedIndexOptions includeAllFields(Boolean includeAllFields) {
+        this.includeAllFields = includeAllFields;
+        return this;
+    }
+
+    public Boolean getTrackListPositions() {
+        return trackListPositions;
+    }
+
+    public InvertedIndexOptions trackListPositions(Boolean trackListPositions) {
+        this.trackListPositions = trackListPositions;
+        return this;
+    }
+
+    public Boolean getSearchField() {
+        return searchField;
+    }
+
+    public InvertedIndexOptions searchField(Boolean searchField) {
+        this.searchField = searchField;
+        return this;
+    }
+
+    public Collection<InvertedIndexField> getFields() {
+        return fields;
+    }
+
+    public InvertedIndexOptions fields(InvertedIndexField... fields) {
+        Collections.addAll(this.fields, fields);
+        return this;
+    }
+
+    public static class PrimarySort {
+        private final List<Field> fields = new ArrayList<>();
+        private ArangoSearchCompression compression;
+
+        public List<Field> getFields() {
+            return fields;
+        }
+
+        public PrimarySort fields(Field... fields) {
+            Collections.addAll(this.fields, fields);
+            return this;
+        }
+
+        public ArangoSearchCompression getCompression() {
+            return compression;
+        }
+
+        public PrimarySort compression(ArangoSearchCompression compression) {
+            this.compression = compression;
+            return this;
+        }
+
+        @Override
+        public boolean equals(Object o) {
+            if (this == o) return true;
+            if (o == null || getClass() != o.getClass()) return false;
+            PrimarySort that = (PrimarySort) o;
+            return Objects.equals(fields, that.fields) && compression == that.compression;
+        }
+
+        @Override
+        public int hashCode() {
+            return Objects.hash(fields, compression);
+        }
+
+        public static class Field {
+            private final String field;
+            private final Direction direction;
+
+            public Field(String field, Direction direction) {
+                this.field = field;
+                this.direction = direction;
+            }
+
+            @Override
+            public boolean equals(Object o) {
+                if (this == o) return true;
+                if (o == null || getClass() != o.getClass()) return false;
+                Field field1 = (Field) o;
+                return Objects.equals(field, field1.field) && direction == field1.direction;
+            }
+
+            @Override
+            public int hashCode() {
+                return Objects.hash(field, direction);
+            }
+
+            public enum Direction {
+                asc,
+                desc
+            }
+
+        }
+
+    }
+
+    public static class InvertedIndexField {
+        private String name;
+        private String analyzer;
+        private Boolean includeAllFields;
+        private Boolean searchField;
+        private Boolean trackListPositions;
+        private final Collection<AnalyzerFeature> features = new ArrayList<>();
+
+        // TODO: nested
+        // private final Collection<?> nested;
+
+        public String getName() {
+            return name;
+        }
+
+        public InvertedIndexField name(String name) {
+            this.name = name;
+            return this;
+        }
+
+        public String getAnalyzer() {
+            return analyzer;
+        }
+
+        public InvertedIndexField analyzer(String analyzer) {
+            this.analyzer = analyzer;
+            return this;
+        }
+
+        public Boolean getIncludeAllFields() {
+            return includeAllFields;
+        }
+
+        public InvertedIndexField includeAllFields(Boolean includeAllFields) {
+            this.includeAllFields = includeAllFields;
+            return this;
+        }
+
+        public Boolean getSearchField() {
+            return searchField;
+        }
+
+        public InvertedIndexField searchField(Boolean searchField) {
+            this.searchField = searchField;
+            return this;
+        }
+
+        public Boolean getTrackListPositions() {
+            return trackListPositions;
+        }
+
+        public InvertedIndexField trackListPositions(Boolean trackListPositions) {
+            this.trackListPositions = trackListPositions;
+            return this;
+        }
+
+        public Collection<AnalyzerFeature> getFeatures() {
+            return features;
+        }
+
+        public InvertedIndexField features(AnalyzerFeature... features) {
+            Collections.addAll(this.features, features);
+            return this;
+        }
+
+        @Override
+        public boolean equals(Object o) {
+            if (this == o) return true;
+            if (o == null || getClass() != o.getClass()) return false;
+            InvertedIndexField that = (InvertedIndexField) o;
+            return Objects.equals(name, that.name) && Objects.equals(analyzer, that.analyzer) && Objects.equals(includeAllFields, that.includeAllFields) && Objects.equals(searchField, that.searchField) && Objects.equals(trackListPositions, that.trackListPositions) && Objects.equals(features, that.features);
+        }
+
+        @Override
+        public int hashCode() {
+            return Objects.hash(name, analyzer, includeAllFields, searchField, trackListPositions, features);
+        }
+    }
+
+}