Refactor computer: abstract computer-api from computer-core (#196)

* address comment * improve pom and options
apache · Nov 24, 2022 · 5320190 · 5320190
1 parent 7744295
commit 5320190
Show file tree

Hide file tree

Showing 53 changed files with 301 additions and 947 deletions.
diff --git a/computer-algorithm/pom.xml b/computer-algorithm/pom.xml
@@ -28,11 +28,10 @@
     <artifactId>computer-algorithm</artifactId>
 
     <dependencies>
-        <!-- TODO improve structure to only import computer-api -->
         <dependency>
             <groupId>com.baidu.hugegraph</groupId>
-            <artifactId>computer-core</artifactId>
-            <version>${project.version}</version>
+            <artifactId>computer-api</artifactId>
+            <version>${version}</version>
         </dependency>
         <dependency>
             <groupId>org.mvel</groupId>

diff --git a/...aidu/hugegraph/computer/algorithm/centrality/betweenness/BetweennessCentralityParams.java b/...aidu/hugegraph/computer/algorithm/centrality/betweenness/BetweennessCentralityParams.java
@@ -24,9 +24,7 @@
 import com.baidu.hugegraph.computer.algorithm.AlgorithmParams;
 import com.baidu.hugegraph.computer.algorithm.centrality.closeness.ClosenessCentrality;
 import com.baidu.hugegraph.computer.core.config.ComputerOptions;
-import com.baidu.hugegraph.computer.core.input.filter.ExtractAllPropertyInputFilter;
 import com.baidu.hugegraph.computer.core.master.DefaultMasterComputation;
-import com.baidu.hugegraph.computer.core.output.hg.HugeGraphDoubleOutput;
 
 public class BetweennessCentralityParams implements AlgorithmParams {
 
@@ -41,9 +39,9 @@ public void setAlgorithmParameters(Map<String, String> params) {
         this.setIfAbsent(params, ComputerOptions.ALGORITHM_MESSAGE_CLASS,
                          BetweennessMessage.class.getName());
         this.setIfAbsent(params, ComputerOptions.OUTPUT_CLASS,
-                         HugeGraphDoubleOutput.class.getName());
+                         HUGEGRAPH_DOUBLE_OUTPUT_CLASS_NAME);
         this.setIfAbsent(params, ComputerOptions.INPUT_FILTER_CLASS,
-                         ExtractAllPropertyInputFilter.class.getName());
+                         EXTRACTALLPROPERTYINPUTFILTER_CLASS_NAME);
         this.setIfAbsent(params, ClosenessCentrality.OPTION_SAMPLE_RATE,
                          "0.5D");
     }

diff --git a/...om/baidu/hugegraph/computer/algorithm/centrality/closeness/ClosenessCentralityParams.java b/...om/baidu/hugegraph/computer/algorithm/centrality/closeness/ClosenessCentralityParams.java
@@ -23,9 +23,7 @@
 
 import com.baidu.hugegraph.computer.algorithm.AlgorithmParams;
 import com.baidu.hugegraph.computer.core.config.ComputerOptions;
-import com.baidu.hugegraph.computer.core.input.filter.ExtractAllPropertyInputFilter;
 import com.baidu.hugegraph.computer.core.master.DefaultMasterComputation;
-import com.baidu.hugegraph.computer.core.output.hg.HugeGraphDoubleOutput;
 
 public class ClosenessCentralityParams implements AlgorithmParams {
 
@@ -40,9 +38,9 @@ public void setAlgorithmParameters(Map<String, String> params) {
         this.setIfAbsent(params, ComputerOptions.ALGORITHM_MESSAGE_CLASS,
                          ClosenessMessage.class.getName());
         this.setIfAbsent(params, ComputerOptions.OUTPUT_CLASS,
-                         HugeGraphDoubleOutput.class.getName());
+                         HUGEGRAPH_DOUBLE_OUTPUT_CLASS_NAME);
         this.setIfAbsent(params, ComputerOptions.INPUT_FILTER_CLASS,
-                         ExtractAllPropertyInputFilter.class.getName());
+                         EXTRACTALLPROPERTYINPUTFILTER_CLASS_NAME);
         this.setIfAbsent(params, ClosenessCentrality.OPTION_SAMPLE_RATE,
                          "0.5D");
     }

diff --git a/...in/java/com/baidu/hugegraph/computer/algorithm/centrality/closeness/ClosenessMessage.java b/...in/java/com/baidu/hugegraph/computer/algorithm/centrality/closeness/ClosenessMessage.java
@@ -23,8 +23,8 @@
 
 import com.baidu.hugegraph.computer.core.common.ComputerContext;
 import com.baidu.hugegraph.computer.core.graph.GraphFactory;
-import com.baidu.hugegraph.computer.core.graph.id.BytesId;
 import com.baidu.hugegraph.computer.core.graph.id.Id;
+import com.baidu.hugegraph.computer.core.graph.id.IdFactory;
 import com.baidu.hugegraph.computer.core.graph.value.DoubleValue;
 import com.baidu.hugegraph.computer.core.graph.value.Value.CustomizeValue;
 import com.baidu.hugegraph.computer.core.graph.value.ValueType;
@@ -40,7 +40,7 @@ public class ClosenessMessage implements CustomizeValue<ClosenessMessage> {
     private DoubleValue distance;
 
     public ClosenessMessage() {
-        this(new BytesId(), new BytesId(), new DoubleValue(0.0D));
+        this(IdFactory.createId(), IdFactory.createId(), new DoubleValue(0.0D));
     }
 
     public ClosenessMessage(Id senderId, Id startId, DoubleValue distance) {

diff --git a/...java/com/baidu/hugegraph/computer/algorithm/centrality/degree/DegreeCentralityParams.java b/...java/com/baidu/hugegraph/computer/algorithm/centrality/degree/DegreeCentralityParams.java
@@ -26,7 +26,6 @@
 import com.baidu.hugegraph.computer.core.config.ComputerOptions;
 import com.baidu.hugegraph.computer.core.graph.value.DoubleValue;
 import com.baidu.hugegraph.computer.core.master.DefaultMasterComputation;
-import com.baidu.hugegraph.computer.core.output.hg.HugeGraphDoubleOutput;
 
 public class DegreeCentralityParams implements AlgorithmParams {
 
@@ -43,6 +42,6 @@ public void setAlgorithmParameters(Map<String, String> params) {
         this.setIfAbsent(params, ComputerOptions.WORKER_COMBINER_CLASS,
                          DoubleValueSumCombiner.class.getName());
         this.setIfAbsent(params, ComputerOptions.OUTPUT_CLASS,
-                         HugeGraphDoubleOutput.class.getName());
+                         HUGEGRAPH_DOUBLE_OUTPUT_CLASS_NAME);
     }
 }
diff --git a/.../main/java/com/baidu/hugegraph/computer/algorithm/centrality/pagerank/PageRankParams.java b/.../main/java/com/baidu/hugegraph/computer/algorithm/centrality/pagerank/PageRankParams.java
@@ -25,7 +25,6 @@
 import com.baidu.hugegraph.computer.core.combiner.DoubleValueSumCombiner;
 import com.baidu.hugegraph.computer.core.config.ComputerOptions;
 import com.baidu.hugegraph.computer.core.graph.value.DoubleValue;
-import com.baidu.hugegraph.computer.core.output.hg.HugeGraphDoubleOutput;
 
 public class PageRankParams implements AlgorithmParams {
 
@@ -42,6 +41,6 @@ public void setAlgorithmParameters(Map<String, String> params) {
         this.setIfAbsent(params, ComputerOptions.WORKER_COMBINER_CLASS,
                          DoubleValueSumCombiner.class.getName());
         this.setIfAbsent(params, ComputerOptions.OUTPUT_CLASS,
-                         HugeGraphDoubleOutput.class.getName());
+                         HUGEGRAPH_DOUBLE_OUTPUT_CLASS_NAME);
     }
 }
diff --git a/...thm/src/main/java/com/baidu/hugegraph/computer/algorithm/community/kcore/KcoreParams.java b/...thm/src/main/java/com/baidu/hugegraph/computer/algorithm/community/kcore/KcoreParams.java
@@ -24,8 +24,6 @@
 import com.baidu.hugegraph.computer.algorithm.AlgorithmParams;
 import com.baidu.hugegraph.computer.core.combiner.ValueMinCombiner;
 import com.baidu.hugegraph.computer.core.config.ComputerOptions;
-import com.baidu.hugegraph.computer.core.graph.id.BytesId;
-import com.baidu.hugegraph.computer.core.output.hg.HugeGraphIdOutput;
 
 public class KcoreParams implements AlgorithmParams {
 
@@ -36,10 +34,10 @@ public void setAlgorithmParameters(Map<String, String> params) {
         this.setIfAbsent(params, ComputerOptions.ALGORITHM_RESULT_CLASS,
                          KcoreValue.class.getName());
         this.setIfAbsent(params, ComputerOptions.ALGORITHM_MESSAGE_CLASS,
-                         BytesId.class.getName());
+                         BYTESID_CLASS_NAME);
         this.setIfAbsent(params, ComputerOptions.WORKER_COMBINER_CLASS,
                          ValueMinCombiner.class.getName());
         this.setIfAbsent(params, ComputerOptions.OUTPUT_CLASS,
-                         HugeGraphIdOutput.class.getName());
+                         HUGEGRAPH_ID_OUTPUT_CLASS_NAME);
     }
 }
diff --git a/...ithm/src/main/java/com/baidu/hugegraph/computer/algorithm/community/kcore/KcoreValue.java b/...ithm/src/main/java/com/baidu/hugegraph/computer/algorithm/community/kcore/KcoreValue.java
@@ -22,13 +22,13 @@
 import java.io.IOException;
 
 import org.apache.commons.lang3.builder.ToStringBuilder;
+import org.apache.hugegraph.util.E;
 
-import com.baidu.hugegraph.computer.core.graph.id.BytesId;
 import com.baidu.hugegraph.computer.core.graph.id.Id;
+import com.baidu.hugegraph.computer.core.graph.id.IdFactory;
 import com.baidu.hugegraph.computer.core.graph.value.Value.CustomizeValue;
 import com.baidu.hugegraph.computer.core.io.RandomAccessInput;
 import com.baidu.hugegraph.computer.core.io.RandomAccessOutput;
-import org.apache.hugegraph.util.E;
 
 public class KcoreValue implements CustomizeValue<Object> {
 
@@ -37,7 +37,7 @@ public class KcoreValue implements CustomizeValue<Object> {
 
     public KcoreValue() {
         this.degree = 0;
-        this.core = new BytesId();
+        this.core = IdFactory.createId();
     }
 
     public void degree(int degree) {

diff --git a/...gorithm/src/main/java/com/baidu/hugegraph/computer/algorithm/community/lpa/LpaParams.java b/...gorithm/src/main/java/com/baidu/hugegraph/computer/algorithm/community/lpa/LpaParams.java
@@ -23,8 +23,6 @@
 
 import com.baidu.hugegraph.computer.algorithm.AlgorithmParams;
 import com.baidu.hugegraph.computer.core.config.ComputerOptions;
-import com.baidu.hugegraph.computer.core.graph.id.BytesId;
-import com.baidu.hugegraph.computer.core.output.hg.HugeGraphIdOutput;
 
 public class LpaParams implements AlgorithmParams {
 
@@ -33,10 +31,10 @@ public void setAlgorithmParameters(Map<String, String> params) {
         this.setIfAbsent(params, ComputerOptions.WORKER_COMPUTATION_CLASS,
                          Lpa.class.getName());
         this.setIfAbsent(params, ComputerOptions.ALGORITHM_RESULT_CLASS,
-                         BytesId.class.getName());
+                         BYTESID_CLASS_NAME);
         this.setIfAbsent(params, ComputerOptions.ALGORITHM_MESSAGE_CLASS,
-                         BytesId.class.getName());
+                         BYTESID_CLASS_NAME);
         this.setIfAbsent(params, ComputerOptions.OUTPUT_CLASS,
-                         HugeGraphIdOutput.class.getName());
+                         HUGEGRAPH_ID_OUTPUT_CLASS_NAME);
     }
 }
diff --git a/...a/com/baidu/hugegraph/computer/algorithm/community/trianglecount/TriangleCountParams.java b/...a/com/baidu/hugegraph/computer/algorithm/community/trianglecount/TriangleCountParams.java
@@ -25,7 +25,6 @@
 import com.baidu.hugegraph.computer.core.config.ComputerOptions;
 import com.baidu.hugegraph.computer.core.config.EdgeFrequency;
 import com.baidu.hugegraph.computer.core.graph.value.IdList;
-import com.baidu.hugegraph.computer.core.output.hg.HugeGraphIntOutput;
 
 public class TriangleCountParams implements AlgorithmParams {
 
@@ -38,7 +37,7 @@ public void setAlgorithmParameters(Map<String, String> params) {
         this.setIfAbsent(params, ComputerOptions.ALGORITHM_RESULT_CLASS,
                          TriangleCountValue.class.getName());
         this.setIfAbsent(params, ComputerOptions.OUTPUT_CLASS,
-                         HugeGraphIntOutput.class.getName());
+                         HUGEGRAPH_INT_OUTPUT_CLASS_NAME);
         this.setIfAbsent(params, ComputerOptions.INPUT_EDGE_FREQ.name(),
                          EdgeFrequency.SINGLE.name());
     }

diff --git a/...gorithm/src/main/java/com/baidu/hugegraph/computer/algorithm/community/wcc/WccParams.java b/...gorithm/src/main/java/com/baidu/hugegraph/computer/algorithm/community/wcc/WccParams.java
@@ -24,8 +24,6 @@
 import com.baidu.hugegraph.computer.algorithm.AlgorithmParams;
 import com.baidu.hugegraph.computer.core.combiner.ValueMinCombiner;
 import com.baidu.hugegraph.computer.core.config.ComputerOptions;
-import com.baidu.hugegraph.computer.core.graph.id.BytesId;
-import com.baidu.hugegraph.computer.core.output.hg.HugeGraphIdOutput;
 
 public class WccParams implements AlgorithmParams {
 
@@ -34,12 +32,12 @@ public void setAlgorithmParameters(Map<String, String> params) {
         this.setIfAbsent(params, ComputerOptions.WORKER_COMPUTATION_CLASS,
                          Wcc.class.getName());
         this.setIfAbsent(params, ComputerOptions.ALGORITHM_RESULT_CLASS,
-                         BytesId.class.getName());
+                         BYTESID_CLASS_NAME);
         this.setIfAbsent(params, ComputerOptions.ALGORITHM_MESSAGE_CLASS,
-                         BytesId.class.getName());
+                         BYTESID_CLASS_NAME);
         this.setIfAbsent(params, ComputerOptions.WORKER_COMBINER_CLASS,
                          ValueMinCombiner.class.getName());
         this.setIfAbsent(params, ComputerOptions.OUTPUT_CLASS,
-                         HugeGraphIdOutput.class.getName());
+                         HUGEGRAPH_ID_OUTPUT_CLASS_NAME);
     }
 }
diff --git a/.../baidu/hugegraph/computer/algorithm/path/rings/filter/RingsDetectionWithFilterParams.java b/.../baidu/hugegraph/computer/algorithm/path/rings/filter/RingsDetectionWithFilterParams.java
@@ -25,7 +25,6 @@
 import com.baidu.hugegraph.computer.algorithm.path.rings.RingsDetectionOutput;
 import com.baidu.hugegraph.computer.core.config.ComputerOptions;
 import com.baidu.hugegraph.computer.core.graph.value.IdListList;
-import com.baidu.hugegraph.computer.core.input.filter.ExtractAllPropertyInputFilter;
 
 public class RingsDetectionWithFilterParams implements AlgorithmParams {
 
@@ -40,6 +39,6 @@ public void setAlgorithmParameters(Map<String, String> params) {
         this.setIfAbsent(params, ComputerOptions.OUTPUT_CLASS,
                          RingsDetectionOutput.class.getName());
         this.setIfAbsent(params, ComputerOptions.INPUT_FILTER_CLASS,
-                         ExtractAllPropertyInputFilter.class.getName());
+                         EXTRACTALLPROPERTYINPUTFILTER_CLASS_NAME);
     }
 }
diff --git a/computer-api/pom.xml b/computer-api/pom.xml
@@ -28,6 +28,11 @@
     <artifactId>computer-api</artifactId>
 
     <dependencies>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+            <version>${commons-lang3-version}</version>
+        </dependency>
         <dependency>
             <groupId>org.apache.hugegraph</groupId>
             <artifactId>hugegraph-client</artifactId>

diff --git a/computer-api/src/main/java/com/baidu/hugegraph/computer/algorithm/AlgorithmParams.java b/computer-api/src/main/java/com/baidu/hugegraph/computer/algorithm/AlgorithmParams.java
@@ -19,17 +19,41 @@
 
 package com.baidu.hugegraph.computer.algorithm;
 
-import java.util.Map;
+import static com.baidu.hugegraph.computer.core.config.ComputerOptions.COMPUTER_PROHIBIT_USER_OPTIONS;
 
-import org.slf4j.Logger;
+import java.util.Map;
 
 import org.apache.hugegraph.config.ConfigOption;
 import org.apache.hugegraph.util.Log;
+import org.slf4j.Logger;
 
 public interface AlgorithmParams {
 
     Logger LOG = Log.logger(AlgorithmParams.class);
 
+    String BYTESID_CLASS_NAME = "com.baidu.hugegraph.computer.core.graph.id.BytesId";
+    String HUGEGRAPH_ID_OUTPUT_CLASS_NAME = "com.baidu.hugegraph.computer.core" +
+                                            ".output.hg.HugeGraphIdOutput";
+    String LOG_OUTPUT_CLASS_NAME = "com.baidu.hugegraph.computer.core.output.LogOutput";
+    String HUGEGRAPH_DOUBLE_OUTPUT_CLASS_NAME = "com.baidu.hugegraph.computer.core" +
+                                                ".output.hg.HugeGraphDoubleOutput";
+    String HUGEGRAPH_FLOAT_OUTPUT_CLASS_NAME = "com.baidu.hugegraph.computer.core" +
+                                               ".output.hg.HugeGraphFloatOutput";
+    String HUGEGRAPH_INT_OUTPUT_CLASS_NAME = "com.baidu.hugegraph.computer.core" +
+                                             ".output.hg.HugeGraphIntOutput";
+    String HUGEGRAPH_LONG_OUTPUT_CLASS_NAME = "com.baidu.hugegraph.computer.core" +
+                                              ".output.hg.HugeGraphLongOutput";
+    String HUGEGRAPH_STRING_OUTPUT_CLASS_NAME = "com.baidu.hugegraph.computer.core" +
+                                                ".output.hg.HugeGraphStringOutput";
+    String HUGEGRAPH_LIST_OUTPUT_CLASS_NAME = "com.baidu.hugegraph.computer.core" +
+                                                ".output.hg.HugeGraphListOutput";
+    String DEFAULTINPUTFILTER_CLASS_NAME = "com.baidu.hugegraph.computer" +
+                                           ".core.input.filter" +
+                                           ".DefaultInputFilter";
+    String EXTRACTALLPROPERTYINPUTFILTER_CLASS_NAME = "com.baidu.hugegraph.computer" +
+                                                      ".core.input.filter" +
+                                                      ".ExtractAllPropertyInputFilter";
+
     /**
      * set algorithm's specific configuration
      * @param params
@@ -38,7 +62,7 @@ public interface AlgorithmParams {
 
     default void setIfAbsent(Map<String, String> params, String key,
                              String value) {
-        if (!params.keySet().contains(key)) {
+        if (!params.containsKey(key) && !COMPUTER_PROHIBIT_USER_OPTIONS.contains(key)) {
             LOG.debug("Put parameters key={}, value={}", key, value);
             params.put(key, value);
         }