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 Object	doAssignmentBefore(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, int index, int colIndex, RowType rowType, Object value) Execute write cell 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, int index, int colIndex, RowType rowType) 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, Object obj, int index, RowType rowType) Execute write row listener
static void	doCompleteSheet(ExcelWriterContext context) Execute write sheet listener
static void	doCreateRowBefore(Map<Class<? extends ExcelWriteListener>,List<ExcelWriteListener>> excelListeners, org.apache.poi.ss.usermodel.Sheet sheet, int index, RowType rowType) Before you create a row
static <R> void	doReadBefore(List<ExcelReadListener> listeners, ExcelReaderContext<R> context) Before you start reading the data
static Object	doReadCell(List<ExcelReadListener> rowReadListeners, Object cellValue, Field field, int rowIndex, int colIndex, RowType rowType) Execute read row listener
static <R> boolean	doReadEmpty(List<ExcelReadListener> emptyReadListeners, R r, Field field, ExcelField excelField, int rowIndex, int colIndex) Execute read empty listener
static <R> void	doReadFinish(List<ExcelReadListener> rowReadListeners, ExcelReaderContext<R> context) Execute read row listener
static <R> boolean	doReadRow(List<ExcelReadListener> rowReadListeners, R r, List<?> otherValues, int rowIndex, RowType rowType) 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,
                                  int index,
                                  int colIndex,
                                  RowType rowType)

Execute write cell listener

参数:

excelListeners - excelListeners

sheet - Current sheet

row - Current row

cell - Current cell

index - Data indexing, depending on the row type, starts at 0

colIndex - Current cell index

rowType - Current row type

excelField - ExcelField annotation of current field

field - Current field

doAssignmentBefore

public static Object doAssignmentBefore(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,
                                        int index,
                                        int colIndex,
                                        RowType rowType,
                                        Object value)

Execute write cell listener

参数:

excelListeners - excelListeners

sheet - Current sheet

row - Current row

cell - Current cell

index - Data indexing, depending on the row type, starts at 0

colIndex - Current cell index

rowType - Current row type

excelField - ExcelField annotation of current field

field - Current field

value - Cell value

返回:

Cell value

doCreateRowBefore

public static void doCreateRowBefore(Map<Class<? extends ExcelWriteListener>,List<ExcelWriteListener>> excelListeners,
                                     org.apache.poi.ss.usermodel.Sheet sheet,
                                     int index,
                                     RowType rowType)

Before you create a row

参数:

sheet - Current sheet

index - Data indexing, depending on the row type, starts at 0

rowType - Current row type

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,
                                 Object obj,
                                 int index,
                                 RowType rowType)

Execute write row listener

参数:

excelListeners - excelListeners

sheet - Current sheet

row - Create the finished row

obj - Current java object

index - Data indexing, depending on the row type, starts at 0

rowType - Current row type

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<?> otherValues,
                                    int rowIndex,
                                    RowType rowType)

Execute read row listener

类型参数:

R - R

参数:

rowReadListeners - rowReadListeners

r - Generated Java object

rowIndex - The index of the current row

otherValues - Except for the content of the body

rowType - Current row type

返回:

Whether to stop reading

doReadBefore

public static <R> void doReadBefore(List<ExcelReadListener> listeners,
                                    ExcelReaderContext<R> context)

Before you start reading the data

类型参数:

R - The generic

参数:

listeners - Excel read listeners

context - Excel reader context

doReadCell

public static Object doReadCell(List<ExcelReadListener> rowReadListeners,
                                Object cellValue,
                                Field field,
                                int rowIndex,
                                int colIndex,
                                RowType rowType)

Execute read row listener

参数:

rowReadListeners - rowReadListeners

cellValue - Current cell value

field - Current field

rowIndex - Current row index

colIndex - Current col index

rowType - Current row type

返回:

cellValue

doReadFinish

public static <R> void doReadFinish(List<ExcelReadListener> rowReadListeners,
                                    ExcelReaderContext<R> context)

Execute read row listener

类型参数:

R - R

参数:

rowReadListeners - rowReadListeners

context - Excel reader context

doReadEmpty

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

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

返回:

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