er.excel

Class EGSimpleWorkbookHelper

java.lang.Object

er.excel.EGSimpleWorkbookHelper

public class EGSimpleWorkbookHelper
extends Object

This class simplifies the creation of HSSFWorkbook objects, allowing one to create a workbook and add data to it with fairly simple and (hopefully) self-explanatory code. It also provides a useful subset of a very large API.

The sheetWithNumber(int) and sheetWithName(String) methods may return a null object, but any of the other methods for returning a sheet or a cell are guaranteed to not return a null. If necessary, a sheet or a cell will be created. The stringAtLocation and numberAtLocation methods are also guaranteed to not return null. This allows one to use code like the following, without fear of an exception.

 EGSimpleWorkbookHelper helper = new EGSimpleWorkbookHelper();
 helper.currentSheet().setNumberAtLocation(24, 2, 2);
 helper.currentSheet().setStringAtLocation("Hello", 3, 4);
 String aNumber = helper.currentSheet().numberAtLocation(1, 1).toString();
 

The POI classes use numbers for rows and, implicitly, columns. This class also allows the use of the string-based column names one always sees on spreadsheets. So the methods that take a row number and a column number and return a call can also take a column name, such as "A", "B", ..., "Z", "AA", "AB", and so on. Using a column name not wholly composed of capital letters will generate a IllegalArgumentException.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.poi.hssf.usermodel.HSSFWorkbook	_workbook

Constructor Summary

Constructors

Constructor and Description
EGSimpleWorkbookHelper()
EGSimpleWorkbookHelper(org.apache.poi.hssf.usermodel.HSSFWorkbook workbook)

Method Summary

Modifier and Type	Method and Description
org.apache.poi.hssf.usermodel.HSSFCell	cellAtLocation(int rownum, int colnum)
org.apache.poi.hssf.usermodel.HSSFCell	cellAtLocation(int rownum, String columnName)
org.apache.poi.hssf.usermodel.HSSFSheet	currentSheet() Returns the sheet that has been designated as the current sheet.
int	currentSheetNumber() Returns the number of the current sheet.
Date	dateAtLocation(int rownum, int colnum)
Date	dateAtLocation(int rownum, String columnName)
static EGSimpleWorkbookHelper	newInstance()
Number	numberAtLocation(int rownum, int colnum)
Number	numberAtLocation(int rownum, String columnName)
void	setCurrentSheetName(String name)
void	setDateAtLocation(Date value, int rownum, int colnum)
void	setDateAtLocation(Date value, int rownum, String columnName)
void	setNumberAtLocation(Number value, int rownum, int colnum)
void	setNumberAtLocation(Number value, int rownum, String columnName)
void	setStringAtLocation(String value, int rownum, int colnum)
void	setStringAtLocation(String value, int rownum, String columnName)
org.apache.poi.hssf.usermodel.HSSFSheet	sheetWithName(String name) Returns the sheet in this workbook that is identified by a particular name.
org.apache.poi.hssf.usermodel.HSSFSheet	sheetWithNumber(int number) Returns the sheet in this workbook that is identified by a number, with the numbers being set in the order in which the sheets were created.
String	stringAtLocation(int rownum, int colnum)
String	stringAtLocation(int rownum, String columnName)
void	switchToSheetNumber(int number) Switches the current sheet to a sheet identified by number, with the number being set by the order in which the sheets were created.
void	switchToSheetWithName(String name) Switches the current sheet to a sheet identified by name.
org.apache.poi.hssf.usermodel.HSSFWorkbook	workbook() Returns the HSSFWorkbook instance that this class is helping to build.
boolean	write(String filename) Writes the XLS data to a file given the filename.
String	writeToTemp()

Methods inherited from class java.lang.Object

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

Field Detail

_workbook

protected org.apache.poi.hssf.usermodel.HSSFWorkbook _workbook

Constructor Detail

EGSimpleWorkbookHelper

public EGSimpleWorkbookHelper()

EGSimpleWorkbookHelper

public EGSimpleWorkbookHelper(org.apache.poi.hssf.usermodel.HSSFWorkbook workbook)

Method Detail

newInstance

public static EGSimpleWorkbookHelper newInstance()

workbook

public org.apache.poi.hssf.usermodel.HSSFWorkbook workbook()

Returns the HSSFWorkbook instance that this class is helping to build.

switchToSheetNumber

public void switchToSheetNumber(int number)

Switches the current sheet to a sheet identified by number, with the number being set by the order in which the sheets were created.

switchToSheetWithName

public void switchToSheetWithName(String name)

Switches the current sheet to a sheet identified by name. If a name is not explicitly set on a sheet, its default name is "Sheet#", with "#" being the number of the sheet.

currentSheet

public org.apache.poi.hssf.usermodel.HSSFSheet currentSheet()

Returns the sheet that has been designated as the current sheet. This method is guaranteed to return a sheet and it will not return null.

sheetWithNumber

public org.apache.poi.hssf.usermodel.HSSFSheet sheetWithNumber(int number)

Returns the sheet in this workbook that is identified by a number, with the numbers being set in the order in which the sheets were created. This method is not guaranteed to return a sheet and may return null. To avoid getting a null, use the switchToSheetNumber() method and then call currentSheet().

sheetWithName

public org.apache.poi.hssf.usermodel.HSSFSheet sheetWithName(String name)

Returns the sheet in this workbook that is identified by a particular name. This method is not guaranteed to return a sheet and may return null. To avoid getting a null, use the switchToSheetWithName() method and then call currentSheet().

currentSheetNumber

public int currentSheetNumber()

Returns the number of the current sheet.

Returns:

a non-zero integer

setCurrentSheetName

public void setCurrentSheetName(String name)

cellAtLocation

public org.apache.poi.hssf.usermodel.HSSFCell cellAtLocation(int rownum,
                                                             int colnum)

cellAtLocation

public org.apache.poi.hssf.usermodel.HSSFCell cellAtLocation(int rownum,
                                                             String columnName)

numberAtLocation

public Number numberAtLocation(int rownum,
                               int colnum)

setNumberAtLocation

public void setNumberAtLocation(Number value,
                                int rownum,
                                int colnum)

numberAtLocation

public Number numberAtLocation(int rownum,
                               String columnName)

setNumberAtLocation

public void setNumberAtLocation(Number value,
                                int rownum,
                                String columnName)

dateAtLocation

public Date dateAtLocation(int rownum,
                           int colnum)

setDateAtLocation

public void setDateAtLocation(Date value,
                              int rownum,
                              int colnum)

dateAtLocation

public Date dateAtLocation(int rownum,
                           String columnName)

setDateAtLocation

public void setDateAtLocation(Date value,
                              int rownum,
                              String columnName)

stringAtLocation

public String stringAtLocation(int rownum,
                               int colnum)

setStringAtLocation

public void setStringAtLocation(String value,
                                int rownum,
                                int colnum)

stringAtLocation

public String stringAtLocation(int rownum,
                               String columnName)

setStringAtLocation

public void setStringAtLocation(String value,
                                int rownum,
                                String columnName)

writeToTemp

public String writeToTemp()

write

public boolean write(String filename)

Writes the XLS data to a file given the filename.

Parameters:

filename - to be overwritten with the spreadsheet data

Returns:

true if the file was written to successfully, false is there was an exception from the java.io classes