typed analyzers (#334)

* typed analyzers

* resolved pending TODOs

* API deprecations and changelog upd

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]
 
+- typed ArangoSearch analyzers
 - updated dependecies
 - bugfix asynchronous shutdown
 

src/main/java/com/arangodb/ArangoDatabase.java

@@ -22,6 +22,7 @@
 
 import com.arangodb.entity.*;
 import com.arangodb.entity.arangosearch.AnalyzerEntity;
+import com.arangodb.entity.arangosearch.analyzer.SearchAnalyzer;
 import com.arangodb.model.*;
 import com.arangodb.model.arangosearch.AnalyzerDeleteOptions;
 import com.arangodb.model.arangosearch.ArangoSearchCreateOptions;
@@ -729,9 +730,21 @@ <V, E> TraversalEntity<V, E> executeTraversal(Class<V> vertexClass, Class<E> edg
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/analyzers.html">API Documentation</a>
      * @since ArangoDB 3.5.0
+     * @deprecated use {@link this#createSearchAnalyzer(SearchAnalyzer)}}
      */
     AnalyzerEntity createAnalyzer(AnalyzerEntity options) throws ArangoDBException;
 
+    /**
+     * Creates an Analyzer
+     *
+     * @param analyzer SearchAnalyzer
+     * @return the created Analyzer
+     * @throws ArangoDBException
+     * @see <a href="https://www.arangodb.com/docs/stable/http/analyzers.html">API Documentation</a>
+     * @since ArangoDB 3.5.0
+     */
+    SearchAnalyzer createSearchAnalyzer(SearchAnalyzer analyzer) throws ArangoDBException;
+
     /**
      * Gets information about an Analyzer
      *
@@ -740,26 +753,50 @@ <V, E> TraversalEntity<V, E> executeTraversal(Class<V> vertexClass, Class<E> edg
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/analyzers.html">API Documentation</a>
      * @since ArangoDB 3.5.0
+     * @deprecated use {@link this#getSearchAnalyzer(String)}}
      */
     AnalyzerEntity getAnalyzer(String name) throws ArangoDBException;
 
+    /**
+     * Gets information about an Analyzer
+     *
+     * @param name of the Analyzer without database prefix
+     * @return information about an Analyzer
+     * @throws ArangoDBException
+     * @see <a href="https://www.arangodb.com/docs/stable/http/analyzers.html">API Documentation</a>
+     * @since ArangoDB 3.5.0
+     */
+    SearchAnalyzer getSearchAnalyzer(String name) throws ArangoDBException;
+
     /**
      * Retrieves all analyzers definitions.
      *
      * @return collection of all analyzers definitions
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/analyzers.html">API Documentation</a>
      * @since ArangoDB 3.5.0
+     * @deprecated use {@link this#getSearchAnalyzers()}
      */
     Collection<AnalyzerEntity> getAnalyzers() throws ArangoDBException;
 
+    /**
+     * Retrieves all analyzers definitions.
+     *
+     * @return collection of all analyzers definitions
+     * @throws ArangoDBException
+     * @see <a href="https://www.arangodb.com/docs/stable/http/analyzers.html">API Documentation</a>
+     * @since ArangoDB 3.5.0
+     */
+    Collection<SearchAnalyzer> getSearchAnalyzers() throws ArangoDBException;
+
     /**
      * Deletes an Analyzer
      *
      * @param name of the Analyzer without database prefix
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/analyzers.html">API Documentation</a>
      * @since ArangoDB 3.5.0
+     * @deprecated use {@link this#deleteSearchAnalyzer(String)}}}
      */
     void deleteAnalyzer(String name) throws ArangoDBException;
 
@@ -771,7 +808,29 @@ <V, E> TraversalEntity<V, E> executeTraversal(Class<V> vertexClass, Class<E> edg
      * @throws ArangoDBException
      * @see <a href="https://www.arangodb.com/docs/stable/http/analyzers.html">API Documentation</a>
      * @since ArangoDB 3.5.0
+     * @deprecated use {@link this#deleteSearchAnalyzer(String, AnalyzerDeleteOptions)}}}
      */
     void deleteAnalyzer(String name, AnalyzerDeleteOptions options) throws ArangoDBException;
 
+    /**
+     * Deletes an Analyzer
+     *
+     * @param name of the Analyzer without database prefix
+     * @throws ArangoDBException
+     * @see <a href="https://www.arangodb.com/docs/stable/http/analyzers.html">API Documentation</a>
+     * @since ArangoDB 3.5.0
+     */
+    void deleteSearchAnalyzer(String name) throws ArangoDBException;
+
+    /**
+     * Deletes an Analyzer
+     *
+     * @param name    of the Analyzer without database prefix
+     * @param options AnalyzerDeleteOptions
+     * @throws ArangoDBException
+     * @see <a href="https://www.arangodb.com/docs/stable/http/analyzers.html">API Documentation</a>
+     * @since ArangoDB 3.5.0
+     */
+    void deleteSearchAnalyzer(String name, AnalyzerDeleteOptions options) throws ArangoDBException;
+
 }

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

@@ -25,6 +25,7 @@
 
 /**
  * @author Michele Rastelli
+ * @deprecated use typed analyzers {@link com.arangodb.entity.arangosearch.analyzer}
  */
 public class AnalyzerEntity {
 

src/main/java/com/arangodb/entity/arangosearch/analyzer/DelimiterAnalyzer.java

@@ -0,0 +1,59 @@
+/*
+ * 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.analyzer;
+
+
+import com.arangodb.entity.arangosearch.AnalyzerType;
+
+import java.util.Objects;
+
+/**
+ * @author Michele Rastelli
+ */
+public class DelimiterAnalyzer extends SearchAnalyzer {
+    public DelimiterAnalyzer() {
+        setType(AnalyzerType.delimiter);
+    }
+
+    private DelimiterAnalyzerProperties properties;
+
+    public DelimiterAnalyzerProperties getProperties() {
+        return properties;
+    }
+
+    public void setProperties(DelimiterAnalyzerProperties properties) {
+        this.properties = properties;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        if (!super.equals(o)) return false;
+        DelimiterAnalyzer that = (DelimiterAnalyzer) o;
+        return Objects.equals(properties, that.properties);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(super.hashCode(), properties);
+    }
+}

src/main/java/com/arangodb/entity/arangosearch/analyzer/DelimiterAnalyzerProperties.java

@@ -0,0 +1,53 @@
+/*
+ * 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.analyzer;
+
+
+import java.util.Objects;
+
+/**
+ * @author Michele Rastelli
+ */
+public class DelimiterAnalyzerProperties {
+
+    private String delimiter;
+
+    public String getDelimiter() {
+        return delimiter;
+    }
+
+    public void setDelimiter(String delimiter) {
+        this.delimiter = delimiter;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        DelimiterAnalyzerProperties that = (DelimiterAnalyzerProperties) o;
+        return Objects.equals(delimiter, that.delimiter);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(delimiter);
+    }
+}

src/main/java/com/arangodb/entity/arangosearch/analyzer/EdgeNgram.java

@@ -0,0 +1,72 @@
+/*
+ * 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.analyzer;
+
+
+import java.util.Objects;
+
+/**
+ * @author Michele Rastelli
+ */
+public class EdgeNgram {
+    private long min;
+    private long max;
+    private boolean preserveOriginal;
+
+    public long getMin() {
+        return min;
+    }
+
+    public void setMin(long min) {
+        this.min = min;
+    }
+
+    public long getMax() {
+        return max;
+    }
+
+    public void setMax(long max) {
+        this.max = max;
+    }
+
+    public boolean isPreserveOriginal() {
+        return preserveOriginal;
+    }
+
+    public void setPreserveOriginal(boolean preserveOriginal) {
+        this.preserveOriginal = preserveOriginal;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        EdgeNgram edgeNgram = (EdgeNgram) o;
+        return min == edgeNgram.min &&
+                max == edgeNgram.max &&
+                preserveOriginal == edgeNgram.preserveOriginal;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(min, max, preserveOriginal);
+    }
+}

src/main/java/com/arangodb/entity/arangosearch/analyzer/IdentityAnalyzer.java

@@ -0,0 +1,43 @@
+/*
+ * 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.analyzer;
+
+
+import com.arangodb.entity.arangosearch.AnalyzerType;
+
+/**
+ * @author Michele Rastelli
+ */
+public class IdentityAnalyzer extends SearchAnalyzer {
+    public IdentityAnalyzer() {
+        setType(AnalyzerType.identity);
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        return super.equals(o);
+    }
+
+    @Override
+    public int hashCode() {
+        return super.hashCode();
+    }
+}