mcvsubbu commented on a change in pull request #5349:
URL: https://github.com/apache/incubator-pinot/pull/5349#discussion_r422285413



##########
File path: pinot-spi/src/main/java/org/apache/pinot/spi/data/Schema.java
##########
@@ -451,118 +452,87 @@ public SchemaBuilder setSchemaName(String schemaName) {
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields

Review comment:
       ```suggestion
        * Add single value dimensionFieldSpec
   ```
   the word `fields` in the comment is confusing.
   
   I am also fine omitting javadocs from methods that are self-describing in 
the method name (and args)

##########
File path: pinot-spi/src/main/java/org/apache/pinot/spi/data/Schema.java
##########
@@ -451,118 +452,87 @@ public SchemaBuilder setSchemaName(String schemaName) {
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields
+     */
     public SchemaBuilder addSingleValueDimension(String dimensionName, 
DataType dataType) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, true));
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields plus 
defaultNullValue
+     */
     public SchemaBuilder addSingleValueDimension(String dimensionName, 
DataType dataType, Object defaultNullValue) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, true, 
defaultNullValue));
       return this;
     }
 
+    /**
+     * Add multi value dimensionFieldSpec with basic fields
+     */
     public SchemaBuilder addMultiValueDimension(String dimensionName, DataType 
dataType) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, false));
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields plus 
defaultNullValue

Review comment:
       ```suggestion
        * Add single value dimensionFieldSpec with defaultNullValue
   ```

##########
File path: pinot-spi/src/main/java/org/apache/pinot/spi/data/Schema.java
##########
@@ -451,118 +452,87 @@ public SchemaBuilder setSchemaName(String schemaName) {
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields
+     */
     public SchemaBuilder addSingleValueDimension(String dimensionName, 
DataType dataType) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, true));
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields plus 
defaultNullValue

Review comment:
       ```suggestion
        * Add single value dimensionFieldSpec with a defaultNullValue
   ```

##########
File path: pinot-spi/src/main/java/org/apache/pinot/spi/data/Schema.java
##########
@@ -451,118 +452,87 @@ public SchemaBuilder setSchemaName(String schemaName) {
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields
+     */
     public SchemaBuilder addSingleValueDimension(String dimensionName, 
DataType dataType) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, true));
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields plus 
defaultNullValue
+     */
     public SchemaBuilder addSingleValueDimension(String dimensionName, 
DataType dataType, Object defaultNullValue) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, true, 
defaultNullValue));
       return this;
     }
 
+    /**
+     * Add multi value dimensionFieldSpec with basic fields

Review comment:
       ```suggestion
        * Add multi value dimensionFieldSpec
   ```

##########
File path: pinot-spi/src/main/java/org/apache/pinot/spi/data/Schema.java
##########
@@ -451,118 +452,87 @@ public SchemaBuilder setSchemaName(String schemaName) {
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields
+     */
     public SchemaBuilder addSingleValueDimension(String dimensionName, 
DataType dataType) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, true));
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields plus 
defaultNullValue
+     */
     public SchemaBuilder addSingleValueDimension(String dimensionName, 
DataType dataType, Object defaultNullValue) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, true, 
defaultNullValue));
       return this;
     }
 
+    /**
+     * Add multi value dimensionFieldSpec with basic fields
+     */
     public SchemaBuilder addMultiValueDimension(String dimensionName, DataType 
dataType) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, false));
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields plus 
defaultNullValue
+     */
     public SchemaBuilder addMultiValueDimension(String dimensionName, DataType 
dataType, Object defaultNullValue) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, false, 
defaultNullValue));
       return this;
     }
 
+    /**
+     * Add metricFieldSpec with basic fields

Review comment:
       ```suggestion
        * Add metricFieldSpec
   ```

##########
File path: pinot-spi/src/main/java/org/apache/pinot/spi/data/Schema.java
##########
@@ -451,118 +452,87 @@ public SchemaBuilder setSchemaName(String schemaName) {
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields
+     */
     public SchemaBuilder addSingleValueDimension(String dimensionName, 
DataType dataType) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, true));
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields plus 
defaultNullValue
+     */
     public SchemaBuilder addSingleValueDimension(String dimensionName, 
DataType dataType, Object defaultNullValue) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, true, 
defaultNullValue));
       return this;
     }
 
+    /**
+     * Add multi value dimensionFieldSpec with basic fields
+     */
     public SchemaBuilder addMultiValueDimension(String dimensionName, DataType 
dataType) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, false));
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields plus 
defaultNullValue
+     */
     public SchemaBuilder addMultiValueDimension(String dimensionName, DataType 
dataType, Object defaultNullValue) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, false, 
defaultNullValue));
       return this;
     }
 
+    /**
+     * Add metricFieldSpec with basic fields
+     */
     public SchemaBuilder addMetric(String metricName, DataType dataType) {
       _schema.addField(new MetricFieldSpec(metricName, dataType));
       return this;
     }
 
+    /**
+     * Add metricFieldSpec with basic fields plus defaultNullValue
+     */
     public SchemaBuilder addMetric(String metricName, DataType dataType, 
Object defaultNullValue) {
       _schema.addField(new MetricFieldSpec(metricName, dataType, 
defaultNullValue));
       return this;
     }
 
-    public SchemaBuilder addTime(String incomingName, TimeUnit 
incomingTimeUnit, DataType incomingDataType) {
-      _schema.addField(new TimeFieldSpec(incomingName, incomingDataType, 
incomingTimeUnit));
-      return this;
-    }
-
-    public SchemaBuilder addTime(String incomingName, TimeUnit 
incomingTimeUnit, DataType incomingDataType,
-        Object defaultNullValue) {
-      _schema.addField(new TimeFieldSpec(incomingName, incomingDataType, 
incomingTimeUnit, defaultNullValue));
-      return this;
-    }
-
-    public SchemaBuilder addTime(String incomingName, TimeUnit 
incomingTimeUnit, DataType incomingDataType,
-        String outgoingName, TimeUnit outgoingTimeUnit, DataType 
outgoingDataType) {
-      _schema.addField(
-          new TimeFieldSpec(incomingName, incomingDataType, incomingTimeUnit, 
outgoingName, outgoingDataType,
-              outgoingTimeUnit));
-      return this;
-    }
-
-    public SchemaBuilder addTime(String incomingName, TimeUnit 
incomingTimeUnit, DataType incomingDataType,
-        String outgoingName, TimeUnit outgoingTimeUnit, DataType 
outgoingDataType, Object defaultNullValue) {
-      _schema.addField(
-          new TimeFieldSpec(incomingName, incomingDataType, incomingTimeUnit, 
outgoingName, outgoingDataType,
-              outgoingTimeUnit, defaultNullValue));
-      return this;
-    }
-
-    public SchemaBuilder addTime(String incomingName, int 
incomingTimeUnitSize, TimeUnit incomingTimeUnit,
-        DataType incomingDataType) {
-      _schema.addField(new TimeFieldSpec(incomingName, incomingDataType, 
incomingTimeUnitSize, incomingTimeUnit));
-      return this;
-    }
-
-    public SchemaBuilder addTime(String incomingName, int 
incomingTimeUnitSize, TimeUnit incomingTimeUnit,
-        DataType incomingDataType, Object defaultNullValue) {
-      _schema.addField(
-          new TimeFieldSpec(incomingName, incomingDataType, 
incomingTimeUnitSize, incomingTimeUnit, defaultNullValue));
-      return this;
-    }
-
-    public SchemaBuilder addTime(String incomingName, int 
incomingTimeUnitSize, TimeUnit incomingTimeUnit,
-        DataType incomingDataType, String outgoingName, int 
outgoingTimeUnitSize, TimeUnit outgoingTimeUnit,
-        DataType outgoingDataType) {
-      _schema.addField(
-          new TimeFieldSpec(incomingName, incomingDataType, 
incomingTimeUnitSize, incomingTimeUnit, outgoingName,
-              outgoingDataType, outgoingTimeUnitSize, outgoingTimeUnit));
-      return this;
-    }
-
-    public SchemaBuilder addTime(String incomingName, int 
incomingTimeUnitSize, TimeUnit incomingTimeUnit,
-        DataType incomingDataType, String outgoingName, int 
outgoingTimeUnitSize, TimeUnit outgoingTimeUnit,
-        DataType outgoingDataType, Object defaultNullValue) {
-      _schema.addField(
-          new TimeFieldSpec(incomingName, incomingDataType, 
incomingTimeUnitSize, incomingTimeUnit, outgoingName,
-              outgoingDataType, outgoingTimeUnitSize, outgoingTimeUnit, 
defaultNullValue));
-      return this;
-    }
-
-    public SchemaBuilder addTime(TimeGranularitySpec 
incomingTimeGranularitySpec) {
-      _schema.addField(new TimeFieldSpec(incomingTimeGranularitySpec));
-      return this;
-    }
-
-    public SchemaBuilder addTime(TimeGranularitySpec 
incomingTimeGranularitySpec, Object defaultNullValue) {
-      _schema.addField(new TimeFieldSpec(incomingTimeGranularitySpec, 
defaultNullValue));
-      return this;
-    }
-
+    /**
+     * Add timeFieldSpec with incoming and outgoing granularity spec
+     * TODO: This is deprecated in favor of addDateTime().

Review comment:
       Can we annotate it with `@Deprecated` so as to prevent new usage of the 
method? 
   I suspect there are no alternative methods at this point, so you can specify 
exactly what conditions this method must be used (e.g. testing backward compat, 
like you have already done) perhaps with an `@note` annotation.

##########
File path: pinot-spi/src/main/java/org/apache/pinot/spi/data/Schema.java
##########
@@ -451,118 +452,87 @@ public SchemaBuilder setSchemaName(String schemaName) {
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields
+     */
     public SchemaBuilder addSingleValueDimension(String dimensionName, 
DataType dataType) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, true));
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields plus 
defaultNullValue
+     */
     public SchemaBuilder addSingleValueDimension(String dimensionName, 
DataType dataType, Object defaultNullValue) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, true, 
defaultNullValue));
       return this;
     }
 
+    /**
+     * Add multi value dimensionFieldSpec with basic fields
+     */
     public SchemaBuilder addMultiValueDimension(String dimensionName, DataType 
dataType) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, false));
       return this;
     }
 
+    /**
+     * Add single value dimensionFieldSpec with basic fields plus 
defaultNullValue
+     */
     public SchemaBuilder addMultiValueDimension(String dimensionName, DataType 
dataType, Object defaultNullValue) {
       _schema.addField(new DimensionFieldSpec(dimensionName, dataType, false, 
defaultNullValue));
       return this;
     }
 
+    /**
+     * Add metricFieldSpec with basic fields
+     */
     public SchemaBuilder addMetric(String metricName, DataType dataType) {
       _schema.addField(new MetricFieldSpec(metricName, dataType));
       return this;
     }
 
+    /**
+     * Add metricFieldSpec with basic fields plus defaultNullValue

Review comment:
       ```suggestion
        * Add metricFieldSpec with defaultNullValue
   ```




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
[email protected]



---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to