Move LabelInformation.Builder factory methods out of the interface

vnickolov · vnickolov · commit ae6b81eda5cd · 2022-12-01T05:22:16.000Z
diff --git a/algo/src/test/java/org/neo4j/gds/embeddings/fastrp/FastRPTest.java b/algo/src/test/java/org/neo4j/gds/embeddings/fastrp/FastRPTest.java
@@ -40,7 +40,7 @@
 import org.neo4j.gds.core.ImmutableGraphDimensions;
 import org.neo4j.gds.core.concurrency.Pools;
 import org.neo4j.gds.core.loading.ArrayIdMap;
-import org.neo4j.gds.core.loading.LabelInformation;
+import org.neo4j.gds.core.loading.LabelInformationBuilders;
 import org.neo4j.gds.core.loading.construction.GraphFactory;
 import org.neo4j.gds.core.loading.construction.RelationshipsBuilder;
 import org.neo4j.gds.core.utils.Intersections;
@@ -635,7 +635,7 @@ void shouldBeDeterministicGivenSameOriginalIds() {
         var firstIdMap = new ArrayIdMap(
             firstMappedToOriginal,
             firstOriginalToMappedBuilder.build(),
-            LabelInformation.single(new NodeLabel("hello")).build(nodeCount, firstMappedToOriginal::get),
+            LabelInformationBuilders.singleLabel(NodeLabel.of("hello")).build(nodeCount, firstMappedToOriginal::get),
             nodeCount,
             nodeCount - 1
         );
@@ -658,7 +658,7 @@ void shouldBeDeterministicGivenSameOriginalIds() {
         var secondIdMap = new ArrayIdMap(
             secondMappedToOriginal,
             secondOriginalToMappedBuilder.build(),
-            LabelInformation.single(new NodeLabel("hello")).build(nodeCount, secondMappedToOriginal::get),
+            LabelInformationBuilders.singleLabel(NodeLabel.of("hello")).build(nodeCount, secondMappedToOriginal::get),
             nodeCount,
             nodeCount - 1
         );
diff --git a/algo/src/test/java/org/neo4j/gds/embeddings/hashgnn/HashGNNTest.java b/algo/src/test/java/org/neo4j/gds/embeddings/hashgnn/HashGNNTest.java
@@ -36,7 +36,7 @@
 import org.neo4j.gds.compat.TestLog;
 import org.neo4j.gds.core.concurrency.Pools;
 import org.neo4j.gds.core.loading.ArrayIdMap;
-import org.neo4j.gds.core.loading.LabelInformation;
+import org.neo4j.gds.core.loading.LabelInformationBuilders;
 import org.neo4j.gds.core.loading.construction.GraphFactory;
 import org.neo4j.gds.core.loading.construction.RelationshipsBuilder;
 import org.neo4j.gds.core.utils.Intersections;
@@ -366,7 +366,7 @@ void shouldBeDeterministicGivenSameOriginalIds() {
         var firstIdMap = new ArrayIdMap(
             firstMappedToOriginal,
             firstOriginalToMappedBuilder.build(),
-            LabelInformation.single(new NodeLabel("hello")).build(nodeCount, firstMappedToOriginal::get),
+            LabelInformationBuilders.singleLabel(new NodeLabel("hello")).build(nodeCount, firstMappedToOriginal::get),
             nodeCount,
             nodeCount - 1
         );
@@ -389,7 +389,7 @@ void shouldBeDeterministicGivenSameOriginalIds() {
         var secondIdMap = new ArrayIdMap(
             secondMappedToOriginal,
             secondOriginalToMappedBuilder.build(),
-            LabelInformation.single(new NodeLabel("hello")).build(nodeCount, secondMappedToOriginal::get),
+            LabelInformationBuilders.singleLabel(NodeLabel.of("hello")).build(nodeCount, secondMappedToOriginal::get),
             nodeCount,
             nodeCount - 1
         );
diff --git a/algo/src/test/java/org/neo4j/gds/embeddings/node2vec/Node2VecTest.java b/algo/src/test/java/org/neo4j/gds/embeddings/node2vec/Node2VecTest.java
@@ -45,7 +45,7 @@
 import org.neo4j.gds.core.GraphDimensions;
 import org.neo4j.gds.core.concurrency.Pools;
 import org.neo4j.gds.core.loading.ArrayIdMap;
-import org.neo4j.gds.core.loading.LabelInformation;
+import org.neo4j.gds.core.loading.LabelInformationBuilders;
 import org.neo4j.gds.core.loading.construction.GraphFactory;
 import org.neo4j.gds.core.loading.construction.RelationshipsBuilder;
 import org.neo4j.gds.core.utils.Intersections;
@@ -271,7 +271,7 @@ void shouldBeFairlyConsistentUnderOriginalIds(EmbeddingInitializer embeddingInit
         var firstIdMap = new ArrayIdMap(
             firstMappedToOriginal,
             firstOriginalToMappedBuilder.build(),
-            LabelInformation.single(new NodeLabel("hello")).build(nodeCount, firstMappedToOriginal::get),
+            LabelInformationBuilders.singleLabel(NodeLabel.of("hello")).build(nodeCount, firstMappedToOriginal::get),
             nodeCount,
             nodeCount - 1
         );
@@ -292,7 +292,7 @@ void shouldBeFairlyConsistentUnderOriginalIds(EmbeddingInitializer embeddingInit
         var secondIdMap = new ArrayIdMap(
             secondMappedToOriginal,
             secondOriginalToMappedBuilder.build(),
-            LabelInformation.single(new NodeLabel("hello")).build(nodeCount, secondMappedToOriginal::get),
+            LabelInformationBuilders.singleLabel(NodeLabel.of("hello")).build(nodeCount, secondMappedToOriginal::get),
             nodeCount,
             nodeCount - 1
         );
diff --git a/algo/src/test/java/org/neo4j/gds/similarity/filtering/NodeFilterTest.java b/algo/src/test/java/org/neo4j/gds/similarity/filtering/NodeFilterTest.java
@@ -25,7 +25,7 @@
 import org.neo4j.gds.NodeLabel;
 import org.neo4j.gds.core.huge.DirectIdMap;
 import org.neo4j.gds.core.loading.ArrayIdMapBuilder;
-import org.neo4j.gds.core.loading.LabelInformation;
+import org.neo4j.gds.core.loading.LabelInformationBuilders;
 
 import java.util.Collections;
 import java.util.List;
@@ -45,7 +45,7 @@ void shouldFilterBasedOnLabel() {
         labelTokenNodeLabelMappings.put(1, Collections.singletonList(labelOne));
         labelTokenNodeLabelMappings.put(2, Collections.singletonList(labelTwo));
 
-        var labelInformationBuilder = LabelInformation.builder(4, labelTokenNodeLabelMappings);
+        var labelInformationBuilder = LabelInformationBuilders.multiLabelWithCapacityAndLabelInformation(4, labelTokenNodeLabelMappings);
         labelInformationBuilder.addNodeIdToLabel(labelOne, 0);
         labelInformationBuilder.addNodeIdToLabel(labelTwo, 1);
         labelInformationBuilder.addNodeIdToLabel(labelOne, 2);
diff --git a/core/src/main/java/org/neo4j/gds/core/loading/LabelInformation.java b/core/src/main/java/org/neo4j/gds/core/loading/LabelInformation.java
@@ -20,7 +20,6 @@
 package org.neo4j.gds.core.loading;
 
 import com.carrotsearch.hppc.BitSet;
-import com.carrotsearch.hppc.IntObjectMap;
 import org.neo4j.gds.NodeLabel;
 import org.neo4j.gds.api.IdMap;
 
@@ -31,20 +30,6 @@
 import java.util.function.LongUnaryOperator;
 
 public interface LabelInformation {
-    static Builder single(NodeLabel singleLabel) {
-        return new SingleLabelInformation.Builder(singleLabel);
-    }
-
-    static Builder builder(long expectedCapacity) {
-        return MultiLabelInformation.Builder.of(expectedCapacity);
-    }
-
-    static Builder builder(
-        long expectedCapacity,
-        IntObjectMap<List<NodeLabel>> labelTokenNodeLabelMapping
-    ) {
-        return MultiLabelInformation.Builder.of(expectedCapacity, labelTokenNodeLabelMapping);
-    }
 
     boolean isEmpty();
 
diff --git a/core/src/main/java/org/neo4j/gds/core/loading/LabelInformationBuilders.java b/core/src/main/java/org/neo4j/gds/core/loading/LabelInformationBuilders.java
@@ -0,0 +1,49 @@
+/*
+ * 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;
+
+import com.carrotsearch.hppc.IntObjectMap;
+import org.neo4j.gds.NodeLabel;
+
+import java.util.List;
+
+public final class LabelInformationBuilders {
+
+    private LabelInformationBuilders() {}
+
+    public static LabelInformation.Builder allNodes() {
+        return new SingleLabelInformation.Builder(NodeLabel.ALL_NODES);
+    }
+
+    public static LabelInformation.Builder singleLabel(NodeLabel singleLabel) {
+        return new SingleLabelInformation.Builder(singleLabel);
+    }
+
+    public static LabelInformation.Builder multiLabelWithCapacity(long expectedCapacity) {
+        return MultiLabelInformation.Builder.of(expectedCapacity);
+    }
+
+    public static LabelInformation.Builder multiLabelWithCapacityAndLabelInformation(
+        long expectedCapacity,
+        IntObjectMap<List<NodeLabel>> labelTokenNodeLabelMapping
+    ) {
+        return MultiLabelInformation.Builder.of(expectedCapacity, labelTokenNodeLabelMapping);
+    }
+}
diff --git a/core/src/main/java/org/neo4j/gds/core/loading/ScanningNodesImporter.java b/core/src/main/java/org/neo4j/gds/core/loading/ScanningNodesImporter.java
@@ -78,9 +78,9 @@ public static ScanningNodesImporter scanningNodesImporter(
         LabelInformation.Builder labelInformationBuilder;
         if (graphProjectConfig.nodeProjections().allProjections().size() == 1) {
             var singleLabel = graphProjectConfig.nodeProjections().projections().keySet().iterator().next();
-            labelInformationBuilder = LabelInformation.single(singleLabel);
+            labelInformationBuilder = LabelInformationBuilders.singleLabel(singleLabel);
         } else {
-            labelInformationBuilder = LabelInformation.builder(expectedCapacity, labelTokenNodeLabelMapping);
+            labelInformationBuilder = LabelInformationBuilders.multiLabelWithCapacityAndLabelInformation(expectedCapacity, labelTokenNodeLabelMapping);
         }
 
         var propertyMappings = IndexPropertyMappings.prepareProperties(
diff --git a/core/src/main/java/org/neo4j/gds/core/loading/construction/NodesBuilder.java b/core/src/main/java/org/neo4j/gds/core/loading/construction/NodesBuilder.java
@@ -31,6 +31,7 @@
 import org.neo4j.gds.core.concurrency.ParallelUtil;
 import org.neo4j.gds.core.loading.IdMapBuilder;
 import org.neo4j.gds.core.loading.LabelInformation;
+import org.neo4j.gds.core.loading.LabelInformationBuilders;
 import org.neo4j.gds.core.loading.NodeImporter;
 import org.neo4j.gds.core.loading.NodesBatchBuffer;
 import org.neo4j.gds.core.loading.NodesBatchBufferBuilder;
@@ -97,8 +98,8 @@ public final class NodesBuilder {
         this.elementIdentifierLabelTokenMapping = elementIdentifierLabelTokenMapping;
         this.idMapBuilder = idMapBuilder;
         this.labelInformationBuilder = !hasLabelInformation
-            ? LabelInformation.single(NodeLabel.ALL_NODES)
-            : LabelInformation.builder(maxOriginalId + 1);
+            ? LabelInformationBuilders.allNodes()
+            : LabelInformationBuilders.multiLabelWithCapacity(maxOriginalId + 1);
         this.labelTokenNodeLabelMapping = labelTokenNodeLabelMapping;
         this.nextLabelId = 0;
         this.lock = new ReentrantLock(true);
diff --git a/core/src/test/java/org/neo4j/gds/core/loading/ArrayIdMapTest.java b/core/src/test/java/org/neo4j/gds/core/loading/ArrayIdMapTest.java
@@ -102,7 +102,7 @@ void shouldStoreCorrectHighestNeoId() {
         int length = 1337;
         int highestNeoId = length - 1;
         var arrayIdMapBuilder = ArrayIdMapBuilder.of(length);
-        var emptyLabelInformationBuilder = LabelInformation.single(NodeLabel.ALL_NODES);
+        var emptyLabelInformationBuilder = LabelInformationBuilders.allNodes();
         var hugeIdMap = ArrayIdMapBuilderOps.build(
             arrayIdMapBuilder.array(),
             length,
diff --git a/core/src/test/java/org/neo4j/gds/core/loading/LabelInformationTest.java b/core/src/test/java/org/neo4j/gds/core/loading/LabelInformationTest.java
@@ -98,7 +98,7 @@ private void testLabelAssignment(Collection<Long> nodeIds, LongUnaryOperator nod
 
     private LabelInformation buildLabelInformation(Collection<Long> nodeIds, LongUnaryOperator nodeIdMap, LabelProducer labelProducer) {
         var nodeCount = nodeIds.size();
-        var builder = LabelInformation.builder(nodeCount, new IntObjectHashMap<>());
+        var builder = LabelInformationBuilders.multiLabelWithCapacityAndLabelInformation(nodeCount, new IntObjectHashMap<>());
 
         for (var nodeId : nodeIds) {
             for (NodeLabel nodeLabel : labelProducer.get(nodeId)) {
diff --git a/test-utils/src/main/java/org/neo4j/gds/core/idmap/IdMapBuilderTest.java b/test-utils/src/main/java/org/neo4j/gds/core/idmap/IdMapBuilderTest.java
@@ -31,9 +31,9 @@
 import org.neo4j.gds.core.concurrency.ParallelUtil;
 import org.neo4j.gds.core.concurrency.Pools;
 import org.neo4j.gds.core.loading.IdMapBuilder;
-import org.neo4j.gds.core.loading.LabelInformation;
-import org.neo4j.gds.mem.HugeArrays;
+import org.neo4j.gds.core.loading.LabelInformationBuilders;
 import org.neo4j.gds.core.utils.partition.PartitionUtils;
+import org.neo4j.gds.mem.HugeArrays;
 
 import java.util.Arrays;
 import java.util.HashMap;
@@ -243,7 +243,7 @@ void testBuildParallel(
 
         ParallelUtil.run(tasks, Pools.DEFAULT);
 
-        var idMap = idMapBuilder.build(LabelInformation.single(NodeLabel.ALL_NODES), highestOriginalId, concurrency);
+        var idMap = idMapBuilder.build(LabelInformationBuilders.allNodes(), highestOriginalId, concurrency);
 
         assertThat(idMap.nodeCount()).as("node count").isEqualTo(nodeCount);
         assertThat(idMap.highestOriginalId()).as("highest original id").isEqualTo(highestOriginalId);
@@ -329,12 +329,12 @@ private IdMapAndHighestId buildFromWithLabels(
         idMapAllocator.insert(originalIds);
 
         var labelInformationBuilder = labelFn.map(lFn -> {
-            var multiLabelBuilder = LabelInformation.builder(originalIds.length);
+            var multiLabelBuilder = LabelInformationBuilders.multiLabelWithCapacity(originalIds.length);
             for (long originalNodeId : originalIds) {
                 lFn.apply(originalNodeId).forEach(label -> multiLabelBuilder.addNodeIdToLabel(label, originalNodeId));
             }
             return multiLabelBuilder;
-        }).orElseGet(() -> LabelInformation.single(NodeLabel.ALL_NODES));
+        }).orElseGet(LabelInformationBuilders::allNodes);
 
         return ImmutableIdMapAndHighestId.builder()
             .idMap(builder.build(labelInformationBuilder, highestOriginalId, concurrency))
diff --git a/test-utils/src/main/java/org/neo4j/gds/core/loading/TestIdMap.java b/test-utils/src/main/java/org/neo4j/gds/core/loading/TestIdMap.java
@@ -98,7 +98,7 @@ public static final class Builder {
         public Builder() {
             this.forwardMap = new LongLongHashMap();
             this.reverseMap = new LongLongHashMap();
-            this.labelInformationBuilder = LabelInformation.builder(42);
+            this.labelInformationBuilder = LabelInformationBuilders.multiLabelWithCapacity(42);
         }
 
         public Builder addAll(long... mappings) {
