Package com.storedobject.office

Class AbstractSpreadSheet

java.lang.Object

com.storedobject.core.StreamContentProducer

com.storedobject.office.AbstractSpreadSheet

All Implemented Interfaces:

Executable, ContentProducer, ContentType, RequiresTransactionManager, Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

Excel, ODS

public abstract class AbstractSpreadSheet
extends StreamContentProducer

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_ROWS
protected org.apache.poi.ss.usermodel.Workbook	workbook

Fields inherited from class com.storedobject.core.StreamContentProducer

entity, out

Constructor Summary

Constructors

Constructor	Description
AbstractSpreadSheet(InputStream in, OutputStream out)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	abort(Throwable error)	This method may be called when the content generation is aborted due to some error.
void	close()
protected abstract org.apache.poi.ss.usermodel.Workbook	createWorkbook(InputStream in)
final void	feedback(String message)
void	generateContent()	Generate the content here and write to 'out'
org.apache.poi.ss.usermodel.Cell	getCell()
org.apache.poi.ss.usermodel.Cell	getCell(int cell, int row)
org.apache.poi.ss.usermodel.Cell	getCell(int cell, int row, int sheet)
org.apache.poi.ss.usermodel.Cell	getCell(String cellAddress)
int	getCellIndex()
org.apache.poi.ss.usermodel.Cell[][]	getCells(String rangeAddress)
org.apache.poi.ss.usermodel.CellStyle	getCenteredStyle()
org.apache.poi.ss.usermodel.Cell[]	getColumnCells(String rangeAddress)
org.apache.poi.ss.usermodel.CellStyle	getDateStyle()
org.apache.poi.ss.usermodel.CellStyle	getDateTimeStyle()
Device	getDevice()
org.apache.poi.ss.usermodel.CellStyle	getHourStyle()
org.apache.poi.ss.usermodel.Cell	getNextCell()
org.apache.poi.ss.usermodel.Row	getNextRow()
org.apache.poi.ss.usermodel.Sheet	getNextSheet()
org.apache.poi.ss.usermodel.CellStyle	getNumericStyle(int width, int decimals)
org.apache.poi.ss.usermodel.CellStyle	getNumericStyle(int width, int decimals, boolean separated)
org.apache.poi.ss.usermodel.CellStyle	getPercentage2Style()
org.apache.poi.ss.usermodel.CellStyle	getPercentageStyle()
org.apache.poi.ss.usermodel.Cell	getPreviousCell()
org.apache.poi.ss.usermodel.Row	getPreviousRow()
org.apache.poi.ss.usermodel.Sheet	getPreviousSheet()
org.apache.poi.ss.usermodel.CellStyle	getRightAlignedStyle()
org.apache.poi.ss.usermodel.Row	getRow()
org.apache.poi.ss.usermodel.Row	getRow(int row)
org.apache.poi.ss.usermodel.Row	getRow(int row, int sheet)
org.apache.poi.ss.usermodel.Cell[]	getRowCells(String rangeAddress)
int	getRowIndex()
org.apache.poi.ss.usermodel.Sheet	getSheet()
org.apache.poi.ss.usermodel.Sheet	getSheet(int sheet)
int	getSheetIndex()
org.apache.poi.ss.usermodel.Workbook	getWorkbook()
void	goToCell(int cell)
void	goToCell(int cell, int row)
void	goToCell(int cell, int row, int sheet)
void	goToCell(String cellAddress)
void	goToRow(int row)
static boolean	isSameSize(String rangeAddress1, String rangeAddress2)
void	moveDown()
boolean	moveLeft()
void	moveRight()
boolean	moveUp()
void	save(OutputStream out)
void	save(String fileName)
void	setCellValue(Object cellValue)	Set a value to the current cell.
void	setCellValue(org.apache.poi.ss.usermodel.Cell cell, Object cellValue)	Set a value to a cell.
void	setCellValues(Object... cellValues)	Set cell values to consecutive cells from left to right, starting from the current cell.
void	setFeedback(Consumer<String> feedback)
static boolean	validateCellAddress(String cellAddress)
static boolean	validateColumnAddress(String rangeAddress)
static boolean	validateRangeAddress(String rangeAddress)
static boolean	validateRowAddress(String rangeAddress)

Methods inherited from class com.storedobject.core.StreamContentProducer

getContent, getEntity, getError, getFileName, getReportFormat, getTransactionManager, getWriter, isBlocked, isBlocked, produce, ready, setTransactionManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.core.ContentProducer

execute, extractContent, getFileExtension, getStreamData, getStreamDataProvider, getSystemEntity, saveTo, saveTo, saveTo, saveTo

Methods inherited from interface com.storedobject.core.ContentType

getContentType, getLink, getMimeType, isAudio, isHTML, isImage, isLink, isMedia, isPDF, isText, isVideo

Methods inherited from interface com.storedobject.common.Executable

act, run

Field Details

MAX_ROWS

public static int MAX_ROWS

workbook

protected org.apache.poi.ss.usermodel.Workbook workbook

Constructor Details

AbstractSpreadSheet

public AbstractSpreadSheet(InputStream in,
 OutputStream out)

Constructor.

Parameters:

in - Input stream containing a spreadsheet file with some content.

out - Output is written to this stream.

Method Details

createWorkbook

protected abstract org.apache.poi.ss.usermodel.Workbook createWorkbook(InputStream in)
                                                                throws Exception

Throws:

Exception

save

public void save(OutputStream out)
          throws IOException

Throws:

IOException

save

public void save(String fileName)
          throws IOException

Throws:

IOException

getWorkbook

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

getSheetIndex

public int getSheetIndex()

getSheet

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

getSheet

public org.apache.poi.ss.usermodel.Sheet getSheet(int sheet)

getNextSheet

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

getPreviousSheet

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

getRowIndex

public int getRowIndex()

getRow

public org.apache.poi.ss.usermodel.Row getRow()

getRow

public org.apache.poi.ss.usermodel.Row getRow(int row)

getRow

public org.apache.poi.ss.usermodel.Row getRow(int row,
 int sheet)

getNextRow

public org.apache.poi.ss.usermodel.Row getNextRow()

getPreviousRow

public org.apache.poi.ss.usermodel.Row getPreviousRow()

getCellIndex

public int getCellIndex()

getCell

public org.apache.poi.ss.usermodel.Cell getCell()

getCell

public org.apache.poi.ss.usermodel.Cell getCell(int cell,
 int row)

getCell

public org.apache.poi.ss.usermodel.Cell getCell(int cell,
 int row,
 int sheet)

getCell

public org.apache.poi.ss.usermodel.Cell getCell(String cellAddress)

getCells

public org.apache.poi.ss.usermodel.Cell[][] getCells(String rangeAddress)

getColumnCells

public org.apache.poi.ss.usermodel.Cell[] getColumnCells(String rangeAddress)

getRowCells

public org.apache.poi.ss.usermodel.Cell[] getRowCells(String rangeAddress)

getNextCell

public org.apache.poi.ss.usermodel.Cell getNextCell()

getPreviousCell

public org.apache.poi.ss.usermodel.Cell getPreviousCell()

goToCell

public void goToCell(String cellAddress)

goToCell

public void goToCell(int cell,
 int row,
 int sheet)

goToCell

public void goToCell(int cell,
 int row)

goToCell

public void goToCell(int cell)

goToRow

public void goToRow(int row)

moveLeft

public boolean moveLeft()

moveRight

public void moveRight()

moveUp

public boolean moveUp()

moveDown

public void moveDown()

setCellValue

public void setCellValue(Object cellValue)

Set a value to the current cell. If the value can't be set because the type is not supported, its stringified version will be set.

Parameters:

cellValue - Value to set.

setCellValue

public void setCellValue(org.apache.poi.ss.usermodel.Cell cell,
 Object cellValue)

Set a value to a cell. If the value can't be set because the type is not supported, its stringified version will be set.

Note: The cursor won't move to the next cell.

Parameters:

cell - Cell to which value needs to be set.

cellValue - Value to set.

setCellValues

public void setCellValues(Object... cellValues)

Set cell values to consecutive cells from left to right, starting from the current cell. For null values, respective cells will be skipped.

Note: The cursor does move to the next cell.

Parameters:

cellValues - Cell values to set.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class StreamContentProducer

abort

public void abort(Throwable error)

Description copied from interface: ContentProducer

This method may be called when the content generation is aborted due to some error.

Note: This could be invoked multiple times.

Specified by:

abort in interface ContentProducer

Overrides:

abort in class StreamContentProducer

Parameters:

error - Error.

generateContent

public void generateContent()
                     throws Exception

Description copied from class: StreamContentProducer

Generate the content here and write to 'out'

Specified by:

generateContent in class StreamContentProducer

Throws:

Exception - Can throw anything

getDateStyle

public org.apache.poi.ss.usermodel.CellStyle getDateStyle()

getDateTimeStyle

public org.apache.poi.ss.usermodel.CellStyle getDateTimeStyle()

getHourStyle

public org.apache.poi.ss.usermodel.CellStyle getHourStyle()

getPercentageStyle

public org.apache.poi.ss.usermodel.CellStyle getPercentageStyle()

getPercentage2Style

public org.apache.poi.ss.usermodel.CellStyle getPercentage2Style()

getRightAlignedStyle

public org.apache.poi.ss.usermodel.CellStyle getRightAlignedStyle()

getCenteredStyle

public org.apache.poi.ss.usermodel.CellStyle getCenteredStyle()

getNumericStyle

public org.apache.poi.ss.usermodel.CellStyle getNumericStyle(int width,
 int decimals)

getNumericStyle

public org.apache.poi.ss.usermodel.CellStyle getNumericStyle(int width,
 int decimals,
 boolean separated)

validateCellAddress

public static boolean validateCellAddress(String cellAddress)

validateRangeAddress

public static boolean validateRangeAddress(String rangeAddress)

validateRowAddress

public static boolean validateRowAddress(String rangeAddress)

validateColumnAddress

public static boolean validateColumnAddress(String rangeAddress)

isSameSize

public static boolean isSameSize(String rangeAddress1,
 String rangeAddress2)

getDevice

public Device getDevice()

setFeedback

public void setFeedback(Consumer<String> feedback)

feedback

public final void feedback(String message)