优化文档注释
This commit is contained in:
彭宇琦
parent
3b4804d671
commit
1057cc33a5
|
|
@ -12,8 +12,6 @@ import java.util.stream.Collectors;
|
|||
import java.util.stream.IntStream;
|
||||
import java.util.stream.Stream;
|
||||
|
||||
import pres.auxiliary.work.selenium.element.DataListBy;
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* <b>文件名：</b>TableData.java
|
||||
|
|
@ -70,7 +68,7 @@ public class TableData<T> {
|
|||
}
|
||||
|
||||
/**
|
||||
* 用于设置是否对传入的数据列表的个数进行严格校验，即在调用{@link #addList(DataListBy)}方法时，
|
||||
* 用于设置是否对传入的数据列表的个数进行严格校验，即在调用{@link #getData(int, int, List)}等获取数据的方法时，
|
||||
* 若数据个数与初次传入的个数不符且需要严格校验，则抛出异常；反之，则直接进行存储
|
||||
*
|
||||
* @param isExamine 是否严格校验数据个数
|
||||
|
|
@ -428,7 +426,7 @@ public class TableData<T> {
|
|||
*
|
||||
* @param startRowIndex 起始下标
|
||||
* @param endRowIndex 结束下标
|
||||
* @param columnNames 列名称组，可传入多个值
|
||||
* @param columnNameList 列名称集合
|
||||
* @return 按照字段顺序获取的列数据
|
||||
* @throws IllegalDataException 需要严格检查且存在列数据不同时抛出的异常
|
||||
*/
|
||||
|
|
@ -473,9 +471,10 @@ public class TableData<T> {
|
|||
}
|
||||
|
||||
/**
|
||||
* 用于根据行下标，获取一行数据。其下标传入规则可参考{@link #getData(int, int, List)}
|
||||
* 用于根据行下标，获取多行数据。其下标传入规则可参考{@link #getData(int, int, List)}
|
||||
*
|
||||
* @param index 行下标
|
||||
* @param startIndex 起始行下标
|
||||
* @param endIndex 结束行下标
|
||||
* @return 对应行下标的数据集合
|
||||
* @throws IllegalDataException 需要严格检查且存在列数据不同时抛出的异常
|
||||
*/
|
||||
|
|
@ -490,7 +489,7 @@ public class TableData<T> {
|
|||
* 规则可参考{@link #getData(int, int, List)}
|
||||
* </p>
|
||||
*
|
||||
* @param stratIndex 起始下标
|
||||
* @param startIndex 起始下标
|
||||
* @param endIndex 结束下标
|
||||
* @return 流的形式返回行数据
|
||||
* @throws IllegalDataException 需要严格检查且存在列数据不同时抛出的异常
|
||||
|
|
|
|||
|
|
@ -28,6 +28,7 @@ import org.apache.poi.xwpf.usermodel.XWPFParagraph;
|
|||
|
||||
import com.opencsv.CSVReader;
|
||||
|
||||
import pres.auxiliary.tool.data.IllegalDataException;
|
||||
import pres.auxiliary.tool.data.TableData;
|
||||
import pres.auxiliary.tool.date.Time;
|
||||
|
||||
|
|
@ -81,12 +82,12 @@ public class TableFileReadUtil {
|
|||
private static final String FILE_SUFFIX_TXT = "txt";
|
||||
|
||||
/**
|
||||
* 根据传入文件格式，将文件的内容进行转换。该构造方法主要在用于读取Excel文件和文本文件上：
|
||||
* 根据传入文件格式，将文件的内容进行转换。其转换规则如下：
|
||||
* <ol>
|
||||
* <li>当读取的文件为Excel文件（xls/xlsx格式）时，其传入的regex表示需要读取的sheet名称</li>
|
||||
* <li>当读取的文件为文本文件（doc/docx/txt格式）时，其传入的regex表示对每一行文本的切分规则，以得到一个列表</li>
|
||||
* <li>当读取的文件为CSV文件（csv格式）时，其传入的regex无意义</li>
|
||||
* </ol>
|
||||
* 除上述两种文件类型外，其他的文件调用该构造方法时，则等同于调用{@link #ListFileRead(File, String)}
|
||||
*
|
||||
* @param file 待读取的文件对象
|
||||
* @param pattern sheet名称或切分文本的规则
|
||||
|
|
@ -323,7 +324,7 @@ public class TableFileReadUtil {
|
|||
* 该方法用于读取并处理旧版(后缀为“.doc”)word文件，可通过切分规则对文本每一行的内容进行切分
|
||||
*
|
||||
* @param file 文件
|
||||
* @param sheetName 切分规则
|
||||
* @param regex 切分规则
|
||||
* @param isFirstTitle 首行是否为标题行
|
||||
* @return 数据表类对象
|
||||
* @throws UnsupportedFileException 文件未传入或读取异常时抛出的异常
|
||||
|
|
@ -388,7 +389,7 @@ public class TableFileReadUtil {
|
|||
* 该方法用于读取并处理新版(后缀为“.docx”)word文件，可通过切分规则对文本每一行的内容进行切分
|
||||
*
|
||||
* @param file 文件
|
||||
* @param sheetName 切分规则
|
||||
* @param regex 切分规则
|
||||
* @param isFirstTitle 首行是否为标题行
|
||||
* @return 数据表类对象
|
||||
* @throws UnsupportedFileException 文件未传入或读取异常时抛出的异常
|
||||
|
|
|
|||
|
|
@ -52,7 +52,6 @@ import pres.auxiliary.tool.data.TableData;
|
|||
* @version Ver1.0
|
||||
* @since JDK 1.8
|
||||
*
|
||||
* @param <T> 子类本身
|
||||
*/
|
||||
public class SqlAction {
|
||||
/**
|
||||
|
|
@ -80,7 +79,7 @@ public class SqlAction {
|
|||
* @param username 用户名
|
||||
* @param password 密码
|
||||
* @param host 主机（包括端口）
|
||||
* @param dataBase 数据源
|
||||
* @param dataBaseName 数据源
|
||||
*/
|
||||
public SqlAction(DataBaseType dataBaseType, String username, String password, String host, String dataBaseName) {
|
||||
try {
|
||||
|
|
@ -96,11 +95,9 @@ public class SqlAction {
|
|||
}
|
||||
|
||||
/**
|
||||
* 运行指定的SQL语句，支持多条SQL执行，每条SQL语句间需要使用分号进行分隔。注意，
|
||||
* 执行多条语句时，若其中一条语句无法执行，则抛出异常，并结束所有语句的执行，且不会保存结果集。
|
||||
* 运行指定的SQL语句。
|
||||
*
|
||||
* @param sqlText SQL语句
|
||||
* @param isClear 是否清空原结果集
|
||||
* @return 类本身
|
||||
* @throws DatabaseException 当SQL语句为空或执行有误时，抛出的异常
|
||||
*/
|
||||
|
|
@ -252,7 +249,7 @@ public class SqlAction {
|
|||
* 即调用{@code getRowResult(1, 1, 2)}方法时，表示获取第1列，第1行到第2行的数据
|
||||
* </p>
|
||||
*
|
||||
* @param fieldName 字段名称
|
||||
* @param fieldIndex 列下标
|
||||
* @param startIndex 起始下标
|
||||
* @param endIndex 结束下标
|
||||
* @return 第一列指定行的元素集合
|
||||
|
|
|
|||
Loading…
Reference in New Issue