diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/WCell.java b/src/main/resources/modules/SpringBoot/java/frame/excel/WCell.java index 5b1791bf..44f24938 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/WCell.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/WCell.java @@ -3,22 +3,24 @@ package ${basePackage}.frame.excel; import java.io.Serializable; +/** + * WCell - Excel单元格对象 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public class WCell implements Serializable { - private String value; - /** - * 默认无参构造方法.会将单元格的状态设为通过. + * 单元格的值，任意格式都将转化为字符类型 */ + private String value; + public WCell() { this.value = ""; } - /** - * 传入默认单元格值的构造方法. - * - * @param value 单元格的值. - */ public WCell(String value) { this.value = value; } diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/WColumn.java b/src/main/resources/modules/SpringBoot/java/frame/excel/WColumn.java index 7c6f5356..27536f4f 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/WColumn.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/WColumn.java @@ -8,9 +8,11 @@ import java.io.Serializable; import java.lang.reflect.Field; /** - * DataTable中的表头，包含本列的一些限制条件。
- * 现有：列名、是否必须、是否允许重复、说明字段以及数据类型 - * Created by edward on 9/19/14. + * WColumn - Excel列对象(包含列名，长度，必须项，列描述，指定转换器) + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 */ public class WColumn implements Serializable { /** @@ -18,13 +20,9 @@ public class WColumn implements Serializable { */ private String name; /** - * 该列的最大宽度 + * 列宽度 */ private int cellWidth; - /** - * 是否为隐藏列，如果为隐藏列，在导出Excel文件时会被忽略 - */ - private boolean isHidden; /** * 是否是必输列 */ @@ -58,7 +56,6 @@ public class WColumn implements Serializable { this.description = ""; } - //----------- getter & setter -------------- public String getName() { return name; } diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/WRow.java b/src/main/resources/modules/SpringBoot/java/frame/excel/WRow.java index 76aea009..4cd4638a 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/WRow.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/WRow.java @@ -6,11 +6,11 @@ import java.util.HashMap; import java.util.List; /** - * DataTable中的行对象. - * Created on 2014/09/19. + * WRow - Excel行对象，即数据WCell容器
继承至HashMap,key为列名，value为单元对象 * - * @author - * @since 0.1.0 + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 */ public class WRow extends HashMap implements Serializable { diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/WSheet.java b/src/main/resources/modules/SpringBoot/java/frame/excel/WSheet.java index 9ef34e26..7bd77420 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/WSheet.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/WSheet.java @@ -25,11 +25,11 @@ import java.text.SimpleDateFormat; import java.util.*; /** - * 数据表的定义。
- * Created on 2014/09/19. + * WSheet - Excel-Sheet对象，完整的数据集合对象。 * - * @author 沈振家 - * @since 0.1.0 + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 */ public class WSheet implements Serializable, Cloneable { diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/ColumnDescription.java b/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/ColumnDescription.java index 882f7140..8e3a99cd 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/ColumnDescription.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/ColumnDescription.java @@ -3,10 +3,11 @@ package ${basePackage}.frame.excel.annotation; import java.lang.annotation.*; /** - * Created on 2014/9/24. + * ColumnDescription - Excel列描述注解 * - * @author - * @version v1.0.0.0 + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 */ @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/ColumnName.java b/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/ColumnName.java index c702d9e7..3ce1657c 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/ColumnName.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/ColumnName.java @@ -3,11 +3,11 @@ package ${basePackage}.frame.excel.annotation; import java.lang.annotation.*; /** - * 为字段、方法或类注解名称。
- * Created on 2014/9/24. + * ColumnName - Excel列名称注解，当Excel模板没有该注解则使用字段名作为列名称 * - * @author - * @version v1.0.0.0 + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 */ @Target({ElementType.FIELD, ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/Converter.java b/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/Converter.java index 7b178ecf..a27bdf88 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/Converter.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/Converter.java @@ -3,10 +3,11 @@ package ${basePackage}.frame.excel.annotation; import java.lang.annotation.*; /** - * 优先通过target来获取转换器 + * Converter - Excel列转化器注解 * - * @author 王兵 - * @version v0.0.1 + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 */ @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/Ignore.java b/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/Ignore.java index b3ec0436..860ed9db 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/Ignore.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/Ignore.java @@ -3,10 +3,11 @@ package ${basePackage}.frame.excel.annotation; import java.lang.annotation.*; /** - * 是否忽略表字段 + * Ignore - Excel列忽略注解，在导入导出过程中不会对存在该注解的字典进行解析 * - * @author 金洋 - * @since 2.1.0 + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 */ @Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/ParentFirst.java b/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/ParentFirst.java index d79cbc1f..44687688 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/ParentFirst.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/ParentFirst.java @@ -3,10 +3,11 @@ package ${basePackage}.frame.excel.annotation; import java.lang.annotation.*; /** - * 是否关注父类的字段 + * ParentFirst - 是否读取父类的属性，默认否 * - * @author 金洋 - * @since 2.1.0 + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 */ @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/SheetName.java b/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/SheetName.java index 5e3c7cd3..0b857a2b 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/SheetName.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/annotation/SheetName.java @@ -3,11 +3,11 @@ package ${basePackage}.frame.excel.annotation; import java.lang.annotation.*; /** - * 为字段、方法或类注解名称。
- * Created on 2014/9/24. + * SheetName - 工作表名称，当Excel模板没有该注解则使用Class类名作为工作表默认名称 * - * @author - * @version v1.0.0.0 + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 */ @Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/BooleanConverter.java b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/BooleanConverter.java index 40f39163..ce897e4b 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/BooleanConverter.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/BooleanConverter.java @@ -1,5 +1,12 @@ package ${basePackage}.frame.excel.converter; +/** + * BooleanConverter - Boolean转化器，重写了对象到String，String到对象的转化方式 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public class BooleanConverter implements Converter { @Override diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/ByteConverter.java b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/ByteConverter.java index 6ab92a74..6d631268 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/ByteConverter.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/ByteConverter.java @@ -1,5 +1,12 @@ package ${basePackage}.frame.excel.converter; +/** + * ByteConverter - Byte转化器，重写了对象到String，String到对象的转化方式 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public class ByteConverter implements Converter { @Override diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/CharacterConverter.java b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/CharacterConverter.java index 55ff31e1..cbe76bb1 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/CharacterConverter.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/CharacterConverter.java @@ -1,5 +1,12 @@ package ${basePackage}.frame.excel.converter; +/** + * CharacterConverter - Character转化器，重写了对象到String，String到对象的转化方式 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public class CharacterConverter implements Converter { @Override diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/Converter.java b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/Converter.java index ebf412b2..1adea27f 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/Converter.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/Converter.java @@ -1,5 +1,12 @@ package ${basePackage}.frame.excel.converter; +/** + * Converter - 转化器接口，所有转化器必须实现该接口 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public interface Converter { T convert(String var); diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/DateConverter.java b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/DateConverter.java index d2b2bf34..6d242491 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/DateConverter.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/DateConverter.java @@ -4,6 +4,13 @@ import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.Date; +/** + * DateConverter - Date转化器，重写了对象到String，String到对象的转化方式 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public class DateConverter implements Converter { @Override diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/DoubleConverter.java b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/DoubleConverter.java index 5ddd0388..ce5e1508 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/DoubleConverter.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/DoubleConverter.java @@ -1,5 +1,12 @@ package ${basePackage}.frame.excel.converter; +/** + * DoubleConverter - Double转化器，重写了对象到String，String到对象的转化方式 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public class DoubleConverter implements Converter { @Override diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/FloatConverter.java b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/FloatConverter.java index 43b2f89f..009fe3ca 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/FloatConverter.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/FloatConverter.java @@ -1,5 +1,12 @@ package ${basePackage}.frame.excel.converter; +/** + * FloatConverter - Float转化器，重写了对象到String，String到对象的转化方式 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public class FloatConverter implements Converter { @Override diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/IntegerConverter.java b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/IntegerConverter.java index 669c4b56..034862ed 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/IntegerConverter.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/IntegerConverter.java @@ -1,5 +1,12 @@ package ${basePackage}.frame.excel.converter; +/** + * IntegerConverter - Integer转化器，重写了对象到String，String到对象的转化方式 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public class IntegerConverter implements Converter { @Override diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/LongConverter.java b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/LongConverter.java index d8ff31a3..e91b9e81 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/LongConverter.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/LongConverter.java @@ -1,9 +1,15 @@ package ${basePackage}.frame.excel.converter; - import java.util.regex.Matcher; import java.util.regex.Pattern; +/** + * LongConverter - Long转化器，重写了对象到String，String到对象的转化方式 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public class LongConverter implements Converter { @Override diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/ShortConverter.java b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/ShortConverter.java index 82589b1d..ced9c55b 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/ShortConverter.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/ShortConverter.java @@ -1,5 +1,12 @@ package ${basePackage}.frame.excel.converter; +/** + * ShortConverter - Short转化器，重写了对象到String，String到对象的转化方式 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public class ShortConverter implements Converter { @Override diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/StringConverter.java b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/StringConverter.java index fc349c8d..35493117 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/converter/StringConverter.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/converter/StringConverter.java @@ -1,5 +1,12 @@ package ${basePackage}.frame.excel.converter; +/** + * StringConverter - String转化器，重写了对象到String，String到对象的转化方式 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public class StringConverter implements Converter { @Override diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/exception/ReadErrorException.java b/src/main/resources/modules/SpringBoot/java/frame/excel/exception/ReadErrorException.java index f9ad2807..dc5c7a8d 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/exception/ReadErrorException.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/exception/ReadErrorException.java @@ -1,5 +1,12 @@ package ${basePackage}.frame.excel.exception; +/** + * Excel文件读取失败异常 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public class ReadErrorException extends Exception { public ReadErrorException() { } diff --git a/src/main/resources/modules/SpringBoot/java/frame/excel/exception/TemplateNotMatchException.java b/src/main/resources/modules/SpringBoot/java/frame/excel/exception/TemplateNotMatchException.java index 14691f7e..1dff3790 100644 --- a/src/main/resources/modules/SpringBoot/java/frame/excel/exception/TemplateNotMatchException.java +++ b/src/main/resources/modules/SpringBoot/java/frame/excel/exception/TemplateNotMatchException.java @@ -1,5 +1,12 @@ package ${basePackage}.frame.excel.exception; +/** + * Excel文件与模板不匹配时异常 + * + * @author wangbing + * @version 0.0.1 + * @since 2017-01-01 + */ public class TemplateNotMatchException extends Exception { public TemplateNotMatchException() { } diff --git a/src/main/resources/modules/SpringBoot/java/module/system/req/DictCreateRequest.java b/src/main/resources/modules/SpringBoot/java/module/system/req/DictCreateRequest.java index 9eb76a35..4465d8a9 100644 --- a/src/main/resources/modules/SpringBoot/java/module/system/req/DictCreateRequest.java +++ b/src/main/resources/modules/SpringBoot/java/module/system/req/DictCreateRequest.java @@ -4,7 +4,7 @@ import org.hibernate.validator.constraints.Length; import ${basePackage}.frame.base.BaseRequest; import ${basePackage}.frame.excel.annotation.ColumnDescription; import ${basePackage}.frame.excel.annotation.ColumnName; -import xyz.wbsite.frame.excel.annotation.SheetName; +import ${basePackage}.frame.excel.annotation.SheetName; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull;