add comment

apache · Jan 7, 2021 · 80e42c1 · 80e42c1
1 parent 5a9464d
commit 80e42c1
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 0 deletions.
diff --git a/...c/main/java/org/apache/flink/formats/protobuf/deserialize/PbCodegenArrayDeserializer.java b/...c/main/java/org/apache/flink/formats/protobuf/deserialize/PbCodegenArrayDeserializer.java
@@ -45,6 +45,8 @@ public PbCodegenArrayDeserializer(
 	public String codegen(
 		String returnVarName,
 		String messageGetStr) throws PbCodegenException {
+		// The type of messageGetStr is a native List object,
+		// it should be converted to ArrayData of flink internal type
 		PbCodegenVarId varUid = PbCodegenVarId.getInstance();
 		int uid = varUid.getAndIncrement();
 		String protoTypeStr = PbCodegenUtils.getTypeStrFromProto(fd, false);

diff --git a/.../main/java/org/apache/flink/formats/protobuf/deserialize/PbCodegenDeserializeFactory.java b/.../main/java/org/apache/flink/formats/protobuf/deserialize/PbCodegenDeserializeFactory.java
@@ -32,6 +32,8 @@ public static PbCodegenDeserializer getPbCodegenDes(
 		Descriptors.FieldDescriptor fd,
 		LogicalType type,
 		boolean readDefaultValues) throws PbCodegenException {
+		// We do not use FieldDescriptor to check because when FieldDescriptor is an element type in array,
+		// FieldDescriptor.isRepeated() is still true
 		if (type instanceof RowType) {
 			return new PbCodegenRowDeserializer(fd.getMessageType(), (RowType) type,
 				readDefaultValues);

diff --git a/...src/main/java/org/apache/flink/formats/protobuf/deserialize/PbCodegenMapDeserializer.java b/...src/main/java/org/apache/flink/formats/protobuf/deserialize/PbCodegenMapDeserializer.java
@@ -46,6 +46,8 @@ public PbCodegenMapDeserializer(
 	public String codegen(
 		String returnVarName,
 		String messageGetStr) throws PbCodegenException {
+		// The type of messageGetStr is a native Map object,
+		// it should be converted to MapData of flink internal type
 		PbCodegenVarId varUid = PbCodegenVarId.getInstance();
 		int uid = varUid.getAndIncrement();
 

diff --git a/...src/main/java/org/apache/flink/formats/protobuf/deserialize/PbCodegenRowDeserializer.java b/...src/main/java/org/apache/flink/formats/protobuf/deserialize/PbCodegenRowDeserializer.java
@@ -50,6 +50,8 @@ public PbCodegenRowDeserializer(
 	public String codegen(
 		String returnVarName,
 		String messageGetStr) throws PbCodegenException {
+		// The type of messageGetStr is a native pb object,
+		// it should be converted to RowData of flink internal type
 		PbCodegenVarId varUid = PbCodegenVarId.getInstance();
 		int uid = varUid.getAndIncrement();
 		String pbMessageVar = "message" + uid;

diff --git a/.../main/java/org/apache/flink/formats/protobuf/deserialize/PbCodegenSimpleDeserializer.java b/.../main/java/org/apache/flink/formats/protobuf/deserialize/PbCodegenSimpleDeserializer.java
@@ -30,6 +30,8 @@ public PbCodegenSimpleDeserializer(
 
 	@Override
 	public String codegen(String returnVarName, String messageGetStr) {
+		// the type of messageGetStr must not be primitive type,
+		// it should convert to internal flink row type like StringData.
 		StringBuilder sb = new StringBuilder();
 		switch (fd.getJavaType()) {
 			case INT: