com.moon.poi.excel.table.Descriptor Maven / Gradle / Ivy

Go to download
package com.moon.poi.excel.table;

import com.moon.poi.excel.annotation.TableColumn;
import com.moon.poi.excel.annotation.TableColumnGroup;
import com.moon.poi.excel.annotation.style.DefinitionStyle;

import java.lang.annotation.Annotation;
import java.util.List;
import java.util.function.Function;

/**
 * 字段描述器
 *
 * @author moonsky
 */
interface Descriptor {

    /**
     * 属性名
     *
     * @return 字段名
     */
    String getName();

    /**
     * 获取列标题数组
     *
     * @return 标题
     */
    String[] getTitles();

    /**
     * 获取声明的表头行高
     *
     * @return 行高数组
     */
    short[] getHeadHeightArr();

    /**
     * 获取列宽
     *
     * @return 列宽
     */
    Integer getColumnWidth();

    /**
     * 字段数据类型
     *
     * @return 字段类
     */
    Class getPropertyType();

    /**
     * 获取注解
     *
     * @param annotationType 注解类
     * @param             注解类型
     *
     * @return 注解实例或 null
     */
     T getAnnotation(Class annotationType);

    /**
     * 获取样式定义
     *
     * @return
     */
    List getDefinitionStylesOnMethod();
    /**
     * 获取样式定义
     *
     * @return
     */
    List getDefinitionStylesOnField();

    /**
     * 获取字段注解
     *
     * @return TableColumn
     */
    TableColumn getTableColumn();

    /**
     * 实体字段注解
     *
     * @return TableColumnGroup
     */
    TableColumnGroup getTableColumnGroup();

    /**
     * 读取值，不存在的话返回默认值
     *
     * @param getter TableColumn getter
     * @param dft    默认值
     * @param     返回值类型
     *
     * @return 获取的值
     */
    default  T getOrDefault(
        Function getter, T dft
    ) {
        TableColumn column = getTableColumn();
        return column == null ? dft : getter.apply(column);
    }

    /**
     * 偏移量
     *
     * @return 偏移的值
     */
    default int getOffsetVal() {
        return getOrDefault(col -> col.offset(), 0);
    }

    /**
     * 表头行偏移参与偏移的行数
     * 
     * 任何大于等于表头行数的值代表所有行都便宜；
     * 
     * 小于表头行数的值代表倒数 n 行参与偏移
     *
     * @return
     */
    default int getOffsetHeadRows() {
        return getOrDefault(col -> col.offsetHeadRows(), Integer.MAX_VALUE);
    }

    /**
     * 是否填充
     *
     * @return 偏移单元格
     */
    default boolean isOffsetFillSkipped() { return true; }

    /**
     * 是否是组合列
     *
     * @return true | false
     */
    default boolean isAnnotatedGroup() { return getTableColumnGroup() != null; }

    /**
     * 是否是标记列
     *
     * @return true | false
     */
    default boolean isAnnotated() { return getTableColumn() != null; }
}