Skip to content

Commit 28896c9

Browse files
leto-bleto-b
authored
fix udf develop javadoc links (#775)
1 parent 112de6e commit 28896c9

16 files changed

+56
-56
lines changed

‎src/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ The `validate` method is used to validate the parameters entered by the user.
246246

247247
In this method, you can limit the number and types of input time series, check the attributes of user input, or perform any custom verification.
248248

249-
Please refer to the Javadoc for the usage of `UDFParameterValidator`.
249+
Please refer to the [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/parameter/UDFParameterValidator.java) for the usage of `UDFParameterValidator`.
250250

251251

252252
2. **void beforeStart(UDFParameters parameters, UDTFConfigurations configurations) throws Exception**
@@ -343,7 +343,7 @@ The first type of parameters are optional. If the parameters are not provided, t
343343

344344
The sliding step parameter is also optional. If the parameter is not provided, the sliding step will be set to the same as the time interval for dividing the time axis.
345345

346-
The relationship between the three types of parameters can be seen in the figure below. Please see the Javadoc for more details.
346+
The relationship between the three types of parameters can be seen in the figure below. Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/SlidingTimeWindowAccessStrategy.java) for more details.
347347

348348
<div style="text-align: center;"><img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="/img/github/99787878-47b51480-2b5b-11eb-8ed3-84088c5c30f7.png"></div>
349349

@@ -388,7 +388,7 @@ Window opening diagram: **For numerical data, if the state difference is less th
388388

389389
StateWindowAccessStrategy can only take one column as input for now.
390390

391-
Please see the Javadoc for more details.
391+
Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/StateWindowAccessStrategy.java) for more details.
392392

393393
2.2.2 **setOutputDataType**
394394

@@ -455,7 +455,7 @@ public class Adder implements UDTF {
455455

456456
@Override
457457
public Object transform(Row row) throws Exception {
458-
return row.getLong(0) + row.getLong(1);
458+
return row.getLong(0) + row.getLong(1);
459459
}
460460
}
461461
```

‎src/UserGuide/Master/Tree/User-Manual/User-defined-function_timecho.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ The `validate` method is used to validate the parameters entered by the user.
247247

248248
In this method, you can limit the number and types of input time series, check the attributes of user input, or perform any custom verification.
249249

250-
Please refer to the Javadoc for the usage of `UDFParameterValidator`.
250+
Please refer to the [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/parameter/UDFParameterValidator.java) for the usage of `UDFParameterValidator`.
251251

252252

253253
2. **void beforeStart(UDFParameters parameters, UDTFConfigurations configurations) throws Exception**
@@ -344,7 +344,7 @@ The first type of parameters are optional. If the parameters are not provided, t
344344

345345
The sliding step parameter is also optional. If the parameter is not provided, the sliding step will be set to the same as the time interval for dividing the time axis.
346346

347-
The relationship between the three types of parameters can be seen in the figure below. Please see the Javadoc for more details.
347+
The relationship between the three types of parameters can be seen in the figure below. Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/SlidingTimeWindowAccessStrategy.java) for more details.
348348

349349
<div style="text-align: center;"><img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="/img/github/99787878-47b51480-2b5b-11eb-8ed3-84088c5c30f7.png"></div>
350350

@@ -389,7 +389,7 @@ Window opening diagram: **For numerical data, if the state difference is less th
389389

390390
StateWindowAccessStrategy can only take one column as input for now.
391391

392-
Please see the Javadoc for more details.
392+
Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/StateWindowAccessStrategy.java) for more details.
393393

394394
2.2.2 **setOutputDataType**
395395

@@ -456,7 +456,7 @@ public class Adder implements UDTF {
456456

457457
@Override
458458
public Object transform(Row row) throws Exception {
459-
return row.getLong(0) + row.getLong(1);
459+
return row.getLong(0) + row.getLong(1);
460460
}
461461
}
462462
```

‎src/UserGuide/V1.3.x/User-Manual/User-defined-function_apache.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ The `validate` method is used to validate the parameters entered by the user.
248248

249249
In this method, you can limit the number and types of input time series, check the attributes of user input, or perform any custom verification.
250250

251-
Please refer to the Javadoc for the usage of `UDFParameterValidator`.
251+
Please refer to the [Javadoc](https://github.com/apache/iotdb/blob/rc/1.3.4-1/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/parameter/UDFParameterValidator.java) for the usage of `UDFParameterValidator`.
252252

253253

254254
2. **void beforeStart(UDFParameters parameters, UDTFConfigurations configurations) throws Exception**
@@ -345,7 +345,7 @@ The first type of parameters are optional. If the parameters are not provided, t
345345

346346
The sliding step parameter is also optional. If the parameter is not provided, the sliding step will be set to the same as the time interval for dividing the time axis.
347347

348-
The relationship between the three types of parameters can be seen in the figure below. Please see the Javadoc for more details.
348+
The relationship between the three types of parameters can be seen in the figure below. Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/1.3.4-1/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/SlidingTimeWindowAccessStrategy.java) for more details.
349349

350350
<div style="text-align: center;"><img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="/img/github/99787878-47b51480-2b5b-11eb-8ed3-84088c5c30f7.png"></div>
351351

@@ -390,7 +390,7 @@ Window opening diagram: **For numerical data, if the state difference is less th
390390

391391
StateWindowAccessStrategy can only take one column as input for now.
392392

393-
Please see the Javadoc for more details.
393+
Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/1.3.4-1/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/StateWindowAccessStrategy.java) for more details.
394394

395395
2.2.2 **setOutputDataType**
396396

‎src/UserGuide/V1.3.x/User-Manual/User-defined-function_timecho.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ The `validate` method is used to validate the parameters entered by the user.
247247

248248
In this method, you can limit the number and types of input time series, check the attributes of user input, or perform any custom verification.
249249

250-
Please refer to the Javadoc for the usage of `UDFParameterValidator`.
250+
Please refer to the [Javadoc](https://github.com/apache/iotdb/blob/rc/1.3.4-1/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/parameter/UDFParameterValidator.java) for the usage of `UDFParameterValidator`.
251251

252252

253253
2. **void beforeStart(UDFParameters parameters, UDTFConfigurations configurations) throws Exception**
@@ -344,7 +344,7 @@ The first type of parameters are optional. If the parameters are not provided, t
344344

345345
The sliding step parameter is also optional. If the parameter is not provided, the sliding step will be set to the same as the time interval for dividing the time axis.
346346

347-
The relationship between the three types of parameters can be seen in the figure below. Please see the Javadoc for more details.
347+
The relationship between the three types of parameters can be seen in the figure below. Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/1.3.4-1/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/SlidingTimeWindowAccessStrategy.java) for more details.
348348

349349
<div style="text-align: center;"><img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="/img/github/99787878-47b51480-2b5b-11eb-8ed3-84088c5c30f7.png"></div>
350350

@@ -389,7 +389,7 @@ Window opening diagram: **For numerical data, if the state difference is less th
389389

390390
StateWindowAccessStrategy can only take one column as input for now.
391391

392-
Please see the Javadoc for more details.
392+
Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/1.3.4-1/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/StateWindowAccessStrategy.java) for more details.
393393

394394
2.2.2 **setOutputDataType**
395395

‎src/UserGuide/dev-1.3/User-Manual/User-defined-function_apache.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ The `validate` method is used to validate the parameters entered by the user.
248248

249249
In this method, you can limit the number and types of input time series, check the attributes of user input, or perform any custom verification.
250250

251-
Please refer to the Javadoc for the usage of `UDFParameterValidator`.
251+
Please refer to the [Javadoc](https://github.com/apache/iotdb/blob/rc/1.3.4-1/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/parameter/UDFParameterValidator.java) for the usage of `UDFParameterValidator`.
252252

253253

254254
2. **void beforeStart(UDFParameters parameters, UDTFConfigurations configurations) throws Exception**
@@ -345,7 +345,7 @@ The first type of parameters are optional. If the parameters are not provided, t
345345

346346
The sliding step parameter is also optional. If the parameter is not provided, the sliding step will be set to the same as the time interval for dividing the time axis.
347347

348-
The relationship between the three types of parameters can be seen in the figure below. Please see the Javadoc for more details.
348+
The relationship between the three types of parameters can be seen in the figure below. Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/1.3.4-1/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/SlidingTimeWindowAccessStrategy.java) for more details.
349349

350350
<div style="text-align: center;"><img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="/img/github/99787878-47b51480-2b5b-11eb-8ed3-84088c5c30f7.png"></div>
351351

@@ -390,7 +390,7 @@ Window opening diagram: **For numerical data, if the state difference is less th
390390

391391
StateWindowAccessStrategy can only take one column as input for now.
392392

393-
Please see the Javadoc for more details.
393+
Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/1.3.4-1/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/StateWindowAccessStrategy.java) for more details.
394394

395395
2.2.2 **setOutputDataType**
396396

@@ -457,7 +457,7 @@ public class Adder implements UDTF {
457457

458458
@Override
459459
public Object transform(Row row) throws Exception {
460-
return row.getLong(0) + row.getLong(1);
460+
return row.getLong(0) + row.getLong(1);
461461
}
462462
}
463463
```

‎src/UserGuide/dev-1.3/User-Manual/User-defined-function_timecho.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ The `validate` method is used to validate the parameters entered by the user.
247247

248248
In this method, you can limit the number and types of input time series, check the attributes of user input, or perform any custom verification.
249249

250-
Please refer to the Javadoc for the usage of `UDFParameterValidator`.
250+
Please refer to the [Javadoc](https://github.com/apache/iotdb/blob/rc/1.3.4-1/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/parameter/UDFParameterValidator.java) for the usage of `UDFParameterValidator`.
251251

252252

253253
2. **void beforeStart(UDFParameters parameters, UDTFConfigurations configurations) throws Exception**
@@ -344,7 +344,7 @@ The first type of parameters are optional. If the parameters are not provided, t
344344

345345
The sliding step parameter is also optional. If the parameter is not provided, the sliding step will be set to the same as the time interval for dividing the time axis.
346346

347-
The relationship between the three types of parameters can be seen in the figure below. Please see the Javadoc for more details.
347+
The relationship between the three types of parameters can be seen in the figure below. Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/1.3.4-1/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/SlidingTimeWindowAccessStrategy.java) for more details.
348348

349349
<div style="text-align: center;"><img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="/img/github/99787878-47b51480-2b5b-11eb-8ed3-84088c5c30f7.png"></div>
350350

@@ -389,7 +389,7 @@ Window opening diagram: **For numerical data, if the state difference is less th
389389

390390
StateWindowAccessStrategy can only take one column as input for now.
391391

392-
Please see the Javadoc for more details.
392+
Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/1.3.4-1/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/StateWindowAccessStrategy.java) for more details.
393393

394394
2.2.2 **setOutputDataType**
395395

@@ -456,7 +456,7 @@ public class Adder implements UDTF {
456456

457457
@Override
458458
public Object transform(Row row) throws Exception {
459-
return row.getLong(0) + row.getLong(1);
459+
return row.getLong(0) + row.getLong(1);
460460
}
461461
}
462462
```

‎src/UserGuide/latest/User-Manual/User-defined-function_apache.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ The `validate` method is used to validate the parameters entered by the user.
246246

247247
In this method, you can limit the number and types of input time series, check the attributes of user input, or perform any custom verification.
248248

249-
Please refer to the Javadoc for the usage of `UDFParameterValidator`.
249+
Please refer to the [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/parameter/UDFParameterValidator.java) for the usage of `UDFParameterValidator`.
250250

251251

252252
2. **void beforeStart(UDFParameters parameters, UDTFConfigurations configurations) throws Exception**
@@ -343,7 +343,7 @@ The first type of parameters are optional. If the parameters are not provided, t
343343

344344
The sliding step parameter is also optional. If the parameter is not provided, the sliding step will be set to the same as the time interval for dividing the time axis.
345345

346-
The relationship between the three types of parameters can be seen in the figure below. Please see the Javadoc for more details.
346+
The relationship between the three types of parameters can be seen in the figure below. Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/SlidingTimeWindowAccessStrategy.java) for more details.
347347

348348
<div style="text-align: center;"><img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="/img/github/99787878-47b51480-2b5b-11eb-8ed3-84088c5c30f7.png"></div>
349349

@@ -388,7 +388,7 @@ Window opening diagram: **For numerical data, if the state difference is less th
388388

389389
StateWindowAccessStrategy can only take one column as input for now.
390390

391-
Please see the Javadoc for more details.
391+
Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/StateWindowAccessStrategy.java) for more details.
392392

393393
2.2.2 **setOutputDataType**
394394

‎src/UserGuide/latest/User-Manual/User-defined-function_timecho.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ The `validate` method is used to validate the parameters entered by the user.
247247

248248
In this method, you can limit the number and types of input time series, check the attributes of user input, or perform any custom verification.
249249

250-
Please refer to the Javadoc for the usage of `UDFParameterValidator`.
250+
Please refer to the [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/parameter/UDFParameterValidator.java) for the usage of `UDFParameterValidator`.
251251

252252

253253
2. **void beforeStart(UDFParameters parameters, UDTFConfigurations configurations) throws Exception**
@@ -344,7 +344,7 @@ The first type of parameters are optional. If the parameters are not provided, t
344344

345345
The sliding step parameter is also optional. If the parameter is not provided, the sliding step will be set to the same as the time interval for dividing the time axis.
346346

347-
The relationship between the three types of parameters can be seen in the figure below. Please see the Javadoc for more details.
347+
The relationship between the three types of parameters can be seen in the figure below. Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/SlidingTimeWindowAccessStrategy.java) for more details.
348348

349349
<div style="text-align: center;"><img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="/img/github/99787878-47b51480-2b5b-11eb-8ed3-84088c5c30f7.png"></div>
350350

@@ -389,7 +389,7 @@ Window opening diagram: **For numerical data, if the state difference is less th
389389

390390
StateWindowAccessStrategy can only take one column as input for now.
391391

392-
Please see the Javadoc for more details.
392+
Please see the [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/StateWindowAccessStrategy.java) for more details.
393393

394394
2.2.2 **setOutputDataType**
395395

‎src/zh/UserGuide/Master/Tree/User-Manual/User-defined-function_apache.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ udf_reader_transformer_collector_memory_proportion=1:1:1
244244

245245
您可以在该方法中限制输入序列的数量和类型，检查用户输入的属性或者进行自定义逻辑的验证。
246246

247-
`UDFParameterValidator`的使用方法请见 Javadoc。
247+
`UDFParameterValidator`的使用方法请见 [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/parameter/UDFParameterValidator.java)。
248248

249249
2. **void beforeStart(UDFParameters parameters, UDTFConfigurations configurations) throws Exception**
250250

@@ -334,7 +334,7 @@ void beforeStart(UDFParameters parameters, UDTFConfigurations configurations) th
334334

335335
滑动步长参数也不是必须的。当您不提供滑动步长参数时，滑动步长会被设定为划分时间轴的时间间隔。
336336

337-
3 类参数的关系可见下图。策略的构造方法详见 Javadoc。
337+
3 类参数的关系可见下图。策略的构造方法详见 [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/SlidingTimeWindowAccessStrategy.java)。
338338

339339
<img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="/img/github/99787878-47b51480-2b5b-11eb-8ed3-84088c5c30f7.png">
340340

@@ -378,7 +378,7 @@ void beforeStart(UDFParameters parameters, UDTFConfigurations configurations) th
378378
3. 针对数值型数据，可以只提供单个窗口内部允许变化的阈值delta，时间轴显示时间窗开始时间会被定义为整个查询结果集中最小的时间戳，时间轴显示时间窗结束时间会被定义为整个查询结果集中最大的时间戳。
379379
4. 针对文本数据以及布尔数据，可以不提供任何参数，开始与结束时间戳见3中解释。
380380

381-
StateWindowAccessStrategy 目前只能接收一列输入。策略的构造方法详见 Javadoc。
381+
StateWindowAccessStrategy 目前只能接收一列输入。策略的构造方法详见 [Javadoc](https://github.com/apache/iotdb/blob/rc/2.0.4/iotdb-api/udf-api/src/main/java/org/apache/iotdb/udf/api/customizer/strategy/StateWindowAccessStrategy.java)。
382382

383383
2.2.2 **setOutputDataType**
384384

@@ -446,7 +446,7 @@ public class Adder implements UDTF {
446446

447447
@Override
448448
public Object transform(Row row) throws Exception {
449-
return row.getLong(0) + row.getLong(1);
449+
return row.getLong(0) + row.getLong(1);
450450
}
451451
}
452452
```

0 commit comments

Comments
 (0)