refactor orderingKey (#130)

Author: daleiz

client/src/main/java/io/hstream/BufferedProducerBuilder.java

@@ -6,8 +6,8 @@ public interface BufferedProducerBuilder {
   BufferedProducerBuilder stream(String streamName);
 
   /**
-   * BufferedProducer will buffer records for each ordering key as a batch to send to servers, so
-   * {@link BatchSetting} is to control the batch buffer.
+   * BufferedProducer will buffer records for each shard as a batch to send to servers, so {@link
+   * BatchSetting} is to control the batch buffer.
    *
    * @param batchSetting setting for batch buffer
    * @return the BufferedProducerBuilder instance

client/src/main/java/io/hstream/Record.java

@@ -4,7 +4,7 @@
 
 public class Record {
 
-  private String orderingKey;
+  private String partitionKey;
   private byte[] rawRecord;
   private HRecord hRecord;
   private boolean isRawRecord;
@@ -13,24 +13,24 @@ public static Builder newBuilder() {
     return new Builder();
   }
 
-  private Record(String orderingKey, byte[] rawRecord) {
+  private Record(String partitionKey, byte[] rawRecord) {
     isRawRecord = true;
-    this.orderingKey = orderingKey;
+    this.partitionKey = partitionKey;
     this.rawRecord = rawRecord;
   }
 
-  private Record(String orderingKey, HRecord hRecord) {
+  private Record(String partitionKey, HRecord hRecord) {
     isRawRecord = false;
-    this.orderingKey = orderingKey;
+    this.partitionKey = partitionKey;
     this.hRecord = hRecord;
   }
 
-  public String getOrderingKey() {
-    return orderingKey;
+  public String getPartitionKey() {
+    return partitionKey;
   }
 
-  public void setOrderingKey(String orderingKey) {
-    this.orderingKey = orderingKey;
+  public void setPartitionKey(String partitionKey) {
+    this.partitionKey = partitionKey;
   }
 
   public byte[] getRawRecord() {
@@ -48,12 +48,12 @@ public boolean isRawRecord() {
   }
 
   public static class Builder {
-    private String orderingKey;
+    private String partitionKey;
     private byte[] rawRecord;
     private HRecord hRecord;
 
-    public Builder orderingKey(String key) {
-      this.orderingKey = key;
+    public Builder partitionKey(String partitionKey) {
+      this.partitionKey = partitionKey;
       return this;
     }
 
@@ -71,9 +71,9 @@ public Record build() {
       checkArgument(
           (rawRecord != null && hRecord == null) || (rawRecord == null && hRecord != null));
       if (rawRecord != null) {
-        return new Record(orderingKey, rawRecord);
+        return new Record(partitionKey, rawRecord);
       } else {
-        return new Record(orderingKey, hRecord);
+        return new Record(partitionKey, hRecord);
       }
     }
   }

client/src/main/java/io/hstream/RecordHeader.java

@@ -1,18 +1,18 @@
 package io.hstream;
 
 public class RecordHeader {
-  private String orderingKey;
+  private String partitionKey;
 
   private RecordHeader(Builder builder) {
-    this.orderingKey = builder.orderingKey;
+    this.partitionKey = builder.partitionKey;
   }
 
-  public String getOrderingKey() {
-    return orderingKey;
+  public String getPartitionKey() {
+    return partitionKey;
   }
 
-  public void setOrderingKey(String orderingKey) {
-    this.orderingKey = orderingKey;
+  public void setPartitionKey(String partitionKey) {
+    this.partitionKey = partitionKey;
   }
 
   public static Builder newBuild() {
@@ -21,10 +21,10 @@ public static Builder newBuild() {
 
   public static class Builder {
 
-    private String orderingKey;
+    private String partitionKey;
 
-    public Builder orderingKey(String orderingKey) {
-      this.orderingKey = orderingKey;
+    public Builder partitionKey(String partitionKey) {
+      this.partitionKey = partitionKey;
       return Builder.this;
     }
 

client/src/main/java/io/hstream/impl/DefaultSettings.java

@@ -6,5 +6,5 @@ public class DefaultSettings {
 
   public static final int APPEND_RETRY_MAX_TIMES = 5;
 
-  public static final String DEFAULT_ORDERING_KEY = "";
+  public static final String DEFAULT_PARTITION_KEY = "";
 }

client/src/main/java/io/hstream/util/RecordUtils.java

@@ -20,7 +20,7 @@ public static HStreamRecord buildHStreamRecordFromRawRecord(byte[] rawRecord) {
     HStreamRecordHeader header =
         HStreamRecordHeader.newBuilder()
             .setFlag(HStreamRecordHeader.Flag.RAW)
-            .setKey(DefaultSettings.DEFAULT_ORDERING_KEY)
+            .setKey(DefaultSettings.DEFAULT_PARTITION_KEY)
             .build();
     return HStreamRecord.newBuilder()
         .setHeader(header)
@@ -32,7 +32,7 @@ public static HStreamRecord buildHStreamRecordFromHRecord(HRecord hRecord) {
     HStreamRecordHeader header =
         HStreamRecordHeader.newBuilder()
             .setFlag(HStreamRecordHeader.Flag.JSON)
-            .setKey(DefaultSettings.DEFAULT_ORDERING_KEY)
+            .setKey(DefaultSettings.DEFAULT_PARTITION_KEY)
             .build();
 
     return HStreamRecord.newBuilder().setHeader(header).setPayload(hRecord.toByteString()).build();
@@ -43,12 +43,12 @@ public static HStreamRecord buildHStreamRecordFromRecord(Record record) {
         record.isRawRecord()
             ? buildHStreamRecordFromRawRecord(record.getRawRecord())
             : buildHStreamRecordFromHRecord(record.getHRecord());
-    if (record.getOrderingKey() == null) {
+    if (record.getPartitionKey() == null) {
       return hStreamRecord;
     }
     HStreamRecordHeader newHeader =
         HStreamRecordHeader.newBuilder(hStreamRecord.getHeader())
-            .setKey(record.getOrderingKey())
+            .setKey(record.getPartitionKey())
             .build();
     return HStreamRecord.newBuilder(hStreamRecord).setHeader(newHeader).build();
   }
@@ -62,7 +62,7 @@ public static byte[] parseRawRecordFromHStreamRecord(HStreamRecord hStreamRecord
   }
 
   public static RecordHeader parseRecordHeaderFromHStreamRecord(HStreamRecord hStreamRecord) {
-    return RecordHeader.newBuild().orderingKey(hStreamRecord.getHeader().getKey()).build();
+    return RecordHeader.newBuild().partitionKey(hStreamRecord.getHeader().getKey()).build();
   }
 
   public static HRecord parseHRecordFromHStreamRecord(HStreamRecord hStreamRecord) {

client/src/main/kotlin/io/hstream/impl/ReaderKtImpl.kt

@@ -56,10 +56,10 @@ class ReaderKtImpl(
                     val header = RecordUtils.parseRecordHeaderFromHStreamRecord(hStreamRecord)
                     if (RecordUtils.isRawRecord(hStreamRecord)) {
                         val rawRecord = RecordUtils.parseRawRecordFromHStreamRecord(hStreamRecord)
-                        Record.newBuilder().rawRecord(rawRecord).orderingKey(header.orderingKey).build()
+                        Record.newBuilder().rawRecord(rawRecord).partitionKey(header.partitionKey).build()
                     } else {
                         val hRecord = RecordUtils.parseHRecordFromHStreamRecord(hStreamRecord)
-                        Record.newBuilder().hRecord(hRecord).orderingKey(header.orderingKey).build()
+                        Record.newBuilder().hRecord(hRecord).partitionKey(header.partitionKey).build()
                     }
                 }
                 readFuture.complete(res as MutableList<Record>?)