Update comments.

Signed-off-by: Yury-Fridlyand <yury.fridlyand@improving.com>
Bit-Quill · Jan 11, 2023 · ae11c22 · ae11c22
1 parent 46f20ee
commit ae11c22
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 2 deletions.
diff --git a/opensearch/src/main/java/org/opensearch/sql/opensearch/data/type/OpenSearchBinaryType.java b/opensearch/src/main/java/org/opensearch/sql/opensearch/data/type/OpenSearchBinaryType.java
@@ -10,6 +10,10 @@
 
 import lombok.EqualsAndHashCode;
 
+/**
+ * The type of a binary value. See
+ * <a href="https://opensearch.org/docs/latest/opensearch/supported-field-types/binary/">doc</a>
+ */
 @EqualsAndHashCode(callSuper = false)
 public class OpenSearchBinaryType extends OpenSearchDataType {
 

diff --git a/opensearch/src/main/java/org/opensearch/sql/opensearch/data/type/OpenSearchDataType.java b/opensearch/src/main/java/org/opensearch/sql/opensearch/data/type/OpenSearchDataType.java
@@ -145,7 +145,7 @@ protected OpenSearchDataType(ExprCoreType type) {
   protected OpenSearchDataType() {
   }
 
-  // object has properties
+  // object and nested types have properties - info about embedded types
   @Getter
   @EqualsAndHashCode.Exclude
   Map<String, OpenSearchDataType> properties = new LinkedHashMap<>();
@@ -157,7 +157,7 @@ protected OpenSearchDataType() {
 
   @Override
   public String typeName() {
-    if (exprCoreType != ExprCoreType.UNKNOWN || type == null) {
+    if (type == null) {
       return exprCoreType.typeName();
     }
     return type.toString().toLowerCase();

diff --git a/opensearch/src/main/java/org/opensearch/sql/opensearch/data/type/OpenSearchGeoPointType.java b/opensearch/src/main/java/org/opensearch/sql/opensearch/data/type/OpenSearchGeoPointType.java
@@ -10,6 +10,10 @@
 
 import lombok.EqualsAndHashCode;
 
+/**
+ * The type of a binary value. See
+ * <a href="https://opensearch.org/docs/latest/opensearch/supported-field-types/geo-point/">doc</a>
+ */
 @EqualsAndHashCode(callSuper = false)
 public class OpenSearchGeoPointType extends OpenSearchDataType {
 

diff --git a/opensearch/src/main/java/org/opensearch/sql/opensearch/data/type/OpenSearchIpType.java b/opensearch/src/main/java/org/opensearch/sql/opensearch/data/type/OpenSearchIpType.java
@@ -10,6 +10,10 @@
 
 import lombok.EqualsAndHashCode;
 
+/**
+ * The type of a binary value. See
+ * <a href="https://opensearch.org/docs/latest/opensearch/supported-field-types/ip/">doc</a>
+ */
 @EqualsAndHashCode(callSuper = false)
 public class OpenSearchIpType extends OpenSearchDataType {
 

diff --git a/opensearch/src/main/java/org/opensearch/sql/opensearch/data/type/OpenSearchTextType.java b/opensearch/src/main/java/org/opensearch/sql/opensearch/data/type/OpenSearchTextType.java
@@ -12,6 +12,10 @@
 import lombok.EqualsAndHashCode;
 import org.opensearch.sql.data.type.ExprType;
 
+/**
+ * The type of a binary value. See
+ * <a href="https://opensearch.org/docs/latest/opensearch/supported-field-types/text/">doc</a>
+ */
 @EqualsAndHashCode(callSuper = false)
 public class OpenSearchTextType extends OpenSearchDataType {