cn.idev.excel.context

Class WriteContextImpl

java.lang.Object

cn.idev.excel.context.WriteContextImpl

All Implemented Interfaces:

WriteContext

public class WriteContextImpl
extends Object
implements WriteContext

Implementation of the WriteContext interface, which serves as the main anchorage point for writing Excel files. This class manages the context for writing workbooks, sheets, and tables, including initialization, handling, and finishing the write process.

Constructor Summary

Constructors

Constructor and Description
WriteContextImpl(WriteWorkbook writeWorkbook) Constructor to initialize the WriteContextImpl with a WriteWorkbook.

Method Summary

Modifier and Type	Method and Description
void	currentSheet(WriteSheet writeSheet, WriteTypeEnum writeType) Sets the current sheet for writing.
void	currentTable(WriteTable writeTable) Sets the current table for writing.
WriteHolder	currentWriteHolder() Retrieves the current write holder.
void	finish(boolean onException) Finishes the write process and releases resources.
org.apache.poi.ss.usermodel.Sheet	getCurrentSheet() Retrieves the current sheet being written.
OutputStream	getOutputStream() Retrieves the output stream for writing the Excel file.
org.apache.poi.ss.usermodel.Workbook	getWorkbook() Retrieves the workbook being written.
void	initHead(ExcelWriteHeadProperty excelWriteHeadProperty) Initializes the header for the current sheet or table.
boolean	needHead() Checks if the current sheet requires a header.
WriteSheetHolder	writeSheetHolder() Retrieves the current sheet holder.
WriteTableHolder	writeTableHolder() Retrieves the current table holder.
WriteWorkbookHolder	writeWorkbookHolder() Retrieves the current workbook holder.

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteContextImpl

public WriteContextImpl(WriteWorkbook writeWorkbook)

Constructor to initialize the WriteContextImpl with a WriteWorkbook.

Parameters:

writeWorkbook - The workbook configuration for writing.

Method Detail

currentSheet

public void currentSheet(WriteSheet writeSheet,
                         WriteTypeEnum writeType)

Sets the current sheet for writing.

Specified by:

currentSheet in interface WriteContext

Parameters:

writeSheet - The sheet configuration for writing.

writeType - The type of write operation.

initHead

public void initHead(ExcelWriteHeadProperty excelWriteHeadProperty)

Initializes the header for the current sheet or table.

Parameters:

excelWriteHeadProperty - The header property for writing.

currentTable

public void currentTable(WriteTable writeTable)

Sets the current table for writing.

Specified by:

currentTable in interface WriteContext

Parameters:

writeTable - The table configuration for writing.

writeWorkbookHolder

public WriteWorkbookHolder writeWorkbookHolder()

Retrieves the current workbook holder.

Specified by:

writeWorkbookHolder in interface WriteContext

Returns:

The current workbook holder.

writeSheetHolder

public WriteSheetHolder writeSheetHolder()

Retrieves the current sheet holder.

Specified by:

writeSheetHolder in interface WriteContext

Returns:

The current sheet holder.

writeTableHolder

public WriteTableHolder writeTableHolder()

Retrieves the current table holder.

Specified by:

writeTableHolder in interface WriteContext

Returns:

The current table holder.

currentWriteHolder

public WriteHolder currentWriteHolder()

Retrieves the current write holder.

Specified by:

currentWriteHolder in interface WriteContext

Returns:

The current write holder.

finish

public void finish(boolean onException)

Finishes the write process and releases resources.

Specified by:

finish in interface WriteContext

Parameters:

onException - Indicates whether the finish is triggered by an exception.

getCurrentSheet

public org.apache.poi.ss.usermodel.Sheet getCurrentSheet()

Retrieves the current sheet being written.

Specified by:

getCurrentSheet in interface WriteContext

Returns:

The current sheet.

needHead

public boolean needHead()

Checks if the current sheet requires a header.

Specified by:

needHead in interface WriteContext

Returns:

True if a header is required, otherwise false.

getOutputStream

public OutputStream getOutputStream()

Retrieves the output stream for writing the Excel file.

Specified by:

getOutputStream in interface WriteContext

Returns:

The output stream.

getWorkbook

public org.apache.poi.ss.usermodel.Workbook getWorkbook()

Retrieves the workbook being written.

Specified by:

getWorkbook in interface WriteContext

Returns:

The workbook.