java-docs

Author: Caideyipi

iotdb-api/pipe-api/src/main/java/org/apache/iotdb/pipe/api/collector/DataCollector.java

@@ -19,10 +19,19 @@
 
 package org.apache.iotdb.pipe.api.collector;
 
+import org.apache.iotdb.pipe.api.access.Row;
 import org.apache.iotdb.pipe.api.event.dml.insertion.TabletInsertionEvent;
 
 import java.util.List;
 
+/** Transform data to {@link TabletInsertionEvent}. */
 public interface DataCollector {
+
+  /**
+   * Transform data to {@link TabletInsertionEvent}.
+   *
+   * @param shouldReport Whether to report progress for generated events
+   * @see Row
+   */
   List<TabletInsertionEvent> convertToTabletInsertionEvents(final boolean shouldReport);
 }

iotdb-api/pipe-api/src/main/java/org/apache/iotdb/pipe/api/collector/RowCollector.java

@@ -27,7 +27,7 @@
 
 /**
  * Used to collect rows generated by {@link TabletInsertionEvent#processRowByRow(BiConsumer)},
- * {@link TabletInsertionEvent#processTabletWithTabletCollection(BiConsumer)}.
+ * {@link TabletInsertionEvent#processTablet(BiConsumer)}.
  */
 public interface RowCollector {
 

iotdb-api/pipe-api/src/main/java/org/apache/iotdb/pipe/api/collector/TabletCollector.java

@@ -19,10 +19,26 @@
 
 package org.apache.iotdb.pipe.api.collector;
 
+import org.apache.iotdb.pipe.api.access.Row;
+import org.apache.iotdb.pipe.api.event.dml.insertion.TabletInsertionEvent;
+
 import org.apache.tsfile.write.record.Tablet;
 
 import java.io.IOException;
+import java.util.function.BiConsumer;
 
+/**
+ * Used to collect rows generated by {@link
+ * TabletInsertionEvent#processTabletWithCollect(BiConsumer)}.
+ */
 public interface TabletCollector {
+
+  /**
+   * Collects a tablet.
+   *
+   * @param tablet Tablet to be collected
+   * @throws IOException if any I/O errors occur
+   * @see Row
+   */
   void collectTablet(Tablet tablet) throws IOException;
 }

iotdb-api/pipe-api/src/main/java/org/apache/iotdb/pipe/api/event/dml/insertion/TabletInsertionEvent.java

@@ -52,7 +52,7 @@ public interface TabletInsertionEvent extends Event {
    * org.apache.iotdb.pipe.api.collector.TabletCollector}.
    *
    * @return {@code Iterable<TabletInsertionEvent>} a list of new {@link TabletInsertionEvent}
-   *     contains the results collected by the {@link RowCollector}
+   *     contains the results collected by the {@link TabletCollector}
    */
   Iterable<TabletInsertionEvent> processTabletWithCollect(
       BiConsumer<Tablet, TabletCollector> consumer);

iotdb-core/datanode/src/main/java/org/apache/iotdb/db/pipe/event/common/tablet/parser/TabletInsertionEventTablePatternParser.java

@@ -118,7 +118,7 @@ public List<TabletInsertionEvent> processTablet(BiConsumer<Tablet, RowCollector>
   public List<TabletInsertionEvent> processTabletWithCollect(
       BiConsumer<Tablet, TabletCollector> consumer) {
     if (LOGGER.isDebugEnabled()) {
-      LOGGER.warn("TablePatternParser does not support tablet processing");
+      LOGGER.warn("TablePatternParser does not support tablet processing with collect");
     }
     return Collections.emptyList();
   }