[FEAT][JAVA] Implement READERS and WRITERS for Java (#233)

java/.gitignore

@@ -1,3 +1,5 @@
 .idea
 dependency-reduced-pom.xml
 target
+gar-java.iml
+cmake-build-debug

java/CMakeLists.txt

@@ -3,7 +3,9 @@ project(gar-java)
 
 SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3 -g -std=c++17 -Wall")
 
-file(GLOB SOURCES "target/generated-sources/annotations/*.cc" "target/generated-test-sources/test-annotations/*.cc")
+file(GLOB SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/target/generated-sources/annotations/*.cc" "${CMAKE_CURRENT_SOURCE_DIR}/target/generated-test-sources/test-annotations/*.cc"
+                  "${CMAKE_CURRENT_SOURCE_DIR}/src/main/cpp/ffi/*.cc")
+list(REMOVE_ITEM SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/target/generated-sources/annotations/jni_com_alibaba_graphar_arrow_ArrowTable_Static_cxx_0x58c7409.cc")
 
 set(LIBNAME "gar-jni")
 
@@ -16,10 +18,12 @@ include_directories(SYSTEM ${JAVA_INCLUDE_PATH2})
 include_directories("src/main/native")
 include_directories("src/test/native")
 
+find_package(Arrow REQUIRED)
 find_package(gar REQUIRED)
 
 add_library(${LIBNAME} SHARED ${SOURCES})
 target_link_libraries(${LIBNAME} ${CMAKE_JNI_LINKER_FLAGS} gar)
+target_link_libraries(${LIBNAME} ${CMAKE_JNI_LINKER_FLAGS} Arrow::arrow_static)
 
 set_target_properties(${LIBNAME} PROPERTIES LINKER_LANGUAGE CXX)
 

java/pom.xml

@@ -16,6 +16,7 @@
         <maven.compiler.target>8</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <fastffi.revision>0.1.2</fastffi.revision>
+        <arrow.version>13.0.0</arrow.version>
         <native.library.name>gar-java</native.library.name>
 
     </properties>
@@ -48,24 +49,50 @@
             <scope>provided</scope>
         </dependency>
 
-
         <dependency>
             <groupId>com.alibaba.fastffi</groupId>
             <artifactId>llvm</artifactId>
             <classifier>${os.detected.classifier}</classifier>
             <version>${fastffi.revision}</version>
         </dependency>
 
+        <dependency>
+            <groupId>org.apache.arrow</groupId>
+            <artifactId>arrow-c-data</artifactId>
+            <version>${arrow.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.arrow</groupId>
+            <artifactId>arrow-vector</artifactId>
+            <version>${arrow.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.arrow</groupId>
+            <artifactId>arrow-memory-netty</artifactId>
+            <version>${arrow.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.arrow</groupId>
+            <artifactId>arrow-dataset</artifactId>
+            <version>${arrow.version}</version>
+        </dependency>
+
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
             <version>4.13.2</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-simple</artifactId>
+            <version>1.7.25</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 
     <build>
-	<extensions>
+        <extensions>
             <extension>
                 <groupId>kr.motd.maven</groupId>
                 <artifactId>os-maven-plugin</artifactId>
@@ -164,19 +191,6 @@
                     <argLine>-Djava.library.path=${project.basedir}/target/native</argLine>
                 </configuration>
             </plugin>
-            <plugin>
-                <groupId>com.diffplug.spotless</groupId>
-                <artifactId>spotless-maven-plugin</artifactId>
-                <version>2.20.0</version>
-                <configuration>
-                    <java>
-                        <googleJavaFormat>
-                            <version>1.13.0</version>
-                            <style>AOSP</style>
-                        </googleJavaFormat>
-                    </java>
-                </configuration>
-            </plugin>
         </plugins>
         <pluginManagement>
             <plugins>
@@ -237,6 +251,19 @@
                     <artifactId>maven-antrun-plugin</artifactId>
                     <version>3.0.0</version>
                 </plugin>
+                <plugin>
+                    <groupId>com.diffplug.spotless</groupId>
+                    <artifactId>spotless-maven-plugin</artifactId>
+                    <version>2.20.0</version>
+                    <configuration>
+                        <java>
+                            <googleJavaFormat>
+                                <version>1.7</version>
+                                <style>AOSP</style>
+                            </googleJavaFormat>
+                        </java>
+                    </configuration>
+                </plugin>
             </plugins>
         </pluginManagement>
     </build>

java/src/main/cpp/ffi/jni_com_alibaba_graphar_arrow_ArrowTable_Static.cc

@@ -0,0 +1,22 @@
+#include <jni.h>
+#include <new>
+#include <iostream>
+#include "arrow/api.h"
+#include "arrow/c/bridge.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// Common Stubs
+
+JNIEXPORT
+jlong JNICALL Java_com_alibaba_graphar_arrow_ArrowTable_1Static_1cxx_10x58c7409_nativeFromArrowArrayAndArrowSchema(JNIEnv*, jclass, jlong rv_base, jlong arg0 /* arrayAddress0 */, jlong arg1 /* schemaAddress1 */) {
+    auto maybeRecordBatch = arrow::ImportRecordBatch(reinterpret_cast<struct ArrowArray*>(arg0), reinterpret_cast<struct ArrowSchema*>(arg1));
+    auto table = arrow::Table::FromRecordBatches({maybeRecordBatch.ValueOrDie()});
+	return reinterpret_cast<jlong>(new((void*)rv_base) arrow::Result<std::shared_ptr<arrow::Table>>(table));
+}
+
+#ifdef __cplusplus
+}
+#endif

java/src/main/java/com/alibaba/graphar/arrow/ArrowArray.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2022 Alibaba Group Holding Limited.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the
+ * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.alibaba.graphar.arrow;
+
+import static com.alibaba.graphar.util.CppClassName.ARROW_ARRAY;
+import static com.alibaba.graphar.util.CppHeaderName.ARROW_API_H;
+
+import com.alibaba.fastffi.CXXHead;
+import com.alibaba.fastffi.CXXPointer;
+import com.alibaba.fastffi.FFIGen;
+import com.alibaba.fastffi.FFITypeAlias;
+
+@FFIGen
+@FFITypeAlias(ARROW_ARRAY)
+@CXXHead(ARROW_API_H)
+public interface ArrowArray extends CXXPointer {
+    long length();
+}

java/src/main/java/com/alibaba/graphar/arrow/ArrowResult.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2022 Alibaba Group Holding Limited.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the
+ * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.alibaba.graphar.arrow;
+
+import static com.alibaba.graphar.util.CppClassName.ARROW_RESULT;
+import static com.alibaba.graphar.util.CppHeaderName.ARROW_API_H;
+
+import com.alibaba.fastffi.CXXHead;
+import com.alibaba.fastffi.CXXReference;
+import com.alibaba.fastffi.FFIGen;
+import com.alibaba.fastffi.FFIPointer;
+import com.alibaba.fastffi.FFITypeAlias;
+
+@FFIGen
+@FFITypeAlias(ARROW_RESULT)
+@CXXHead(ARROW_API_H)
+public interface ArrowResult<T> extends FFIPointer {
+    @CXXReference
+    T ValueOrDie();
+
+    @CXXReference
+    ArrowStatus status();
+
+    boolean ok();
+}

java/src/main/java/com/alibaba/graphar/arrow/ArrowStatus.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2022 Alibaba Group Holding Limited.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the
+ * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.alibaba.graphar.arrow;
+
+import static com.alibaba.graphar.util.CppClassName.ARROW_STATUS;
+import static com.alibaba.graphar.util.CppHeaderName.ARROW_API_H;
+
+import com.alibaba.fastffi.CXXHead;
+import com.alibaba.fastffi.CXXReference;
+import com.alibaba.fastffi.FFIGen;
+import com.alibaba.fastffi.FFIPointer;
+import com.alibaba.fastffi.FFITypeAlias;
+import com.alibaba.graphar.stdcxx.StdString;
+
+@FFIGen
+@FFITypeAlias(ARROW_STATUS)
+@CXXHead(ARROW_API_H)
+public interface ArrowStatus extends FFIPointer {
+    @CXXReference
+    StdString message();
+}

java/src/main/java/com/alibaba/graphar/arrow/ArrowTable.java

@@ -0,0 +1,88 @@
+/*
+ * Copyright 2022 Alibaba Group Holding Limited.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the
+ * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.alibaba.graphar.arrow;
+
+import static com.alibaba.graphar.util.CppClassName.ARROW_TABLE;
+import static com.alibaba.graphar.util.CppHeaderName.ARROW_API_H;
+
+import com.alibaba.fastffi.CXXHead;
+import com.alibaba.fastffi.CXXPointer;
+import com.alibaba.fastffi.CXXValue;
+import com.alibaba.fastffi.FFIGen;
+import com.alibaba.fastffi.FFILibrary;
+import com.alibaba.fastffi.FFITypeAlias;
+import com.alibaba.fastffi.FFITypeFactory;
+import com.alibaba.graphar.stdcxx.StdSharedPtr;
+import com.alibaba.graphar.stdcxx.StdString;
+import org.apache.arrow.c.ArrowArray;
+import org.apache.arrow.c.ArrowSchema;
+import org.apache.arrow.c.Data;
+import org.apache.arrow.memory.BufferAllocator;
+import org.apache.arrow.vector.VectorSchemaRoot;
+import org.apache.arrow.vector.dictionary.DictionaryProvider;
+
+@FFIGen
+@FFITypeAlias(ARROW_TABLE)
+@CXXHead(ARROW_API_H)
+public interface ArrowTable extends CXXPointer {
+
+    /**
+     * Convert VectorSchemaRoot to C++ arrow::Table
+     *
+     * @param allocator Buffer allocator for allocating C data interface fields
+     * @param vsr Vector schema root to export
+     * @param provider Dictionary provider for dictionary encoded vectors (optional)
+     * @return StdSharedPtr<ArrowTable>
+     */
+    static StdSharedPtr<ArrowTable> fromVectorSchemaRoot(
+            BufferAllocator allocator, VectorSchemaRoot vsr, DictionaryProvider provider) {
+        ArrowResult<StdSharedPtr<ArrowTable>> maybeTable = null;
+        org.apache.arrow.c.ArrowArray arrowArray = ArrowArray.allocateNew(allocator);
+        org.apache.arrow.c.ArrowSchema arrowSchema = ArrowSchema.allocateNew(allocator);
+        Data.exportVectorSchemaRoot(allocator, vsr, provider, arrowArray, arrowSchema);
+        maybeTable =
+                Static.INSTANCE.fromArrowArrayAndArrowSchema(
+                        arrowArray.memoryAddress(), arrowSchema.memoryAddress());
+        if (!maybeTable.ok()) {
+            throw new RuntimeException(
+                    "Error when convert C RecordBatch to C++ Table: "
+                            + maybeTable.status().message().toJavaString());
+        }
+        return maybeTable.ValueOrDie();
+    }
+
+    long num_rows();
+
+    @CXXValue
+    StdString ToString();
+
+    @FFIGen
+    @FFILibrary(value = "arrow", namespace = "arrow")
+    interface Static {
+        Static INSTANCE = FFITypeFactory.getLibrary(ArrowTable.Static.class);
+
+        /**
+         * Convert C ArrowArray and ArrowSchema to C++ arrow::Table with JNI wrote manually
+         *
+         * @param arrayAddress Address of C ArrowArray
+         * @param schemaAddress Address of C ArrowSchema
+         * @return StdSharedPtr<ArrowTable> wrapped by ArrowResult
+         */
+        @CXXValue
+        ArrowResult<StdSharedPtr<ArrowTable>> fromArrowArrayAndArrowSchema(
+                @FFITypeAlias("struct ArrowArray*") long arrayAddress,
+                @FFITypeAlias("struct ArrowSchema*") long schemaAddress);
+    }
+}

java/src/main/java/com/alibaba/graphar/arrow/StructArrowArray.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2022 Alibaba Group Holding Limited.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the
+ * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.alibaba.graphar.arrow;
+
+import static com.alibaba.graphar.util.CppHeaderName.ARROW_API_H;
+import static com.alibaba.graphar.util.CppHeaderName.ARROW_C_BRIDGE_H;
+
+import com.alibaba.fastffi.CXXHead;
+import com.alibaba.fastffi.FFIFactory;
+import com.alibaba.fastffi.FFIGen;
+import com.alibaba.fastffi.FFIPointer;
+import com.alibaba.fastffi.FFITypeAlias;
+import com.alibaba.fastffi.FFITypeFactory;
+
+@FFIGen
+@CXXHead(ARROW_C_BRIDGE_H)
+@CXXHead(ARROW_API_H)
+@FFITypeAlias("struct ArrowArray")
+public interface StructArrowArray extends FFIPointer {
+    Factory factory = FFITypeFactory.getFactory(StructArrowArray.class);
+
+    @FFIFactory
+    interface Factory {
+        StructArrowArray create();
+    }
+}