Move Similarity algorithm specifications to dedicated module

Author: vnickolov

algorithm-specifications/build.gradle

@@ -28,6 +28,9 @@ dependencies {
     implementation project(':path-finding-configs')
     implementation project(':path-finding-facade-api')
 
+    implementation project(':similarity-configs')
+    implementation project(':similarity-facade-api')
+
 
     // `BaseConfig`
     implementation project(':config-api')

proc/similarity/src/main/java/org/neo4j/gds/similarity/filteredknn/FilteredKnnConstants.java renamed to algorithm-specifications/src/main/java/org/neo4j/gds/similarity/filteredknn/Constants.java

@@ -19,10 +19,12 @@
  */
 package org.neo4j.gds.similarity.filteredknn;
 
-interface FilteredKnnConstants {
-    String PROCEDURE_DESCRIPTION =
+final class Constants {
+    static final String FILTERED_KNN_DESCRIPTION =
         "The k-nearest neighbor graph algorithm constructs relationships between nodes if the distance " +
         "between two nodes is among the k nearest distances compared to other nodes. " +
         "KNN computes distances based on the similarity of node properties. " +
         "Filtered KNN extends this functionality, allowing filtering on source nodes and target nodes, respectively.";
+
+    private Constants() {}
 }

proc/similarity/src/main/java/org/neo4j/gds/similarity/filteredknn/FilteredKnnMutateSpecification.java renamed to algorithm-specifications/src/main/java/org/neo4j/gds/similarity/filteredknn/FilteredKnnMutateSpecification.java

@@ -34,7 +34,7 @@
 @GdsCallable(
     name = "gds.alpha.knn.filtered.mutate",
     aliases = {"gds.knn.filtered.mutate"},
-    description = FilteredKnnConstants.PROCEDURE_DESCRIPTION,
+    description = Constants.FILTERED_KNN_DESCRIPTION,
     executionMode = MUTATE_RELATIONSHIP
 )
 public class FilteredKnnMutateSpecification implements AlgorithmSpec<FilteredKnn, FilteredKnnResult, FilteredKnnMutateConfig, Stream<KnnMutateResult>, FilteredKnnFactory<FilteredKnnMutateConfig>> {

proc/similarity/src/main/java/org/neo4j/gds/similarity/filteredknn/FilteredKnnStatsSpecification.java renamed to algorithm-specifications/src/main/java/org/neo4j/gds/similarity/filteredknn/FilteredKnnStatsSpecification.java

@@ -34,7 +34,7 @@
 @GdsCallable(
     name = "gds.alpha.knn.filtered.stats",
     aliases = {"gds.knn.filtered.stats"},
-    description = FilteredKnnConstants.PROCEDURE_DESCRIPTION,
+    description = Constants.FILTERED_KNN_DESCRIPTION,
     executionMode = STATS
 )
 public class FilteredKnnStatsSpecification implements AlgorithmSpec<FilteredKnn, FilteredKnnResult, FilteredKnnStatsConfig, Stream<KnnStatsResult>, FilteredKnnFactory<FilteredKnnStatsConfig>> {

proc/similarity/src/main/java/org/neo4j/gds/similarity/filteredknn/FilteredKnnStreamSpecification.java renamed to algorithm-specifications/src/main/java/org/neo4j/gds/similarity/filteredknn/FilteredKnnStreamSpecification.java

@@ -33,7 +33,7 @@
 @GdsCallable(
     name = "gds.knn.filtered.stream",
     aliases = {"gds.alpha.knn.filtered.stream"},
-    description = FilteredKnnConstants.PROCEDURE_DESCRIPTION,
+    description = Constants.FILTERED_KNN_DESCRIPTION,
     executionMode = ExecutionMode.STREAM
 )
 public class FilteredKnnStreamSpecification implements AlgorithmSpec<FilteredKnn, FilteredKnnResult, FilteredKnnStreamConfig, Stream<SimilarityResult>, FilteredKnnFactory<FilteredKnnStreamConfig>> {

proc/similarity/src/main/java/org/neo4j/gds/similarity/filteredknn/FilteredKnnWriteSpecification.java renamed to algorithm-specifications/src/main/java/org/neo4j/gds/similarity/filteredknn/FilteredKnnWriteSpecification.java

@@ -34,7 +34,7 @@
 @GdsCallable(
     name = "gds.knn.filtered.write",
     aliases = {"gds.alpha.knn.filtered.write"},
-    description = FilteredKnnConstants.PROCEDURE_DESCRIPTION,
+    description = Constants.FILTERED_KNN_DESCRIPTION,
     executionMode = WRITE_RELATIONSHIP
 )
 public class FilteredKnnWriteSpecification implements AlgorithmSpec<FilteredKnn, FilteredKnnResult, FilteredKnnWriteConfig, Stream<KnnWriteResult>, FilteredKnnFactory<FilteredKnnWriteConfig>> {

algorithm-specifications/src/main/java/org/neo4j/gds/similarity/filterednodesim/Constants.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.similarity.filterednodesim;
+
+final class Constants {
+    static final String FILTERED_NODE_SIMILARITY_DESCRIPTION =
+        "The Filtered Node Similarity algorithm compares a set of nodes based on the nodes they are connected to. " +
+            "Two nodes are considered similar if they share many of the same neighbors. " +
+            "The algorithm computes pair-wise similarities based on Jaccard or Overlap metrics. " +
+            "The filtered variant supports limiting which nodes to compare via source and target node filters.";
+
+    private Constants() {}
+}