Package org.apache.poi.xssf.eventusermodel

Class XSSFReader

java.lang.Object

org.apache.poi.xssf.eventusermodel.XSSFReader

Direct Known Subclasses:

XSSFBReader

public class XSSFReader
extends Object

This class makes it easy to get at individual parts of an OOXML .xlsx file, suitable for low memory sax parsing or similar. It makes up the core part of the EventUserModel support for XSSF.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XSSFReader.SheetIterator	Iterator over sheet data.
static class	XSSFReader.XMLSheetRefReader
static final class	XSSFReader.XSSFSheetRef

Field Summary

Fields

Modifier and Type	Field	Description
protected OPCPackage	pkg
protected boolean	useReadOnlySharedStringsTable
protected PackagePart	workbookPart

Constructor Summary

Constructors

Constructor	Description
XSSFReader(OPCPackage pkg)	Creates a new XSSFReader, for the given package
XSSFReader(OPCPackage pkg, boolean allowStrictOoxmlFiles)	Creates a new XSSFReader, for the given package

Method Summary

Modifier and Type	Method	Description
InputStream	getSharedStringsData()	Returns an InputStream to read the contents of the shared strings table.
SharedStrings	getSharedStringsTable()	Opens up the Shared Strings Table, parses it, and returns a handy object for working with shared strings.
InputStream	getSheet(String relId)	Returns an InputStream to read the contents of the specified Sheet.
static PackagePart	getSheetCommentsPart(PackagePart sheetPart, boolean allowStrictOoxmlFiles)	Returns the comments part associated with a sheet.
static List<PackagePart>	getSheetDrawingParts(PackagePart sheetPart, boolean allowStrictOoxmlFiles)	Returns the drawing parts associated with a sheet.
XSSFReader.SheetIterator	getSheetIterator()	Returns an Iterator which will let you get at all the different Sheets in turn.
PackagePart	getSheetPart(String relId)	Returns the package part for the specified Sheet.
Iterator<InputStream>	getSheetsData()	Returns an Iterator which will let you get at all the different Sheets in turn.
InputStream	getStylesData()	Returns an InputStream to read the contents of the styles table.
StylesTable	getStylesTable()	Opens up the Styles Table, parses it, and returns a handy object for working with cell styles
InputStream	getThemesData()	Returns an InputStream to read the contents of the themes table.
InputStream	getWorkbookData()	Returns an InputStream to read the contents of the main Workbook, which contains key overall data for the file, including sheet definitions.
void	setUseReadOnlySharedStringsTable(boolean useReadOnlySharedStringsTable)	Controls whether getSharedStringsTable() uses SharedStringsTable or ReadOnlySharedStringsTable.
boolean	useReadOnlySharedStringsTable()

Methods inherited from class java.lang.Object

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

Field Details

pkg

protected OPCPackage pkg

workbookPart

protected PackagePart workbookPart

useReadOnlySharedStringsTable

protected boolean useReadOnlySharedStringsTable

Constructor Details

XSSFReader

public XSSFReader(OPCPackage pkg)
           throws IOException,
OpenXML4JException

Creates a new XSSFReader, for the given package

Throws:

OpenXML4JException - if the package format is invalid

IOException - if there is an I/O issue reading the data

XSSFReader

public XSSFReader(OPCPackage pkg,
 boolean allowStrictOoxmlFiles)
           throws IOException,
OpenXML4JException

Creates a new XSSFReader, for the given package

Parameters:

pkg - an OPCPackage representing a spreasheet file

allowStrictOoxmlFiles - whether to try to handle Strict OOXML format files

Throws:

OpenXML4JException - if the package format is invalid

IOException - if there is an I/O issue reading the data

Method Details

setUseReadOnlySharedStringsTable

public void setUseReadOnlySharedStringsTable(boolean useReadOnlySharedStringsTable)

Controls whether getSharedStringsTable() uses SharedStringsTable or ReadOnlySharedStringsTable.

Parameters:

useReadOnlySharedStringsTable - if true, the ReadOnlySharedStringsTable is used, SharedStringsTable otherwise

Since:

5.2.0

useReadOnlySharedStringsTable

public boolean useReadOnlySharedStringsTable()

Returns:

whether getSharedStringsTable() uses SharedStringsTable or ReadOnlySharedStringsTable.

Since:

5.2.0

getSharedStringsTable

public SharedStrings getSharedStringsTable()
                                    throws IOException,
InvalidFormatException

Opens up the Shared Strings Table, parses it, and returns a handy object for working with shared strings.

Returns:

SharedStrings

Throws:

InvalidFormatException - if the shared strings data format is invalid

IOException - if there is an I/O issue reading the data

See Also:

• setUseReadOnlySharedStringsTable(boolean)

getStylesTable

public StylesTable getStylesTable()
                           throws IOException,
InvalidFormatException

Opens up the Styles Table, parses it, and returns a handy object for working with cell styles

Returns:

StylesTable

Throws:

InvalidFormatException - if the styles data format is invalid

IOException - if there is an I/O issue reading the data

getSharedStringsData

public InputStream getSharedStringsData()
                                 throws IOException,
InvalidFormatException

Returns an InputStream to read the contents of the shared strings table.

Returns:

input stream

Throws:

InvalidFormatException - if the shared string data format is invalid

IOException - if there is an I/O issue reading the data

getStylesData

public InputStream getStylesData()
                          throws IOException,
InvalidFormatException

Returns an InputStream to read the contents of the styles table.

Returns:

input stream

Throws:

InvalidFormatException - if the styles data format is invalid

IOException - if there is an I/O issue reading the data

getThemesData

public InputStream getThemesData()
                          throws IOException,
InvalidFormatException

Returns an InputStream to read the contents of the themes table.

Returns:

input stream

Throws:

InvalidFormatException - if the themes data format is invalid

IOException - if there is an I/O issue reading the data

getWorkbookData

public InputStream getWorkbookData()
                            throws IOException,
InvalidFormatException

Returns an InputStream to read the contents of the main Workbook, which contains key overall data for the file, including sheet definitions.

Returns:

input stream

Throws:

InvalidFormatException - if the sheet data format is invalid

IOException - if there is an I/O issue reading the data

getSheet

public InputStream getSheet(String relId)
                     throws IOException,
InvalidFormatException

Returns an InputStream to read the contents of the specified Sheet.

Parameters:

relId - The relationId of the sheet, from a r:id on the workbook

Throws:

InvalidFormatException - if the sheet data format is invalid

IOException - if there is an I/O issue reading the data

getSheetPart

public PackagePart getSheetPart(String relId)
                         throws InvalidFormatException

Returns the package part for the specified Sheet.

Parameters:

relId - The relationId of the sheet, from a r:id on the workbook

Returns:

the package part holding the sheet data

Throws:

InvalidFormatException - if the sheet data format is invalid

IllegalArgumentException - if there is no sheet with this relationId

Since:

6.0.0

getSheetCommentsPart

public static PackagePart getSheetCommentsPart(PackagePart sheetPart,
 boolean allowStrictOoxmlFiles)
                                        throws InvalidFormatException

Returns the comments part associated with a sheet.

Parameters:

sheetPart - the package part holding the sheet data

allowStrictOoxmlFiles - whether to also look for the Strict OOXML comments relationship. Note that the returned part is then in Strict OOXML format and CommentsTable cannot parse it directly.

Returns:

the comments part, or null if the sheet has no comments or the part is missing

Throws:

InvalidFormatException - if the relationship target is not a valid part name

Since:

6.0.0

getSheetDrawingParts

public static List<PackagePart> getSheetDrawingParts(PackagePart sheetPart,
 boolean allowStrictOoxmlFiles)
                                              throws InvalidFormatException

Returns the drawing parts associated with a sheet. Missing parts are skipped.

Parameters:

sheetPart - the package part holding the sheet data

allowStrictOoxmlFiles - whether to also look for the Strict OOXML drawing relationship. Note that the returned parts are then in Strict OOXML format and XSSFDrawing cannot parse them directly.

Returns:

the drawing parts, never null

Throws:

InvalidFormatException - if a relationship target is not a valid part name

Since:

6.0.0

getSheetsData

public Iterator<InputStream> getSheetsData()
                                    throws IOException,
InvalidFormatException

Returns an Iterator which will let you get at all the different Sheets in turn. Each sheet's InputStream is only opened when fetched from the Iterator. It's up to you to close the InputStreams when done with each one.

Throws:

InvalidFormatException - if the sheet data format is invalid

IOException - if there is an I/O issue reading the data

See Also:

• getSheetIterator()

getSheetIterator

public XSSFReader.SheetIterator getSheetIterator()
                                          throws IOException,
InvalidFormatException

Returns an Iterator which will let you get at all the different Sheets in turn. Each sheet's InputStream is only opened when fetched from the Iterator. It's up to you to close the InputStreams when done with each one.

Throws:

InvalidFormatException - if the sheet data format is invalid

IOException - if there is an I/O issue reading the data

Since:

5.4.0