Reorganize analyzer properties

arangodb-net-standard.Test/AnalyzerApi/AnalyzerApiClientTest.cs

@@ -47,14 +47,6 @@ public async Task PostAnalyzerAsync_ShouldSucceed()
                 {
                     Name = "text_sc",
                     Type = "identity",
-                    Properties = new AnalyzerProperties()
-                    {
-                        Accent = false,
-                        Case = "lower",
-                        Locale = "sc",
-                        Stemming = false,
-                        StopWords = new List<string>()
-                    },
                     Features = new List<string>() 
                     { 
                         "frequency", 
@@ -78,15 +70,7 @@ public async Task PostAnalyzerAsync_ShouldThrow_WhenAnalyzerIsInvalid()
                     new Analyzer()
                     {
                         Name = "text_sc",
-                        Type = "collection", //...invalid analyzer type
-                    Properties = new AnalyzerProperties()
-                        {
-                            Accent = false,
-                            Case = "lower",
-                            Locale = "sc",
-                            Stemming = false,
-                            StopWords = new List<string>()
-                        },
+                        Type = "collection", 
                         Features = new List<string>()
                         {
                         "frequency",
@@ -125,14 +109,6 @@ public async Task DeleteAnalyzerAsync_ShouldSucceed()
                 {
                     Name = name,
                     Type = "identity",
-                    Properties = new AnalyzerProperties()
-                    {
-                        Accent = false,
-                        Case = "lower",
-                        Locale = "mu",
-                        Stemming = false,
-                        StopWords = new List<string>()
-                    },
                     Features = new List<string>()
                     {
                         "frequency",

arangodb-net-standard/AnalyzerApi/AnalyzerApiClient.cs

@@ -72,10 +72,10 @@ public virtual async Task<GetAllAnalyzersResponse> GetAllAnalyzersAsync(Cancella
         /// Creates a new Analyzer based on the provided definition
         /// POST /_api/analyzer
         /// </summary>
-        /// <param name="body">The properties of the new analyzer.</param>
+        /// <param name="body">The definition of the new analyzer.</param>
         /// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
         /// <returns></returns>
-        public virtual async Task<Analyzer> PostAnalyzerAsync(Analyzer body, CancellationToken token = default)
+        public virtual async Task<Analyzer> PostAnalyzerAsync(AnalyzerDefinition body, CancellationToken token = default)
         {
             if (body == null)
             {

arangodb-net-standard/AnalyzerApi/IAnalyzerApiClient.cs

@@ -7,7 +7,7 @@ namespace ArangoDBNetStandard.AnalyzerApi
     /// <summary>
     /// Defines a client to access the ArangoDB Analyzer API.
     /// </summary>
-    internal interface IAnalyzerApiClient
+    public interface IAnalyzerApiClient
     {
         /// <summary>
         /// Fetch the list of available Analyzer definitions.
@@ -21,10 +21,10 @@ internal interface IAnalyzerApiClient
         /// Creates a new Analyzer based on the provided definition
         /// POST /_api/analyzer
         /// </summary>
-        /// <param name="body">The properties of the new analyzer.</param>
+        /// <param name="body">The definition of the new analyzer.</param>
         /// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
         /// <returns></returns>
-        Task<Analyzer> PostAnalyzerAsync(Analyzer body, CancellationToken token = default);
+        Task<Analyzer> PostAnalyzerAsync(AnalyzerDefinition body, CancellationToken token = default);
 
         /// <summary>
         /// Fetches the definition of the specified analyzer.

arangodb-net-standard/AnalyzerApi/Models/Analyzer.cs

@@ -5,42 +5,11 @@ namespace ArangoDBNetStandard.AnalyzerApi.Models
     /// <summary>
     /// Defines an Analyzer in the database
     /// </summary>
-    public class Analyzer
+    public class Analyzer: AnalyzerDefinition
     {
         /// <summary>
-        /// Name of the analyzer
-        /// For rules regarding analyzer names, see
-        /// https://www.arangodb.com/docs/stable/analyzers.html#analyzer-names
+        /// Properties of the analyzer        
         /// </summary>
-        public string Name { get; set; }
-
-        /// <summary>
-        /// Type of the analyzer
-        /// For valid analyzer types, see
-        /// https://www.arangodb.com/docs/stable/analyzers.html#analyzer-types
-        /// </summary>
-        public string Type { get; set; }
-
-        /// <summary>
-        /// Properties of the analyzer
-        /// used to configure the specified type
-        /// </summary>
-        public AnalyzerProperties Properties { get; set; }
-
-        /// <summary>
-        /// The set of features to set on 
-        /// the Analyzer generated fields.
-        /// Determines what term matching 
-        /// capabilities will be available. 
-        /// Possible features:
-        /// frequency: how often a term is seen, required for PHRASE().
-        /// norm: the field normalization factor.
-        /// position: sequentially increasing term position,
-        /// required for PHRASE(). If present then the
-        /// frequency feature is also required.
-        /// offset: 3.10 onwards. Enables search highlighting capabilities 
-        /// for ArangoSearch Views.
-        /// </summary>
-        public List<string> Features { get; set; }
+        public new AnalyzerProperties Properties { get; set; }
     }
 }

arangodb-net-standard/AnalyzerApi/Models/AnalyzerDefinition.cs

@@ -0,0 +1,47 @@
+using ArangoDBNetStandard.AnalyzerApi.Models.AnalyzerDefinitionProperties;
+using System.Collections.Generic;
+
+namespace ArangoDBNetStandard.AnalyzerApi.Models
+{
+    /// <summary>
+    /// Defines an Analyzer in the database
+    /// </summary>
+    public class AnalyzerDefinition
+    {
+        /// <summary>
+        /// Name of the analyzer
+        /// For rules regarding analyzer names, see
+        /// https://www.arangodb.com/docs/stable/analyzers.html#analyzer-names
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Type of the analyzer
+        /// For valid analyzer types, see
+        /// https://www.arangodb.com/docs/stable/analyzers.html#analyzer-types
+        /// </summary>
+        public string Type { get; set; }
+
+        /// <summary>
+        /// Properties of the analyzer
+        /// used to configure the specified <see cref="Type"/>
+        /// </summary>
+        public AnalyzerDefinitionPropertiesBase Properties { get; set; }
+
+        /// <summary>
+        /// The set of features to set on 
+        /// the Analyzer generated fields.
+        /// Determines what term matching 
+        /// capabilities will be available. 
+        /// Possible features:
+        /// frequency: how often a term is seen, required for PHRASE().
+        /// norm: the field normalization factor.
+        /// position: sequentially increasing term position,
+        /// required for PHRASE(). If present then the
+        /// frequency feature is also required.
+        /// offset: 3.10 onwards. Enables search highlighting capabilities 
+        /// for ArangoSearch Views.
+        /// </summary>
+        public List<string> Features { get; set; }
+    }
+}

arangodb-net-standard/AnalyzerApi/Models/AnalyzerDefinitionProperties/AQLAnalyzer.cs

@@ -0,0 +1,72 @@
+using System;
+
+namespace ArangoDBNetStandard.AnalyzerApi.Models.AnalyzerDefinitionProperties
+{
+    /// <summary>
+    /// Properties for AQL analyzer
+    /// </summary>
+    public class AQLAnalyzer : AnalyzerDefinitionPropertiesBase
+    {
+        /// <summary>
+        /// Convert emitted tokens to strings. (default)
+        /// </summary>
+        public const string ReturnTypeString = "string";
+
+        /// <summary>
+        /// Convert emitted tokens to numbers
+        /// </summary>
+        public const string ReturnTypeNumber = "number";
+
+        /// <summary>
+        /// Convert emitted tokens to booleans
+        /// </summary>
+        public const string ReturnTypeBool = "bool";
+
+        /// <summary>
+        /// AQL query to be executed
+        /// </summary>
+        public string QueryString { get; set; }
+
+        /// <summary>
+        /// When true: set the position to 0 for all members
+        /// of the query result array.
+        /// When false: (default): set the position corresponding
+        /// to the index of the result array member
+        /// </summary>
+        public bool CollapsePositions { get; set; }
+
+        /// <summary>
+        /// When true: (default): treat null like an empty string.
+        /// When false: discard nulls from View index. Can be used
+        /// for index filtering (i.e. make your query return null 
+        /// for unwanted data). Note that empty results are always
+        /// discarded.
+        /// </summary>
+        public bool KeepNull { get; set; }
+
+        /// <summary>
+        /// A number between 1 and 1000 (default = 1) that determines 
+        /// the batch size for reading data from the query. In general, 
+        /// a single token is expected to be returned. However, if the 
+        /// query is expected to return many results, then increasing 
+        /// <see cref="BatchSize"/> trades memory for performance.
+        /// </summary>
+        public int BatchSize { get; set; }
+
+        /// <summary>
+        /// Memory limit for query execution in bytes. 
+        /// (default is 1048576 = 1Mb) 
+        /// Maximum is 33554432U (32Mb)
+        /// </summary>
+        public int MemoryLimit { get; set; }
+
+        /// <summary>
+        /// The Data type of the returned tokens. If the indicated 
+        /// type does not match the actual type then an implicit 
+        /// type conversion is applied. For possible values, see
+        /// <see cref="ReturnTypeBool"/>, <see cref="ReturnTypeNumber"/>
+        /// and <see cref="ReturnTypeString"/>
+        /// </summary>
+        public string ReturnType { get; set; }
+    }
+}

arangodb-net-standard/AnalyzerApi/Models/AnalyzerDefinitionProperties/AnalyzerPropertiesBase.cs

@@ -0,0 +1,14 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace ArangoDBNetStandard.AnalyzerApi.Models.AnalyzerDefinitionProperties
+{
+    /// <summary>
+    /// Base class for analyzer properties
+    /// </summary>
+    public class AnalyzerDefinitionPropertiesBase
+    {
+
+    }
+}

arangodb-net-standard/AnalyzerApi/Models/AnalyzerDefinitionProperties/ClassificationAnalyzer.cs

@@ -0,0 +1,33 @@
+using System;
+
+namespace ArangoDBNetStandard.AnalyzerApi.Models.AnalyzerDefinitionProperties
+{
+    /// <summary>
+    /// Properties for Classification  analyzer.
+    /// (only available in the Enterprise Edition)
+    /// </summary>
+    public class ClassificationAnalyzer : AnalyzerDefinitionPropertiesBase
+    {
+        /// <summary>
+        /// Required. The on-disk path to the trained fastText 
+        /// supervised model. Note: if you are running this in 
+        /// an ArangoDB cluster, this model must exist on every
+        /// machine in the cluster.
+        /// </summary>
+        public string Model_Location { get; set; }
+
+        /// <summary>
+        /// Optional. The number of class labels that will be 
+        /// produced per input (default: 1).
+        /// </summary>
+        public int? Top_K { get; set; }
+
+        /// <summary>
+        /// Optional. The probability threshold for which a 
+        /// label will be assigned to an input. A fastText model
+        /// produces a probability per class label, and this is 
+        /// what will be filtered (default: 0.99).
+        /// </summary>
+        public int? Threshold { get; set; }
+    }
+}

arangodb-net-standard/AnalyzerApi/Models/AnalyzerDefinitionProperties/CollationAnalyzer.cs

@@ -0,0 +1,18 @@
+using System;
+
+namespace ArangoDBNetStandard.AnalyzerApi.Models.AnalyzerDefinitionProperties
+{
+    /// <summary>
+    /// Properties for Collation analyzer
+    /// </summary>
+    public class CollationAnalyzer : AnalyzerDefinitionPropertiesBase
+    {
+        /// <summary>
+        /// A locale in the format language, e.g. "de" or "en".
+        /// The locale is forwarded to the Snowball stemmer 
+        /// without checks. An invalid locale does not prevent 
+        /// the creation of the Analyzer.
+        /// </summary>
+        public string Locale { get; set; }
+    }
+}

arangodb-net-standard/AnalyzerApi/Models/AnalyzerDefinitionProperties/DelimiterAnalyzer.cs

@@ -0,0 +1,15 @@
+using System;
+
+namespace ArangoDBNetStandard.AnalyzerApi.Models.AnalyzerDefinitionProperties
+{
+    /// <summary>
+    /// Properties for delimiter analyzer
+    /// </summary>
+    public class DelimiterAnalyzer : AnalyzerDefinitionPropertiesBase
+    {
+        /// <summary>
+        /// The delimiting character(s)
+        /// </summary>
+        public string Delimiter { get; set; }
+    }
+}

arangodb-net-standard/AnalyzerApi/Models/AnalyzerDefinitionProperties/GeoJSONAnalyzer.cs

@@ -0,0 +1,41 @@
+using System;
+
+namespace ArangoDBNetStandard.AnalyzerApi.Models.AnalyzerDefinitionProperties
+{
+    /// <summary>
+    /// Properties for GeoJSON analyzer.
+    /// </summary>
+    public class GeoJSONAnalyzer : AnalyzerDefinitionPropertiesBase
+    {
+        /// <summary>
+        /// Index all GeoJSON geometry types (Point, Polygon etc.)
+        /// (default).
+        /// </summary>
+        public const string TypeShape = "shape";
+
+        /// <summary>
+        /// Compute and only index the centroid of the input 
+        /// geometry
+        /// </summary>
+        public const string TypeCentroid = "centroid";
+
+        /// <summary>
+        /// Only index GeoJSON objects of type Point, ignore all 
+        /// other geometry types
+        /// </summary>
+        public const string TypePoint = "point";
+
+        /// <summary>
+        /// Determines the type of indexing to use.
+        /// Possible values are <see cref="TypeCentroid"/>, 
+        /// <see cref="TypeShape"/> and <see cref="TypePoint"/>
+        /// </summary>
+        public string Type { get; set; }
+
+        /// <summary>
+        /// Options for fine-tuning geo queries. 
+        /// These options should generally remain unchanged.
+        /// </summary>
+        public GeoJSONAnalyzerOptions Options { get; set; }
+    }
+}