Interface ExcelAdapter<T, U extends org.apache.poi.ss.usermodel.Workbook>
- All Known Implementing Classes:
DatasetExcelAdapter, RMExcelWriterXlsx
public interface ExcelAdapter<T, U extends org.apache.poi.ss.usermodel.Workbook>
An adapter interface that supports drawing
Workbooks and Sheets based on the
supplied objects.-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enumThe known types that can be directly set via Apache POI for a cell. -
Method Summary
Modifier and TypeMethodDescriptionbooleanDraws aSheetfor the specificTdefault UdrawWorkbook(boolean headerRow, boolean nullsEmpty, T[] object) drawWorkbook(boolean headerRow, boolean nullsEmpty, T[] object, @Nullable String[] sheetNames)
-
Method Details
-
drawWorkbook
- Parameters:
headerRow- iftrue, header rows are expected to be written, otherwise false. It is up to the implementation whether this is respected or not.nullsEmpty- iftrue, null values will not be written to cells in the excel document. It is up to the implementation whether this is respected or not.object- The object(s) that the Adapter is compatible with for writing.- Returns:
- A
Workbookof typeUthat can be closed or further manipulated.
-
drawWorkbook
- Parameters:
headerRow- iftrue, header rows are expected to be written, otherwise false. It is up to the implementation whether this is respected or not.nullsEmpty- iftrue, null values will not be written to cells in the excel document. It is up to the implementation whether this is respected or not.object- The object(s) that the Adapter is compatible with for writing.sheetNames- The names of the sheets to create. If null, will use a generic default.- Returns:
- A
Workbookof typeUthat can be closed or further manipulated.
-
drawSheet
Draws aSheetfor the specificT- Parameters:
workbook- the Workbook to add the new sheet tosheetName- the name of the sheet. This name should be checked viaWorkbookUtil.createSafeSheetName(String)object- the object to write to the sheetheaderRow- iftrue, header rows are expected to be written, otherwise false. It is up to the implementation whether this is respected or not.nullsEmpty- iftrue, null values will not be written to cells in the excel document. It is up to the implementation whether this is respected or not.- Returns:
trueif the object was successfully written to the workbook as a new sheet,falseif the object was not written successfully.
-