Refactor: change return types of UDF implementations to their actual return types (instead of Object)

yuancu · yuancu · commit 3ec719dac6c2 · 2025-05-08T16:16:31.000+08:00
Signed-off-by: Yuanchun Shen &lt;yuanchu@amazon.com&gt;
diff --git a/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/CurrentFunction.java b/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/CurrentFunction.java
@@ -84,16 +84,16 @@ public static LocalDateTime getNowFromProperties(FunctionProperties functionProp
       return DateTimeFunctions.formatNow(functionProperties.getQueryStartClock());
     }
 
-    public static Object currentDate(LocalDateTime now) {
-      return new ExprDateValue(now.toLocalDate()).valueForCalcite();
+    public static String currentDate(LocalDateTime now) {
+      return (String) new ExprDateValue(now.toLocalDate()).valueForCalcite();
     }
 
-    public static Object currentTime(LocalDateTime now) {
-      return new ExprTimeValue(now.toLocalTime()).valueForCalcite();
+    public static String currentTime(LocalDateTime now) {
+      return (String) new ExprTimeValue(now.toLocalTime()).valueForCalcite();
     }
 
-    public static Object currentTimestamp(LocalDateTime now) {
-      return new ExprTimestampValue(now).valueForCalcite();
+    public static String currentTimestamp(LocalDateTime now) {
+      return (String) new ExprTimestampValue(now).valueForCalcite();
     }
   }
 }
diff --git a/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/DatetimeFunction.java b/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/DatetimeFunction.java
@@ -47,18 +47,18 @@ public Expression implement(
       return Expressions.call(DatetimeImplementor.class, "datetime", translatedOperands);
     }
 
-    public static Object datetime(String timestamp) {
+    public static String datetime(String timestamp) {
       ExprValue argTimestampExpr = new ExprStringValue(timestamp);
       ExprValue datetimeExpr;
       datetimeExpr = DateTimeFunctions.exprDateTimeNoTimezone(argTimestampExpr);
-      return datetimeExpr.valueForCalcite();
+      return (String) datetimeExpr.valueForCalcite();
     }
 
-    public static Object datetime(String timestamp, String timezone) {
+    public static String datetime(String timestamp, String timezone) {
       ExprValue timestampExpr = new ExprStringValue(timestamp);
       ExprValue datetimeExpr =
           DateTimeFunctions.exprDateTime(timestampExpr, new ExprStringValue(timezone));
-      return datetimeExpr.valueForCalcite();
+      return (String) datetimeExpr.valueForCalcite();
     }
   }
 }
diff --git a/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/FromUnixTimeFunction.java b/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/FromUnixTimeFunction.java
@@ -56,13 +56,14 @@ public Expression implement(
       return Expressions.call(FromUnixTimeImplementor.class, "fromUnixTime", translatedOperands);
     }
 
-    public static Object fromUnixTime(double unixTime) {
-      return exprFromUnixTime(new ExprDoubleValue(unixTime)).valueForCalcite();
+    public static String fromUnixTime(double unixTime) {
+      return (String) exprFromUnixTime(new ExprDoubleValue(unixTime)).valueForCalcite();
     }
 
-    public static Object fromUnixTime(double unixTime, String format) {
-      return exprFromUnixTimeFormat(new ExprDoubleValue(unixTime), new ExprStringValue(format))
-          .valueForCalcite();
+    public static String fromUnixTime(double unixTime, String format) {
+      return (String)
+          exprFromUnixTimeFormat(new ExprDoubleValue(unixTime), new ExprStringValue(format))
+              .valueForCalcite();
     }
   }
 }
diff --git a/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/SecToTimeFunction.java b/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/SecToTimeFunction.java
@@ -52,15 +52,15 @@ public Expression implement(
           Expressions.convert_(translatedOperands.getFirst(), Number.class));
     }
 
-    public static Object secToTime(Number seconds) {
+    public static String secToTime(Number seconds) {
       ExprValue returnTimeValue;
       ExprValue transferredValue = ExprValueUtils.fromObjectValue(seconds);
       if (seconds instanceof Long || seconds instanceof Integer) {
         returnTimeValue = exprSecToTime(transferredValue);
       } else {
         returnTimeValue = exprSecToTimeWithNanos(transferredValue);
       }
-      return returnTimeValue.valueForCalcite();
+      return (String) returnTimeValue.valueForCalcite();
     }
   }
 }
diff --git a/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/SysdateFunction.java b/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/SysdateFunction.java
@@ -50,14 +50,14 @@ public Expression implement(
       return Expressions.call(SysdateImplementor.class, "sysdate", translatedOperands);
     }
 
-    public static Object sysdate() {
+    public static String sysdate() {
       var localDateTime = DateTimeFunctions.formatNow(Clock.systemDefaultZone(), 0);
-      return new ExprTimestampValue(localDateTime).valueForCalcite();
+      return (String) new ExprTimestampValue(localDateTime).valueForCalcite();
     }
 
-    public static Object sysdate(int precision) {
+    public static String sysdate(int precision) {
       var localDateTime = DateTimeFunctions.formatNow(Clock.systemDefaultZone(), precision);
-      return new ExprTimestampValue(localDateTime).valueForCalcite();
+      return (String) new ExprTimestampValue(localDateTime).valueForCalcite();
     }
   }
 }
diff --git a/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/TimestampAddFunction.java b/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/TimestampAddFunction.java
@@ -82,23 +82,24 @@ public Expression implement(
       }
     }
 
-    public static Object timestampAddForTimeType(
+    public static String timestampAddForTimeType(
         String addUnit, long amount, ExprValue timestampBase, DataContext propertyContext) {
       FunctionProperties restored =
           UserDefinedFunctionUtils.restoreFunctionProperties(propertyContext);
 
-      return exprTimestampAddForTimeType(
-              restored.getQueryStartClock(),
-              new ExprStringValue(addUnit),
-              new ExprLongValue(amount),
-              timestampBase)
-          .valueForCalcite();
+      return (String)
+          exprTimestampAddForTimeType(
+                  restored.getQueryStartClock(),
+                  new ExprStringValue(addUnit),
+                  new ExprLongValue(amount),
+                  timestampBase)
+              .valueForCalcite();
     }
 
-    public static Object timestampAdd(String addUnit, long amount, ExprValue timestampBase) {
+    public static String timestampAdd(String addUnit, long amount, ExprValue timestampBase) {
       ExprValue returnValue =
           exprTimestampAdd(new ExprStringValue(addUnit), new ExprLongValue(amount), timestampBase);
-      return returnValue.valueForCalcite();
+      return (String) returnValue.valueForCalcite();
     }
   }
 }
diff --git a/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/TimestampFunction.java b/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/TimestampFunction.java
@@ -55,14 +55,14 @@ public Expression implement(
     }
   }
 
-  public static Object timestamp(FunctionProperties properties, ExprValue datetime) {
-    return convertToTimestampValue(datetime, properties).valueForCalcite();
+  public static String timestamp(FunctionProperties properties, ExprValue datetime) {
+    return (String) convertToTimestampValue(datetime, properties).valueForCalcite();
   }
 
-  public static Object timestamp(
+  public static String timestamp(
       FunctionProperties properties, ExprValue datetime, ExprValue addTime) {
     ExprValue dateTimeBase = convertToTimestampValue(datetime, properties);
     ExprValue addTimeValue = convertToTimestampValue(addTime, properties);
-    return exprAddTime(properties, dateTimeBase, addTimeValue).valueForCalcite();
+    return (String) exprAddTime(properties, dateTimeBase, addTimeValue).valueForCalcite();
   }
 }
diff --git a/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/ToSecondsFunction.java b/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/ToSecondsFunction.java
@@ -58,7 +58,7 @@ public Expression implement(
     }
   }
 
-  public static Object toSeconds(FunctionProperties properties, ExprValue datetime) {
+  public static long toSeconds(FunctionProperties properties, ExprValue datetime) {
     return switch (datetime.type()) {
       case ExprCoreType.DATE, ExprCoreType.TIME, ExprCoreType.TIMESTAMP, ExprCoreType.STRING -> {
         ExprValue dateTimeValue = convertToTimestampValue(datetime, properties);
diff --git a/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/UnixTimestampFunction.java b/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/UnixTimestampFunction.java
@@ -56,11 +56,11 @@ public Expression implement(
     }
   }
 
-  public static Object unixTimestamp(FunctionProperties properties) {
+  public static double unixTimestamp(FunctionProperties properties) {
     return unixTimeStamp(properties.getQueryStartClock()).doubleValue();
   }
 
-  public static Object unixTimestamp(FunctionProperties ignored, ExprValue timestamp) {
+  public static double unixTimestamp(FunctionProperties ignored, ExprValue timestamp) {
     return unixTimeStampOf(timestamp).doubleValue();
   }
 }
diff --git a/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/WeekFunction.java b/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/WeekFunction.java
@@ -53,16 +53,16 @@ public Expression implement(
       return Expressions.call(WeekImplementor.class, "week", list);
     }
 
-    public static Object week(String date) {
+    public static int week(String date) {
       ExprValue dateValue = new ExprDateValue(date);
-      return DateTimeFunctions.exprWeekWithoutMode(dateValue).valueForCalcite();
+      return (int) DateTimeFunctions.exprWeekWithoutMode(dateValue).valueForCalcite();
     }
 
-    public static Object week(String date, int mode) {
+    public static int week(String date, int mode) {
       ExprValue dateValue = new ExprDateValue(date);
       ExprValue modeValue = new ExprIntegerValue(mode);
       ExprValue woyExpr = DateTimeFunctions.exprWeek(dateValue, modeValue);
-      return woyExpr.valueForCalcite();
+      return (int) woyExpr.valueForCalcite();
     }
   }
 }
diff --git a/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/YearweekFunction.java b/core/src/main/java/org/opensearch/sql/expression/function/udf/datetime/YearweekFunction.java
@@ -58,11 +58,11 @@ public Expression implement(
     }
   }
 
-  public static Object yearweek(FunctionProperties properties, ExprValue date) {
+  public static int yearweek(FunctionProperties properties, ExprValue date) {
     return yearweek(properties, date, ExprValueUtils.integerValue(0));
   }
 
-  public static Object yearweek(FunctionProperties properties, ExprValue date, ExprValue mode) {
+  public static int yearweek(FunctionProperties properties, ExprValue date, ExprValue mode) {
     if (date.type() == ExprCoreType.TIME) {
       return yearweekToday(mode, properties.getQueryStartClock()).integerValue();
     }

Original file line number	Diff line number	Diff line change
`@@ -84,16 +84,16 @@ public static LocalDateTime getNowFromProperties(FunctionProperties functionProp`
`84`	`84`	`return DateTimeFunctions.formatNow(functionProperties.getQueryStartClock());`
`85`	`85`	`}`
`86`	`86`
`87`		`- public static Object currentDate(LocalDateTime now) {`
`88`		`- return new ExprDateValue(now.toLocalDate()).valueForCalcite();`
	`87`	`+ public static String currentDate(LocalDateTime now) {`
	`88`	`+ return (String) new ExprDateValue(now.toLocalDate()).valueForCalcite();`
`89`	`89`	`}`
`90`	`90`
`91`		`- public static Object currentTime(LocalDateTime now) {`
`92`		`- return new ExprTimeValue(now.toLocalTime()).valueForCalcite();`
	`91`	`+ public static String currentTime(LocalDateTime now) {`
	`92`	`+ return (String) new ExprTimeValue(now.toLocalTime()).valueForCalcite();`
`93`	`93`	`}`
`94`	`94`
`95`		`- public static Object currentTimestamp(LocalDateTime now) {`
`96`		`- return new ExprTimestampValue(now).valueForCalcite();`
	`95`	`+ public static String currentTimestamp(LocalDateTime now) {`
	`96`	`+ return (String) new ExprTimestampValue(now).valueForCalcite();`
`97`	`97`	`}`
`98`	`98`	`}`
`99`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,18 +47,18 @@ public Expression implement(`
`47`	`47`	`return Expressions.call(DatetimeImplementor.class, "datetime", translatedOperands);`
`48`	`48`	`}`
`49`	`49`
`50`		`- public static Object datetime(String timestamp) {`
	`50`	`+ public static String datetime(String timestamp) {`
`51`	`51`	`ExprValue argTimestampExpr = new ExprStringValue(timestamp);`
`52`	`52`	`ExprValue datetimeExpr;`
`53`	`53`	`datetimeExpr = DateTimeFunctions.exprDateTimeNoTimezone(argTimestampExpr);`
`54`		`- return datetimeExpr.valueForCalcite();`
	`54`	`+ return (String) datetimeExpr.valueForCalcite();`
`55`	`55`	`}`
`56`	`56`
`57`		`- public static Object datetime(String timestamp, String timezone) {`
	`57`	`+ public static String datetime(String timestamp, String timezone) {`
`58`	`58`	`ExprValue timestampExpr = new ExprStringValue(timestamp);`
`59`	`59`	`ExprValue datetimeExpr =`
`60`	`60`	`DateTimeFunctions.exprDateTime(timestampExpr, new ExprStringValue(timezone));`
`61`		`- return datetimeExpr.valueForCalcite();`
	`61`	`+ return (String) datetimeExpr.valueForCalcite();`
`62`	`62`	`}`
`63`	`63`	`}`
`64`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,13 +56,14 @@ public Expression implement(`
`56`	`56`	`return Expressions.call(FromUnixTimeImplementor.class, "fromUnixTime", translatedOperands);`
`57`	`57`	`}`
`58`	`58`
`59`		`- public static Object fromUnixTime(double unixTime) {`
`60`		`- return exprFromUnixTime(new ExprDoubleValue(unixTime)).valueForCalcite();`
	`59`	`+ public static String fromUnixTime(double unixTime) {`
	`60`	`+ return (String) exprFromUnixTime(new ExprDoubleValue(unixTime)).valueForCalcite();`
`61`	`61`	`}`
`62`	`62`
`63`		`- public static Object fromUnixTime(double unixTime, String format) {`
`64`		`- return exprFromUnixTimeFormat(new ExprDoubleValue(unixTime), new ExprStringValue(format))`
`65`		`- .valueForCalcite();`
	`63`	`+ public static String fromUnixTime(double unixTime, String format) {`
	`64`	`+ return (String)`
	`65`	`+ exprFromUnixTimeFormat(new ExprDoubleValue(unixTime), new ExprStringValue(format))`
	`66`	`+ .valueForCalcite();`
`66`	`67`	`}`
`67`	`68`	`}`
`68`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,15 +52,15 @@ public Expression implement(`
`52`	`52`	`Expressions.convert_(translatedOperands.getFirst(), Number.class));`
`53`	`53`	`}`
`54`	`54`
`55`		`- public static Object secToTime(Number seconds) {`
	`55`	`+ public static String secToTime(Number seconds) {`
`56`	`56`	`ExprValue returnTimeValue;`
`57`	`57`	`ExprValue transferredValue = ExprValueUtils.fromObjectValue(seconds);`
`58`	`58`	`if (seconds instanceof Long \|\| seconds instanceof Integer) {`
`59`	`59`	`returnTimeValue = exprSecToTime(transferredValue);`
`60`	`60`	`} else {`
`61`	`61`	`returnTimeValue = exprSecToTimeWithNanos(transferredValue);`
`62`	`62`	`}`
`63`		`- return returnTimeValue.valueForCalcite();`
	`63`	`+ return (String) returnTimeValue.valueForCalcite();`
`64`	`64`	`}`
`65`	`65`	`}`
`66`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,14 +50,14 @@ public Expression implement(`
`50`	`50`	`return Expressions.call(SysdateImplementor.class, "sysdate", translatedOperands);`
`51`	`51`	`}`
`52`	`52`
`53`		`- public static Object sysdate() {`
	`53`	`+ public static String sysdate() {`
`54`	`54`	`var localDateTime = DateTimeFunctions.formatNow(Clock.systemDefaultZone(), 0);`
`55`		`- return new ExprTimestampValue(localDateTime).valueForCalcite();`
	`55`	`+ return (String) new ExprTimestampValue(localDateTime).valueForCalcite();`
`56`	`56`	`}`
`57`	`57`
`58`		`- public static Object sysdate(int precision) {`
	`58`	`+ public static String sysdate(int precision) {`
`59`	`59`	`var localDateTime = DateTimeFunctions.formatNow(Clock.systemDefaultZone(), precision);`
`60`		`- return new ExprTimestampValue(localDateTime).valueForCalcite();`
	`60`	`+ return (String) new ExprTimestampValue(localDateTime).valueForCalcite();`
`61`	`61`	`}`
`62`	`62`	`}`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -82,23 +82,24 @@ public Expression implement(`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`
`85`		`- public static Object timestampAddForTimeType(`
	`85`	`+ public static String timestampAddForTimeType(`
`86`	`86`	`String addUnit, long amount, ExprValue timestampBase, DataContext propertyContext) {`
`87`	`87`	`FunctionProperties restored =`
`88`	`88`	`UserDefinedFunctionUtils.restoreFunctionProperties(propertyContext);`
`89`	`89`
`90`		`- return exprTimestampAddForTimeType(`
`91`		`- restored.getQueryStartClock(),`
`92`		`- new ExprStringValue(addUnit),`
`93`		`- new ExprLongValue(amount),`
`94`		`- timestampBase)`
`95`		`- .valueForCalcite();`
	`90`	`+ return (String)`
	`91`	`+ exprTimestampAddForTimeType(`
	`92`	`+ restored.getQueryStartClock(),`
	`93`	`+ new ExprStringValue(addUnit),`
	`94`	`+ new ExprLongValue(amount),`
	`95`	`+ timestampBase)`
	`96`	`+ .valueForCalcite();`
`96`	`97`	`}`
`97`	`98`
`98`		`- public static Object timestampAdd(String addUnit, long amount, ExprValue timestampBase) {`
	`99`	`+ public static String timestampAdd(String addUnit, long amount, ExprValue timestampBase) {`
`99`	`100`	`ExprValue returnValue =`
`100`	`101`	`exprTimestampAdd(new ExprStringValue(addUnit), new ExprLongValue(amount), timestampBase);`
`101`		`- return returnValue.valueForCalcite();`
	`102`	`+ return (String) returnValue.valueForCalcite();`
`102`	`103`	`}`
`103`	`104`	`}`
`104`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,14 +55,14 @@ public Expression implement(`
`55`	`55`	`}`
`56`	`56`	`}`
`57`	`57`
`58`		`- public static Object timestamp(FunctionProperties properties, ExprValue datetime) {`
`59`		`- return convertToTimestampValue(datetime, properties).valueForCalcite();`
	`58`	`+ public static String timestamp(FunctionProperties properties, ExprValue datetime) {`
	`59`	`+ return (String) convertToTimestampValue(datetime, properties).valueForCalcite();`
`60`	`60`	`}`
`61`	`61`
`62`		`- public static Object timestamp(`
	`62`	`+ public static String timestamp(`
`63`	`63`	`FunctionProperties properties, ExprValue datetime, ExprValue addTime) {`
`64`	`64`	`ExprValue dateTimeBase = convertToTimestampValue(datetime, properties);`
`65`	`65`	`ExprValue addTimeValue = convertToTimestampValue(addTime, properties);`
`66`		`- return exprAddTime(properties, dateTimeBase, addTimeValue).valueForCalcite();`
	`66`	`+ return (String) exprAddTime(properties, dateTimeBase, addTimeValue).valueForCalcite();`
`67`	`67`	`}`
`68`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public Expression implement(`
`58`	`58`	`}`
`59`	`59`	`}`
`60`	`60`
`61`		`- public static Object toSeconds(FunctionProperties properties, ExprValue datetime) {`
	`61`	`+ public static long toSeconds(FunctionProperties properties, ExprValue datetime) {`
`62`	`62`	`return switch (datetime.type()) {`
`63`	`63`	`case ExprCoreType.DATE, ExprCoreType.TIME, ExprCoreType.TIMESTAMP, ExprCoreType.STRING -> {`
`64`	`64`	`ExprValue dateTimeValue = convertToTimestampValue(datetime, properties);`
Original file line number	Diff line number	Diff line change
`@@ -56,11 +56,11 @@ public Expression implement(`
`56`	`56`	`}`
`57`	`57`	`}`
`58`	`58`
`59`		`- public static Object unixTimestamp(FunctionProperties properties) {`
	`59`	`+ public static double unixTimestamp(FunctionProperties properties) {`
`60`	`60`	`return unixTimeStamp(properties.getQueryStartClock()).doubleValue();`
`61`	`61`	`}`
`62`	`62`
`63`		`- public static Object unixTimestamp(FunctionProperties ignored, ExprValue timestamp) {`
	`63`	`+ public static double unixTimestamp(FunctionProperties ignored, ExprValue timestamp) {`
`64`	`64`	`return unixTimeStampOf(timestamp).doubleValue();`
`65`	`65`	`}`
`66`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,16 +53,16 @@ public Expression implement(`
`53`	`53`	`return Expressions.call(WeekImplementor.class, "week", list);`
`54`	`54`	`}`
`55`	`55`
`56`		`- public static Object week(String date) {`
	`56`	`+ public static int week(String date) {`
`57`	`57`	`ExprValue dateValue = new ExprDateValue(date);`
`58`		`- return DateTimeFunctions.exprWeekWithoutMode(dateValue).valueForCalcite();`
	`58`	`+ return (int) DateTimeFunctions.exprWeekWithoutMode(dateValue).valueForCalcite();`
`59`	`59`	`}`
`60`	`60`
`61`		`- public static Object week(String date, int mode) {`
	`61`	`+ public static int week(String date, int mode) {`
`62`	`62`	`ExprValue dateValue = new ExprDateValue(date);`
`63`	`63`	`ExprValue modeValue = new ExprIntegerValue(mode);`
`64`	`64`	`ExprValue woyExpr = DateTimeFunctions.exprWeek(dateValue, modeValue);`
`65`		`- return woyExpr.valueForCalcite();`
	`65`	`+ return (int) woyExpr.valueForCalcite();`
`66`	`66`	`}`
`67`	`67`	`}`
`68`	`68`	`}`