Add kmeans to business facade

Author: IoannisPanagiotas

algorithms-compute-business-facade/src/main/java/org/neo4j/gds/community/CommunityComputeBusinessFacade.java

@@ -23,6 +23,7 @@
 import org.neo4j.gds.api.DatabaseId;
 import org.neo4j.gds.api.GraphName;
 import org.neo4j.gds.api.User;
+import org.neo4j.gds.api.nodeproperties.ValueType;
 import org.neo4j.gds.approxmaxkcut.ApproxMaxKCutParameters;
 import org.neo4j.gds.approxmaxkcut.ApproxMaxKCutResult;
 import org.neo4j.gds.cliqueCounting.CliqueCountingResult;
@@ -34,16 +35,20 @@
 import org.neo4j.gds.core.loading.GraphStoreCatalogService;
 import org.neo4j.gds.core.loading.validation.NoAlgorithmValidation;
 import org.neo4j.gds.core.loading.validation.NodePropertyAnyExistsGraphStoreValidation;
+import org.neo4j.gds.core.loading.validation.NodePropertyTypeGraphStoreValidation;
 import org.neo4j.gds.core.loading.validation.UndirectedOnlyGraphStoreValidation;
 import org.neo4j.gds.hdbscan.HDBScanParameters;
 import org.neo4j.gds.hdbscan.Labels;
 import org.neo4j.gds.k1coloring.K1ColoringParameters;
 import org.neo4j.gds.k1coloring.K1ColoringResult;
 import org.neo4j.gds.kcore.KCoreDecompositionParameters;
 import org.neo4j.gds.kcore.KCoreDecompositionResult;
+import org.neo4j.gds.kmeans.KmeansParameters;
+import org.neo4j.gds.kmeans.KmeansResult;
 import org.neo4j.gds.result.TimedAlgorithmResult;
 import org.neo4j.gds.results.ResultTransformerBuilder;
 
+import java.util.List;
 import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
 
@@ -249,4 +254,34 @@ public <TR> CompletableFuture<TR> kCoreDecomposition(
         ).thenApply(resultTransformerBuilder.build(graphResources));
     }
 
+    public <TR> CompletableFuture<TR> kMeans(
+        GraphName graphName,
+        GraphParameters graphParameters,
+        Optional<String> relationshipProperty,
+        KmeansParameters parameters,
+        JobId jobId,
+        boolean logProgress,
+        ResultTransformerBuilder<TimedAlgorithmResult<KmeansResult>, TR> resultTransformerBuilder
+    ) {
+        // Fetch the Graph the algorithm will operate on
+        var graphResources = graphStoreCatalogService.fetchGraphResources(
+            graphName,
+            graphParameters,
+            relationshipProperty,
+            new NodePropertyTypeGraphStoreValidation("nodeProperty", List.of(ValueType.DOUBLE_ARRAY, ValueType.FLOAT_ARRAY,ValueType.DOUBLE)),
+            Optional.empty(),
+            user,
+            databaseId
+        );
+        var graph = graphResources.graph();
+
+        return computeFacade.kMeans(
+            graph,
+            parameters,
+            jobId,
+            logProgress
+
+        ).thenApply(resultTransformerBuilder.build(graphResources));
+    }
+
 }

algorithms-compute-business-facade/src/main/java/org/neo4j/gds/pathfinding/validation/PCSTGraphStoreValidation.java

@@ -25,24 +25,26 @@
 import org.neo4j.gds.api.nodeproperties.ValueType;
 import org.neo4j.gds.core.loading.validation.GraphStoreValidation;
 import org.neo4j.gds.core.loading.validation.NodePropertyAllExistsGraphStoreValidation;
+import org.neo4j.gds.core.loading.validation.NodePropertyTypeGraphStoreValidation;
 import org.neo4j.gds.core.loading.validation.UndirectedOnlyGraphStoreValidation;
-import org.neo4j.gds.utils.StringFormatting;
 
 import java.util.Collection;
+import java.util.List;
 
 public class PCSTGraphStoreValidation extends GraphStoreValidation {
 
-    private final String prizeProperty;
     private final UndirectedOnlyGraphStoreValidation undirectedOnlyGraphStoreValidation;
     private final NodePropertyAllExistsGraphStoreValidation nodePropertyAllExistsGraphStoreValidation;
+    private final NodePropertyTypeGraphStoreValidation nodePropertyTypeGraphStoreValidation;
 
 
     public PCSTGraphStoreValidation(
-        String prizeProperty,
         UndirectedOnlyGraphStoreValidation undirectedOnlyGraphStoreValidation,
-        NodePropertyAllExistsGraphStoreValidation nodePropertyAllExistsGraphStoreValidation
+        NodePropertyAllExistsGraphStoreValidation nodePropertyAllExistsGraphStoreValidation,
+        NodePropertyTypeGraphStoreValidation nodePropertyTypeGraphStoreValidation
     ) {
-        this.prizeProperty = prizeProperty;
+        this.nodePropertyTypeGraphStoreValidation = nodePropertyTypeGraphStoreValidation;
+        ;
         this.undirectedOnlyGraphStoreValidation = undirectedOnlyGraphStoreValidation;
         this.nodePropertyAllExistsGraphStoreValidation = nodePropertyAllExistsGraphStoreValidation;
     }
@@ -51,12 +53,14 @@ public static PCSTGraphStoreValidation create(String prizeProperty) {
 
         var nodePropertyAllExistsGraphStoreValidation = new NodePropertyAllExistsGraphStoreValidation(prizeProperty);
         var undirectedOnlyGraphStoreValidation = new UndirectedOnlyGraphStoreValidation("Prize-collecting Steiner Tree");
-
-        return new PCSTGraphStoreValidation(
+        var nodePropertyTypeGraphStoreValidation = new NodePropertyTypeGraphStoreValidation(
             prizeProperty,
+            List.of(ValueType.DOUBLE)
+        );
+        return new PCSTGraphStoreValidation(
             undirectedOnlyGraphStoreValidation,
-            nodePropertyAllExistsGraphStoreValidation
-
+            nodePropertyAllExistsGraphStoreValidation,
+            nodePropertyTypeGraphStoreValidation
         );
     }
 
@@ -68,22 +72,10 @@ protected void validateAlgorithmRequirements(
     ) {
         undirectedOnlyGraphStoreValidation.validateAlgorithmRequirements(graphStore,selectedLabels,selectedRelationshipTypes);
         nodePropertyAllExistsGraphStoreValidation.validateAlgorithmRequirements(graphStore,selectedLabels,selectedRelationshipTypes);
-        validatePropertyType(graphStore);
+        nodePropertyTypeGraphStoreValidation.validateAlgorithmRequirements(graphStore,selectedLabels,selectedRelationshipTypes);
     }
 
 
-    void validatePropertyType(GraphStore graphStore){
-        var valueType = graphStore.nodeProperty(prizeProperty).valueType();
-        if (valueType == ValueType.DOUBLE) {
-            return;
-        }
-        throw new IllegalArgumentException(
-            StringFormatting.formatWithLocale(
-                "Unsupported node property value type [%s]. Value type required: [%s]",
-                valueType,
-                ValueType.DOUBLE
-            )
-        );
-    }
+
 
 }

core/src/main/java/org/neo4j/gds/core/loading/validation/NodePropertyTypeGraphStoreValidation.java

@@ -0,0 +1,67 @@
+/*
+ * 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.core.loading.validation;
+
+import org.neo4j.gds.NodeLabel;
+import org.neo4j.gds.RelationshipType;
+import org.neo4j.gds.api.GraphStore;
+import org.neo4j.gds.api.nodeproperties.ValueType;
+import org.neo4j.gds.utils.StringFormatting;
+import org.neo4j.gds.utils.StringJoining;
+
+import java.util.Collection;
+import java.util.List;
+
+public class NodePropertyTypeGraphStoreValidation extends  GraphStoreValidation {
+    private final String nodeProperty;
+    private final List<ValueType> allowedValueTypes;
+
+    public NodePropertyTypeGraphStoreValidation(String nodeProperty, List<ValueType> allowedValueTypes) {
+        this.nodeProperty = nodeProperty;
+        this.allowedValueTypes = allowedValueTypes;
+    }
+
+    @Override
+    public void validateAlgorithmRequirements(
+        GraphStore graphStore,
+        Collection<NodeLabel> selectedLabels,
+        Collection<RelationshipType> selectedRelationshipTypes
+    ) {
+        validatePropertyType(graphStore);
+
+    }
+
+    void validatePropertyType(GraphStore graphStore){
+        var valueType = graphStore.nodeProperty(nodeProperty).valueType();
+        for (var currentValueType : allowedValueTypes){
+            if (valueType == currentValueType) {
+                return;
+            }
+        }
+        throw new IllegalArgumentException(
+            StringFormatting.formatWithLocale(
+                "Unsupported node property value type for property `%s`: %s. Value types accepted: %s",
+                nodeProperty,
+                valueType,
+                StringJoining.join(allowedValueTypes.stream().map(Enum::name))
+            )
+        );
+    }
+}

…dation/PCSTGraphStoreValidationTest.java …ropertyTypeGraphStoreValidationTest.javaprocedures/pushback-procedures-facade/src/test/java/org/neo4j/gds/pathfinding/validation/PCSTGraphStoreValidationTest.java renamed to core/src/test/java/org/neo4j/gds/core/loading/validation/NodePropertyTypeGraphStoreValidationTest.java procedures/pushback-procedures-facade/src/test/java/org/neo4j/gds/pathfinding/validation/PCSTGraphStoreValidationTest.java renamed to core/src/test/java/org/neo4j/gds/core/loading/validation/NodePropertyTypeGraphStoreValidationTest.java

@@ -17,20 +17,22 @@
  * 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.pathfinding.validation;
+package org.neo4j.gds.core.loading.validation;
 
 import org.junit.jupiter.api.Test;
 import org.neo4j.gds.api.GraphStore;
 import org.neo4j.gds.api.nodeproperties.ValueType;
 import org.neo4j.gds.api.properties.nodes.NodeProperty;
 
+import java.util.List;
+
 import static org.assertj.core.api.Assertions.assertThatNoException;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
 
-class PCSTGraphStoreValidationTest {
+class NodePropertyTypeGraphStoreValidationTest {
 
     @Test
     void shouldNotThrowForValidPropertyType() {
@@ -39,7 +41,7 @@ void shouldNotThrowForValidPropertyType() {
         when(nodeProperty.valueType()).thenReturn(ValueType.DOUBLE);
         when(graphStore.nodeProperty(anyString())).thenReturn(nodeProperty);
 
-        var validation = PCSTGraphStoreValidation.create("p");
+        var validation = new NodePropertyTypeGraphStoreValidation("p", List.of(ValueType.DOUBLE));
 
         assertThatNoException().isThrownBy(() -> validation.validatePropertyType(
             graphStore
@@ -55,13 +57,12 @@ void shouldThrowForInvalidType() {
         when(nodeProperty.valueType()).thenReturn(ValueType.FLOAT_ARRAY);
         when(graphStore.nodeProperty(anyString())).thenReturn(nodeProperty);
 
-
-        var validation = PCSTGraphStoreValidation.create("p");
+        var validation = new NodePropertyTypeGraphStoreValidation("p", List.of(ValueType.DOUBLE, ValueType.LONG));
 
         assertThatThrownBy(() -> validation.validatePropertyType(
             graphStore
         ))
-            .hasMessageContaining("Unsupported node property value type [FLOAT_ARRAY]. Value type required: [DOUBLE]");
+            .hasMessageContaining("Unsupported node property value type for property `p`: FLOAT_ARRAY. Value types accepted: ['DOUBLE', 'LONG']");
 
     }