cn.gjing.tools.excel.util

类 ListenerChain

java.lang.Object

cn.gjing.tools.excel.util.ListenerChain

public final class ListenerChain
extends Object

Excel listener link call tool

作者:

Gjing

构造器概要

构造器

构造器和说明
ListenerChain()

方法概要

限定符和类型	方法和说明
static void	addReadListener(Map<Class<? extends ExcelReadListener>,List<ExcelReadListener>> readListenersCache, ExcelReadListener readListener) Add a read listener
static void	addWriteListener(Map<Class<? extends ExcelWriteListener>,List<ExcelWriteListener>> writeListenerCache, ExcelWriteListener listener, org.apache.poi.ss.usermodel.Workbook workbook) Add a write listener
static void	doCompleteCell(Map<Class<? extends ExcelWriteListener>,List<ExcelWriteListener>> excelListeners, org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.usermodel.Row row, org.apache.poi.ss.usermodel.Cell cell, ExcelField excelField, Field field, String headName, int index, int colIndex, boolean isHead, Object value) Execute write cell listener
static void	doCompleteRow(Map<Class<? extends ExcelWriteListener>,List<ExcelWriteListener>> excelListeners, org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.usermodel.Row row, int index, boolean isHead) Execute write row listener
static void	doCompleteSheet(ExcelWriterContext context) Execute write sheet listener
static <R> void	doReadCell(List<ExcelReadListener> rowReadListeners, R r, Object cellValue, Field field, int rowIndex, int colIndex, boolean isHead) Execute read row listener
static <R> boolean	doReadEmpty(List<ExcelReadListener> emptyReadListeners, R r, Field field, ExcelField excelField, int rowIndex, int colIndex, boolean hasNext) Execute read empty listener
static <R> boolean	doReadRow(List<ExcelReadListener> rowReadListeners, R r, List<String> headNames, int rowIndex, boolean isHead, boolean hasNext) Execute read row listener
static <R> void	doResultNotify(ExcelResultReadListener<R> resultReadListener, List<R> data) Execute result notify listener
static void	doWorkbookFlushBefore(ExcelWriterContext context) Execute write workbook listener

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ListenerChain

public ListenerChain()

方法详细资料

doCompleteCell

public static void doCompleteCell(Map<Class<? extends ExcelWriteListener>,List<ExcelWriteListener>> excelListeners,
                                  org.apache.poi.ss.usermodel.Sheet sheet,
                                  org.apache.poi.ss.usermodel.Row row,
                                  org.apache.poi.ss.usermodel.Cell cell,
                                  ExcelField excelField,
                                  Field field,
                                  String headName,
                                  int index,
                                  int colIndex,
                                  boolean isHead,
                                  Object value)

Execute write cell listener

参数:

excelListeners - excelListeners

sheet - Current sheet

row - Current row

cell - Current cell

index - Line index, index type according to isHead, Starting from 0

colIndex - Current cell index

isHead - Whether is excel head

excelField - ExcelField annotation of current field

field - Current field

value - Cell value

headName - The header name of the list where the cell resides

doCompleteRow

public static void doCompleteRow(Map<Class<? extends ExcelWriteListener>,List<ExcelWriteListener>> excelListeners,
                                 org.apache.poi.ss.usermodel.Sheet sheet,
                                 org.apache.poi.ss.usermodel.Row row,
                                 int index,
                                 boolean isHead)

Execute write row listener

参数:

excelListeners - excelListeners

sheet - Current sheet

row - Create the finished row

index - Line index, index type according to isHead，Starting from 0

isHead - Whether is excel head

doCompleteSheet

public static void doCompleteSheet(ExcelWriterContext context)

Execute write sheet listener

参数:

context - Excel write context

doWorkbookFlushBefore

public static void doWorkbookFlushBefore(ExcelWriterContext context)

Execute write workbook listener

参数:

context - Excel write context

doReadRow

public static <R> boolean doReadRow(List<ExcelReadListener> rowReadListeners,
                                    R r,
                                    List<String> headNames,
                                    int rowIndex,
                                    boolean isHead,
                                    boolean hasNext)

Execute read row listener

类型参数:

R - R

参数:

rowReadListeners - rowReadListeners

r - Generated Java object

rowIndex - The index of the current row

isHead - Whether is excel head

hasNext - Whether has next row

headNames - All the table headers of the current row

返回:

Whether to stop reading

doReadCell

public static <R> void doReadCell(List<ExcelReadListener> rowReadListeners,
                                  R r,
                                  Object cellValue,
                                  Field field,
                                  int rowIndex,
                                  int colIndex,
                                  boolean isHead)

Execute read row listener

类型参数:

R - R

参数:

rowReadListeners - rowReadListeners

r - Current Java object

cellValue - Current cell value

field - Current field

rowIndex - Current row index

colIndex - Current col index

isHead - Whether is excel header

doReadEmpty

public static <R> boolean doReadEmpty(List<ExcelReadListener> emptyReadListeners,
                                      R r,
                                      Field field,
                                      ExcelField excelField,
                                      int rowIndex,
                                      int colIndex,
                                      boolean hasNext)

Execute read empty listener

类型参数:

R - R

参数:

emptyReadListeners - emptyReadListeners

r - Current Java object

field - Current field

excelField - ExcelField annotation on that field

rowIndex - The index of the current row

colIndex - The index of the current col

hasNext - Whether has next row

返回:

Whether to save this data

doResultNotify

public static <R> void doResultNotify(ExcelResultReadListener<R> resultReadListener,
                                      List<R> data)

Execute result notify listener

类型参数:

R - R

参数:

resultReadListener - resultReadListener

data - Import all the Java objects generated after success

addWriteListener

public static void addWriteListener(Map<Class<? extends ExcelWriteListener>,List<ExcelWriteListener>> writeListenerCache,
                                    ExcelWriteListener listener,
                                    org.apache.poi.ss.usermodel.Workbook workbook)

Add a write listener

参数:

writeListenerCache - writeListenerCache

listener - Write listener

workbook - workbook

addReadListener

public static void addReadListener(Map<Class<? extends ExcelReadListener>,List<ExcelReadListener>> readListenersCache,
                                   ExcelReadListener readListener)

Add a read listener

参数:

readListenersCache - readListenersCache

readListener - read Listener