fix code style

jinchengchenghh · May 16, 2024 · 7b96137 · 7b96137
1 parent 51b5651
commit 7b96137
Show file tree

Hide file tree

Showing 10 changed files with 63 additions and 78 deletions.
diff --git a/java/dataset/src/main/java/org/apache/arrow/dataset/file/FileSystemDatasetFactory.java b/java/dataset/src/main/java/org/apache/arrow/dataset/file/FileSystemDatasetFactory.java
@@ -17,14 +17,13 @@
 
 package org.apache.arrow.dataset.file;
 
+import java.util.Optional;
+
 import org.apache.arrow.dataset.jni.NativeDatasetFactory;
 import org.apache.arrow.dataset.jni.NativeMemoryPool;
 import org.apache.arrow.dataset.scanner.FragmentScanOptions;
-import org.apache.arrow.dataset.scanner.csv.CsvFragmentScanOptions;
 import org.apache.arrow.memory.BufferAllocator;
 
-import java.util.Optional;
-
 /**
  * Java binding of the C++ FileSystemDatasetFactory.
  */
@@ -55,7 +54,8 @@ private static long createNative(FileFormat format, String uri, Optional<Fragmen
         fragmentScanOptions.map(FragmentScanOptions::serialize).orElse(null));
   }
 
-  private static long createNative(FileFormat format, String[] uris, Optional<FragmentScanOptions> fragmentScanOptions) {
+  private static long createNative(FileFormat format, String[] uris,
+                                   Optional<FragmentScanOptions> fragmentScanOptions) {
     return JniWrapper.get().makeFileSystemDatasetFactory(uris, format.id(),
         fragmentScanOptions.map(FragmentScanOptions::serialize).orElse(null));
   }

diff --git a/java/dataset/src/main/java/org/apache/arrow/dataset/file/JniWrapper.java b/java/dataset/src/main/java/org/apache/arrow/dataset/file/JniWrapper.java
@@ -17,10 +17,10 @@
 
 package org.apache.arrow.dataset.file;
 
-import org.apache.arrow.dataset.jni.JniLoader;
-
 import java.nio.ByteBuffer;
 
+import org.apache.arrow.dataset.jni.JniLoader;
+
 /**
  * JniWrapper for filesystem based {@link org.apache.arrow.dataset.source.Dataset} implementations.
  */

diff --git a/java/dataset/src/main/java/org/apache/arrow/dataset/jni/NativeDataset.java b/java/dataset/src/main/java/org/apache/arrow/dataset/jni/NativeDataset.java
@@ -17,13 +17,12 @@
 
 package org.apache.arrow.dataset.jni;
 
+import java.nio.ByteBuffer;
+
 import org.apache.arrow.dataset.scanner.FragmentScanOptions;
 import org.apache.arrow.dataset.scanner.ScanOptions;
-import org.apache.arrow.dataset.scanner.csv.CsvFragmentScanOptions;
 import org.apache.arrow.dataset.source.Dataset;
 
-import java.nio.ByteBuffer;
-
 /**
  * Native implementation of {@link Dataset}.
  */

diff --git a/java/dataset/src/main/java/org/apache/arrow/dataset/scanner/FragmentScanOptions.java b/java/dataset/src/main/java/org/apache/arrow/dataset/scanner/FragmentScanOptions.java
@@ -17,21 +17,28 @@
 
 package org.apache.arrow.dataset.scanner;
 
-import com.google.protobuf.Any;
-import com.google.protobuf.ByteString;
-import io.substrait.proto.AdvancedExtension;
-import org.apache.arrow.dataset.substrait.StringMapNode;
-
 import java.nio.ByteBuffer;
 import java.util.Map;
 
+import org.apache.arrow.dataset.substrait.StringMapNode;
+
+import com.google.protobuf.Any;
+
+import io.substrait.proto.AdvancedExtension;
+
 public interface FragmentScanOptions {
   String typeName();
 
   int fileFormatId();
 
   ByteBuffer serialize();
 
+  /**
+   * serialize the map.
+   *
+   * @param config config map
+   * @return bufer to jni call argument, should be DirectByteBuffer
+   */
   default ByteBuffer serializeMap(Map<String, String> config) {
     if (config.isEmpty()) {
       return null;

diff --git a/java/dataset/src/main/java/org/apache/arrow/dataset/scanner/ScanOptions.java b/java/dataset/src/main/java/org/apache/arrow/dataset/scanner/ScanOptions.java
@@ -144,6 +144,12 @@ public Builder substraitFilter(ByteBuffer substraitFilter) {
       return this;
     }
 
+    /**
+     * Set the FragmentScanOptions.
+     *
+     * @param fragmentScanOptions scan options
+     * @return the ScanOptions configured.
+     */
     public Builder fragmentScanOptions(FragmentScanOptions fragmentScanOptions) {
       Preconditions.checkNotNull(fragmentScanOptions);
       this.fragmentScanOptions = fragmentScanOptions;

diff --git a/java/dataset/src/main/java/org/apache/arrow/dataset/scanner/csv/CsvConvertOptions.java b/java/dataset/src/main/java/org/apache/arrow/dataset/scanner/csv/CsvConvertOptions.java
@@ -17,11 +17,11 @@
 
 package org.apache.arrow.dataset.scanner.csv;
 
-import org.apache.arrow.c.ArrowSchema;
-
 import java.util.Map;
 import java.util.Optional;
 
+import org.apache.arrow.c.ArrowSchema;
+
 public class CsvConvertOptions {
 
   private final Map<String, String> configs;

diff --git a/java/dataset/src/main/java/org/apache/arrow/dataset/scanner/csv/CsvFragmentScanOptions.java b/java/dataset/src/main/java/org/apache/arrow/dataset/scanner/csv/CsvFragmentScanOptions.java
@@ -17,22 +17,29 @@
 
 package org.apache.arrow.dataset.scanner.csv;
 
-import org.apache.arrow.dataset.file.FileFormat;
-import org.apache.arrow.dataset.scanner.FragmentScanOptions;
-
 import java.io.Serializable;
 import java.nio.ByteBuffer;
-import java.util.Map;
 import java.util.Locale;
+import java.util.Map;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import org.apache.arrow.dataset.file.FileFormat;
+import org.apache.arrow.dataset.scanner.FragmentScanOptions;
+
 public class CsvFragmentScanOptions implements Serializable, FragmentScanOptions {
   private final CsvConvertOptions convertOptions;
   private final Map<String, String> readOptions;
   private final Map<String, String> parseOptions;
 
 
+  /**
+   * csv scan options, map to CPP struct CsvFragmentScanOptions.
+   *
+   * @param convertOptions same struct in CPP
+   * @param readOptions same struct in CPP
+   * @param parseOptions same struct in CPP
+   */
   public CsvFragmentScanOptions(CsvConvertOptions convertOptions,
                                 Map<String, String> readOptions,
                                 Map<String, String> parseOptions) {
@@ -45,10 +52,20 @@ public String typeName() {
     return FileFormat.CSV.name().toLowerCase(Locale.ROOT);
   }
 
+  /**
+   * File format id.
+   *
+   * @return id
+   */
   public int fileFormatId() {
     return FileFormat.CSV.id();
   }
 
+  /**
+   * Serialize this class to ByteBuffer and then called by jni call.
+   *
+   * @return DirectByteBuffer
+   */
   public ByteBuffer serialize() {
     Map<String, String> options = Stream.concat(Stream.concat(readOptions.entrySet().stream(),
             parseOptions.entrySet().stream()),
@@ -57,6 +74,7 @@ public ByteBuffer serialize() {
     options.put("column_type", Long.toString(convertOptions.getArrowSchemaAddress()));
     return serializeMap(options);
   }
+
   public static CsvFragmentScanOptions deserialize(String serialized) {
     throw new UnsupportedOperationException("Not implemented now");
   }

diff --git a/java/dataset/src/main/java/org/apache/arrow/dataset/substrait/AdvancedExtensionNode.java b/java/dataset/src/main/java/org/apache/arrow/dataset/substrait/AdvancedExtensionNode.java
diff --git a/java/dataset/src/main/java/org/apache/arrow/dataset/substrait/StringMapNode.java b/java/dataset/src/main/java/org/apache/arrow/dataset/substrait/StringMapNode.java
@@ -14,21 +14,27 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.arrow.dataset.substrait;
 
-import io.substrait.proto.Expression;
+package org.apache.arrow.dataset.substrait;
 
 import java.io.Serializable;
 import java.util.HashMap;
 import java.util.Map;
 
+import io.substrait.proto.Expression;
+
 public class StringMapNode implements Serializable {
   private final Map<String, String> values = new HashMap<>();
 
   public StringMapNode(Map<String, String> values) {
     this.values.putAll(values);
   }
 
+  /**
+   * Serialize String map.
+   *
+   * @return Substrait Literal
+   */
   public Expression.Literal toProtobuf() {
     Expression.Literal.Builder literalBuilder = Expression.Literal.newBuilder();
     Expression.Literal.Map.KeyValue.Builder keyValueBuilder =

diff --git a/.../dataset/src/test/java/org/apache/arrow/dataset/substrait/TestAceroSubstraitConsumer.java b/.../dataset/src/test/java/org/apache/arrow/dataset/substrait/TestAceroSubstraitConsumer.java
@@ -31,7 +31,6 @@
 import java.util.Map;
 import java.util.Optional;
 
-import com.google.common.collect.ImmutableMap;
 import org.apache.arrow.c.ArrowSchema;
 import org.apache.arrow.c.CDataDictionaryProvider;
 import org.apache.arrow.c.Data;
@@ -56,6 +55,8 @@
 import org.junit.Test;
 import org.junit.rules.TemporaryFolder;
 
+import com.google.common.collect.ImmutableMap;
+
 public class TestAceroSubstraitConsumer extends TestDataset {
 
   @ClassRule
@@ -474,11 +475,12 @@ public void testCsvConvertOptions() throws Exception {
     ), null);
     String path = "file://" + getClass().getResource("/").getPath() + "/data/student.csv";
     BufferAllocator allocator = rootAllocator();
-    try(ArrowSchema cSchema = ArrowSchema.allocateNew(allocator)) {
+    try (ArrowSchema cSchema = ArrowSchema.allocateNew(allocator)) {
       Data.exportSchema(allocator, schema, new CDataDictionaryProvider(), cSchema);
       CsvConvertOptions convertOptions = new CsvConvertOptions(ImmutableMap.of("delimiter", ";"));
       convertOptions.setArrowSchema(cSchema);
-      CsvFragmentScanOptions fragmentScanOptions = new CsvFragmentScanOptions(convertOptions, ImmutableMap.of(), ImmutableMap.of());
+      CsvFragmentScanOptions fragmentScanOptions = new CsvFragmentScanOptions(
+          convertOptions, ImmutableMap.of(), ImmutableMap.of());
       ScanOptions options = new ScanOptions.Builder(/*batchSize*/ 32768)
           .columns(Optional.empty())
           .fragmentScanOptions(fragmentScanOptions)