loci.poi.hssf.usermodel

Class HSSFWorkbook

java.lang.Object

loci.poi.POIDocument

loci.poi.hssf.usermodel.HSSFWorkbook

public class HSSFWorkbook
extends POIDocument

High level representation of a workbook. This is the first object most users will construct whether they are reading or writing a workbook. It is also the top level object for creating new sheets/etc.

Version:

2.0-pre

Author:

Andrew C. Oliver (acoliver at apache dot org), Glen Stampoultzis (glens at apache.org), Shawn Laubach (slaubach at apache dot org)

See Also:

Workbook, HSSFSheet

Field Summary

Fields

Modifier and Type	Field and Description
static byte	ENCODING_COMPRESSED_UNICODE Deprecated. POI will now properly handle unicode strings without forceing an encoding
static byte	ENCODING_UTF_16 Deprecated. POI will now properly handle unicode strings without forceing an encoding
static int	INITIAL_CAPACITY used for compile-time performance/memory optimization.
static int	PICTURE_TYPE_DIB Device independant bitmap
static int	PICTURE_TYPE_EMF Extended windows meta file
static int	PICTURE_TYPE_JPEG JPEG format
static int	PICTURE_TYPE_PICT Mac PICT format
static int	PICTURE_TYPE_PNG PNG format
static int	PICTURE_TYPE_WMF Windows Meta File
protected ArrayList	sheets this holds the HSSFSheet objects attached to this workbook

Fields inherited from class loci.poi.POIDocument

dsInf, filesystem, logger, sInf

Constructor Summary

Constructors

Modifier	Constructor and Description
	HSSFWorkbook() Creates new HSSFWorkbook from scratch (start here!)
	HSSFWorkbook(POIFSFileSystem fs)
	HSSFWorkbook(POIFSFileSystem fs, boolean preserveNodes) given a POI POIFSFileSystem object, read in its Workbook and populate the high and low level models.
	HSSFWorkbook(RandomAccessInputStream s)
	HSSFWorkbook(RandomAccessInputStream s, boolean preserveNodes) Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around your inputstream.
protected	HSSFWorkbook(Workbook book)

Method Summary

Methods

Modifier and Type	Method and Description
int	addPicture(byte[] pictureData, int format) Adds a picture to the workbook.
int	addSSTString(String string) Deprecated. Do not call this method from your applications. Use the methods available in the HSSFRow to add string HSSFCells
HSSFSheet	cloneSheet(int sheetNum) create an HSSFSheet from an existing sheet in the HSSFWorkbook.
HSSFCellStyle	createCellStyle() create a new Cell style and add it to the workbook's style table
HSSFDataFormat	createDataFormat() Returns the instance of HSSFDataFormat for this workbook.
HSSFFont	createFont() create a new Font and add it to the workbook's font table
HSSFName	createName() creates a new named range and add it to the model
HSSFSheet	createSheet() create an HSSFSheet for this HSSFWorkbook, adds it to the sheets and returns the high level representation.
HSSFSheet	createSheet(String sheetname) create an HSSFSheet for this HSSFWorkbook, adds it to the sheets and returns the high level representation.
void	dumpDrawingGroupRecords(boolean fat) Spits out a list of all the drawing records in the workbook.
HSSFFont	findFont(short boldWeight, short color, short fontHeight, String name, boolean italic, boolean strikeout, short typeOffset, byte underline) Finds a font that matches the one with the supplied attributes
List	getAllEmbeddedObjects() Gets all embedded OLE2 objects from the Workbook.
List	getAllPictures() Gets all pictures from the Workbook.
boolean	getBackupFlag() determine whether the Excel GUI will backup the workbook when saving.
byte[]	getBytes() Method getBytes - get the bytes of just the HSSF portions of the XLS file.
HSSFCellStyle	getCellStyleAt(short idx) get the cell style object at the given index
HSSFPalette	getCustomPalette()
short	getDisplayedTab() sets the first tab that is displayed in the list of tabs in excel.
HSSFFont	getFontAt(short idx) get the font at the given index number
HSSFName	getNameAt(int index) gets the Named range
int	getNameIndex(String name) gets the named range index by his name Note:Excel named ranges are case-insensitive and this method performs a case-insensitive search.
String	getNameName(int index) gets the named range name
short	getNumberOfFonts() get the number of fonts in the font table
int	getNumberOfNames() gets the total number of named ranges in the workboko
int	getNumberOfSheets() get the number of spreadsheets in the workbook (this will be three after serialization)
short	getNumCellStyles() get the number of styles the workbook contains
String	getPrintArea(int sheetIndex) Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified.
short	getSelectedTab() gets the tab whose data is actually seen when the sheet is opened.
HSSFSheet	getSheet(String name) Get sheet with the given name
HSSFSheet	getSheetAt(int index) Get the HSSFSheet object at the given index.
int	getSheetIndex(HSSFSheet sheet) Returns the index of the given sheet
int	getSheetIndex(String name) Returns the index of the sheet by his name
String	getSheetName(int sheet) get the sheet name
String	getSSTString(int index) Deprecated. Do not call this method from your applications. Use the methods available in the HSSFRow to get string HSSFCells
protected Workbook	getWorkbook()
void	insertChartRecord() Test only.
void	removeName(int index) remove the named range by his index
void	removeName(String name) remove the named range by his name
void	removePrintArea(int sheetIndex) Delete the printarea for the sheet specified
void	removeSheetAt(int index) removes sheet at the given index
void	setBackupFlag(boolean backupValue) determine whether the Excel GUI will backup the workbook when saving.
void	setDisplayedTab(short index) sets the first tab that is displayed in the list of tabs in excel.
void	setPrintArea(int sheetIndex, int startColumn, int endColumn, int startRow, int endRow) For the Convenience of Java Programmers maintaining pointers.
void	setPrintArea(int sheetIndex, String reference) Sets the printarea for the sheet provided
void	setRepeatingRowsAndColumns(int sheetIndex, int startColumn, int endColumn, int startRow, int endRow) Sets the repeating rows and columns for a sheet (as found in File->PageSetup->Sheet).
void	setSelectedTab(short index) sets the tab whose data is actually seen when the sheet is opened.
void	setSheetName(int sheet, String name) set the sheet name.
void	setSheetName(int sheet, String name, short encoding) Deprecated. 3-Jan-2006 POI now automatically detects unicode and sets the encoding appropriately. Simply use setSheetName(int sheet, String encoding)
void	setSheetOrder(String sheetname, int pos) sets the order of appearance for a given sheet.
void	unwriteProtectWorkbook() removes the write protect flag
void	write(OutputStream stream) Method write - write out this workbook to an Outputstream.
void	writeProtectWorkbook(String password, String username) protect a workbook with a password (not encypted, just sets writeprotect flags and the password.

Methods inherited from class loci.poi.POIDocument

copyNodes, getDocumentSummaryInformation, getPropertySet, getSummaryInformation, readProperties, writeProperties, writeProperties, writePropertySet

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_CAPACITY

public static final int INITIAL_CAPACITY

used for compile-time performance/memory optimization. This determines the initial capacity for the sheet collection. Its currently set to 3. Changing it in this release will decrease performance since you're never allowed to have more or less than three sheets!

See Also:

Constant Field Values

sheets

protected ArrayList sheets

this holds the HSSFSheet objects attached to this workbook

PICTURE_TYPE_EMF

public static final int PICTURE_TYPE_EMF

Extended windows meta file

See Also:

Constant Field Values

PICTURE_TYPE_WMF

public static final int PICTURE_TYPE_WMF

Windows Meta File

See Also:

Constant Field Values

PICTURE_TYPE_PICT

public static final int PICTURE_TYPE_PICT

Mac PICT format

See Also:

Constant Field Values

PICTURE_TYPE_JPEG

public static final int PICTURE_TYPE_JPEG

JPEG format

See Also:

Constant Field Values

PICTURE_TYPE_PNG

public static final int PICTURE_TYPE_PNG

PNG format

See Also:

Constant Field Values

PICTURE_TYPE_DIB

public static final int PICTURE_TYPE_DIB

Device independant bitmap

See Also:

Constant Field Values

ENCODING_COMPRESSED_UNICODE

public static final byte ENCODING_COMPRESSED_UNICODE

Deprecated. POI will now properly handle unicode strings without forceing an encoding

See Also:

Constant Field Values

ENCODING_UTF_16

public static final byte ENCODING_UTF_16

Deprecated. POI will now properly handle unicode strings without forceing an encoding

See Also:

Constant Field Values

Constructor Detail

HSSFWorkbook

public HSSFWorkbook()

Creates new HSSFWorkbook from scratch (start here!)

HSSFWorkbook

protected HSSFWorkbook(Workbook book)

HSSFWorkbook

public HSSFWorkbook(POIFSFileSystem fs)
             throws IOException

Throws:

IOException

HSSFWorkbook

public HSSFWorkbook(POIFSFileSystem fs,
            boolean preserveNodes)
             throws IOException

given a POI POIFSFileSystem object, read in its Workbook and populate the high and low level models. If you're reading in a workbook...start here.

Parameters:

fs - the POI filesystem that contains the Workbook stream.

preserveNodes - whether to preseve other nodes, such as macros. This takes more memory, so only say yes if you need to. If set, will store all of the POIFSFileSystem in memory

Throws:

IOException - if the stream cannot be read

See Also:

POIFSFileSystem

HSSFWorkbook

public HSSFWorkbook(RandomAccessInputStream s)
             throws IOException

Throws:

IOException

HSSFWorkbook

public HSSFWorkbook(RandomAccessInputStream s,
            boolean preserveNodes)
             throws IOException

Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around your inputstream.

Parameters:

s - the POI filesystem that contains the Workbook stream.

preserveNodes - whether to preseve other nodes, such as macros. This takes more memory, so only say yes if you need to.

Throws:

IOException - if the stream cannot be read

See Also:

POIFSFileSystem, HSSFWorkbook(POIFSFileSystem)

Method Detail

setSheetOrder

public void setSheetOrder(String sheetname,
                 int pos)

sets the order of appearance for a given sheet.

Parameters:

sheetname - the name of the sheet to reorder

pos - the position that we want to insert the sheet into (0 based)

setSelectedTab

public void setSelectedTab(short index)

sets the tab whose data is actually seen when the sheet is opened. This may be different from the "selected sheet" since excel seems to allow you to show the data of one sheet when another is seen "selected" in the tabs (at the bottom).

Parameters:

index -

See Also:

HSSFSheet.setSelected(boolean)

getSelectedTab

public short getSelectedTab()

gets the tab whose data is actually seen when the sheet is opened. This may be different from the "selected sheet" since excel seems to allow you to show the data of one sheet when another is seen "selected" in the tabs (at the bottom).

See Also:

HSSFSheet.setSelected(boolean)

setDisplayedTab

public void setDisplayedTab(short index)

sets the first tab that is displayed in the list of tabs in excel.

Parameters:

index -

getDisplayedTab

public short getDisplayedTab()

sets the first tab that is displayed in the list of tabs in excel.

setSheetName

public void setSheetName(int sheet,
                String name)

set the sheet name. Will throw IllegalArgumentException if the name is greater than 31 chars or contains /\?*[]

Parameters:

sheet - number (0 based)

setSheetName

public void setSheetName(int sheet,
                String name,
                short encoding)

Deprecated. 3-Jan-2006 POI now automatically detects unicode and sets the encoding appropriately. Simply use setSheetName(int sheet, String encoding)

set the sheet name forcing the encoding. Forcing the encoding IS A BAD IDEA!!!

Parameters:

sheet - number (0 based)

Throws:

IllegalArgumentException - if the name is greater than 31 chars or contains /\?*[]

getSheetName

public String getSheetName(int sheet)

get the sheet name

Parameters:

sheet - Number

Returns:

Sheet name

getSheetIndex

public int getSheetIndex(String name)

Returns the index of the sheet by his name

Parameters:

name - the sheet name

Returns:

index of the sheet (0 based)

getSheetIndex

public int getSheetIndex(HSSFSheet sheet)

Returns the index of the given sheet

Parameters:

sheet - the sheet to look up

Returns:

index of the sheet (0 based)

createSheet

public HSSFSheet createSheet()

create an HSSFSheet for this HSSFWorkbook, adds it to the sheets and returns the high level representation. Use this to create new sheets.

Returns:

HSSFSheet representing the new sheet.

cloneSheet

public HSSFSheet cloneSheet(int sheetNum)

create an HSSFSheet from an existing sheet in the HSSFWorkbook.

Returns:

HSSFSheet representing the cloned sheet.

createSheet

public HSSFSheet createSheet(String sheetname)

create an HSSFSheet for this HSSFWorkbook, adds it to the sheets and returns the high level representation. Use this to create new sheets.

Parameters:

sheetname - sheetname to set for the sheet.

Returns:

HSSFSheet representing the new sheet.

getNumberOfSheets

public int getNumberOfSheets()

get the number of spreadsheets in the workbook (this will be three after serialization)

Returns:

number of sheets

getSheetAt

public HSSFSheet getSheetAt(int index)

Get the HSSFSheet object at the given index.

Parameters:

index - of the sheet number (0-based physical & logical)

Returns:

HSSFSheet at the provided index

getSheet

public HSSFSheet getSheet(String name)

Get sheet with the given name

Parameters:

name - of the sheet

Returns:

HSSFSheet with the name provided or null if it does not exist

removeSheetAt

public void removeSheetAt(int index)

removes sheet at the given index

Parameters:

index - of the sheet (0-based)

setBackupFlag

public void setBackupFlag(boolean backupValue)

determine whether the Excel GUI will backup the workbook when saving.

Parameters:

backupValue - true to indicate a backup will be performed.

getBackupFlag

public boolean getBackupFlag()

determine whether the Excel GUI will backup the workbook when saving.

Returns:

the current setting for backups.

setRepeatingRowsAndColumns

public void setRepeatingRowsAndColumns(int sheetIndex,
                              int startColumn,
                              int endColumn,
                              int startRow,
                              int endRow)

Sets the repeating rows and columns for a sheet (as found in File->PageSetup->Sheet). This is function is included in the workbook because it creates/modifies name records which are stored at the workbook level.

To set just repeating columns:

  workbook.setRepeatingRowsAndColumns(0,0,1,-1-1);
 

To set just repeating rows:

  workbook.setRepeatingRowsAndColumns(0,-1,-1,0,4);
 

To remove all repeating rows and columns for a sheet.

  workbook.setRepeatingRowsAndColumns(0,-1,-1,-1,-1);
 

Parameters:

sheetIndex - 0 based index to sheet.

startColumn - 0 based start of repeating columns.

endColumn - 0 based end of repeating columns.

startRow - 0 based start of repeating rows.

endRow - 0 based end of repeating rows.

createFont

public HSSFFont createFont()

create a new Font and add it to the workbook's font table

Returns:

new font object

findFont

public HSSFFont findFont(short boldWeight,
                short color,
                short fontHeight,
                String name,
                boolean italic,
                boolean strikeout,
                short typeOffset,
                byte underline)

Finds a font that matches the one with the supplied attributes

getNumberOfFonts

public short getNumberOfFonts()

get the number of fonts in the font table

Returns:

number of fonts

getFontAt

public HSSFFont getFontAt(short idx)

get the font at the given index number

Parameters:

idx - index number

Returns:

HSSFFont at the index

createCellStyle

public HSSFCellStyle createCellStyle()

create a new Cell style and add it to the workbook's style table

Returns:

the new Cell Style object

getNumCellStyles

public short getNumCellStyles()

get the number of styles the workbook contains

Returns:

count of cell styles

getCellStyleAt

public HSSFCellStyle getCellStyleAt(short idx)

get the cell style object at the given index

Parameters:

idx - index within the set of styles

Returns:

HSSFCellStyle object at the index

write

public void write(OutputStream stream)
           throws IOException

Method write - write out this workbook to an Outputstream. Constructs a new POI POIFSFileSystem, passes in the workbook binary representation and writes it out.

Parameters:

stream - - the java OutputStream you wish to write the XLS to

Throws:

IOException - if anything can't be written.

See Also:

POIFSFileSystem

getBytes

public byte[] getBytes()

Method getBytes - get the bytes of just the HSSF portions of the XLS file. Use this to construct a POI POIFSFileSystem yourself.

Returns:

byte[] array containing the binary representation of this workbook and all contained sheets, rows, cells, etc.

See Also:

Workbook, Sheet

addSSTString

public int addSSTString(String string)

Deprecated. Do not call this method from your applications. Use the methods available in the HSSFRow to add string HSSFCells

getSSTString

public String getSSTString(int index)

Deprecated. Do not call this method from your applications. Use the methods available in the HSSFRow to get string HSSFCells

getWorkbook

protected Workbook getWorkbook()

getNumberOfNames

public int getNumberOfNames()

gets the total number of named ranges in the workboko

Returns:

number of named ranges

getNameAt

public HSSFName getNameAt(int index)

gets the Named range

Parameters:

index - position of the named range

Returns:

named range high level

getNameName

public String getNameName(int index)

gets the named range name

Parameters:

index - the named range index (0 based)

Returns:

named range name

setPrintArea

public void setPrintArea(int sheetIndex,
                String reference)

Sets the printarea for the sheet provided

i.e. Reference = $A$1:$B$2

Parameters:

sheetIndex - Zero-based sheet index (0 Represents the first sheet to keep consistent with java)

reference - Valid name Reference for the Print Area

setPrintArea

public void setPrintArea(int sheetIndex,
                int startColumn,
                int endColumn,
                int startRow,
                int endRow)

For the Convenience of Java Programmers maintaining pointers.

Parameters:

sheetIndex - Zero-based sheet index (0 = First Sheet)

startColumn - Column to begin printarea

endColumn - Column to end the printarea

startRow - Row to begin the printarea

endRow - Row to end the printarea

See Also:

setPrintArea(int, String)

getPrintArea

public String getPrintArea(int sheetIndex)

Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified.

Parameters:

sheetIndex - Zero-based sheet index (0 Represents the first sheet to keep consistent with java)

Returns:

String Null if no print area has been defined

removePrintArea

public void removePrintArea(int sheetIndex)

Delete the printarea for the sheet specified

Parameters:

sheetIndex - Zero-based sheet index (0 = First Sheet)

createName

public HSSFName createName()

creates a new named range and add it to the model

Returns:

named range high level

getNameIndex

public int getNameIndex(String name)

gets the named range index by his name Note:Excel named ranges are case-insensitive and this method performs a case-insensitive search.

Parameters:

name - named range name

Returns:

named range index

removeName

public void removeName(int index)

remove the named range by his index

Parameters:

index - named range index (0 based)

createDataFormat

public HSSFDataFormat createDataFormat()

Returns the instance of HSSFDataFormat for this workbook.

Returns:

the HSSFDataFormat object

See Also:

FormatRecord, Record

removeName

public void removeName(String name)

remove the named range by his name

Parameters:

name - named range name

getCustomPalette

public HSSFPalette getCustomPalette()

insertChartRecord

public void insertChartRecord()

Test only. Do not use

dumpDrawingGroupRecords

public void dumpDrawingGroupRecords(boolean fat)

Spits out a list of all the drawing records in the workbook.

addPicture

public int addPicture(byte[] pictureData,
             int format)

Adds a picture to the workbook.

Parameters:

pictureData - The bytes of the picture

format - The format of the picture. One of PICTURE_TYPE_*

Returns:

the index to this picture (1 based).

getAllPictures

public List getAllPictures()

Gets all pictures from the Workbook.

Returns:

the list of pictures (a list of HSSFPictureData objects.)

writeProtectWorkbook

public void writeProtectWorkbook(String password,
                        String username)

protect a workbook with a password (not encypted, just sets writeprotect flags and the password.

Parameters:

password - to set

unwriteProtectWorkbook

public void unwriteProtectWorkbook()

removes the write protect flag

getAllEmbeddedObjects

public List getAllEmbeddedObjects()

Gets all embedded OLE2 objects from the Workbook.

Returns:

the list of embedded objects (a list of HSSFObjectData objects.)