com.github.pjfanning.poi.xssf.streaming

Class MapBackedSharedStringsTable

java.lang.Object

org.apache.poi.ooxml.POIXMLDocumentPart

org.apache.poi.xssf.model.SharedStringsTable

com.github.pjfanning.poi.xssf.streaming.SharedStringsTableBase

com.github.pjfanning.poi.xssf.streaming.MapBackedSharedStringsTable

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.poi.xssf.model.SharedStrings

public class MapBackedSharedStringsTable
extends SharedStringsTableBase

Table of strings shared across all sheets in a workbook.

A workbook may contain thousands of cells containing string (non-numeric) data. Furthermore this data is very likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared across the workbook is to improve performance in opening and saving the file by only reading and writing the repetitive information once.

Consider for example a workbook summarizing information for cities within various countries. There may be a column for the name of the country, a column for the name of each city in that country, and a column containing the data for each city. In this case the country name is repetitive, being duplicated in many cells. In many cases the repetition is extensive, and a tremendous savings is realized by making use of a shared string table when saving the workbook. When displaying text in the spreadsheet, the cell table will just contain an index into the string table as the value of a cell, instead of the full string.

The shared string table contains all the necessary information for displaying the string: the text, formatting properties, and phonetic properties (for East Asian languages).

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

org.apache.poi.ooxml.POIXMLDocumentPart.RelationPart

Field Summary

Fields inherited from class com.github.pjfanning.poi.xssf.streaming.SharedStringsTableBase

fullFormat, stmap, strings

Fields inherited from class org.apache.poi.xssf.model.SharedStringsTable

count, uniqueCount

Constructor Summary

Constructors

Constructor and Description
MapBackedSharedStringsTable()
MapBackedSharedStringsTable(boolean fullFormat)
MapBackedSharedStringsTable(org.apache.poi.openxml4j.opc.OPCPackage pkg)
MapBackedSharedStringsTable(org.apache.poi.openxml4j.opc.OPCPackage pkg, boolean fullFormat)

Method Summary

Modifier and Type	Method and Description
void	close()
protected org.slf4j.Logger	getLogger()
java.util.List<org.apache.poi.ss.usermodel.RichTextString>	getSharedStringItems() MapBackedSharedStringsTable does not implement getSharedStringItems().
protected java.util.Iterator<java.lang.Integer>	keyIterator()

Methods inherited from class com.github.pjfanning.poi.xssf.streaming.SharedStringsTableBase

addSharedStringItem, getCount, getItemAt, getString, getUniqueCount, readFrom, writeTo

Methods inherited from class org.apache.poi.xssf.model.SharedStringsTable

commit, xmlText

Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommitted, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommitted, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MapBackedSharedStringsTable

public MapBackedSharedStringsTable()
                            throws java.io.IOException

Throws:

java.io.IOException

MapBackedSharedStringsTable

public MapBackedSharedStringsTable(boolean fullFormat)

MapBackedSharedStringsTable

public MapBackedSharedStringsTable(org.apache.poi.openxml4j.opc.OPCPackage pkg)
                            throws java.io.IOException

Throws:

java.io.IOException

MapBackedSharedStringsTable

public MapBackedSharedStringsTable(org.apache.poi.openxml4j.opc.OPCPackage pkg,
                                   boolean fullFormat)
                            throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getLogger

protected org.slf4j.Logger getLogger()

Specified by:

getLogger in class SharedStringsTableBase

keyIterator

protected java.util.Iterator<java.lang.Integer> keyIterator()

Specified by:

keyIterator in class SharedStringsTableBase

getSharedStringItems

public java.util.List<org.apache.poi.ss.usermodel.RichTextString> getSharedStringItems()

MapBackedSharedStringsTable does not implement getSharedStringItems(). It could be made to but it would be memory intensive and slow. Use getItemAt instead.

Overrides:

getSharedStringItems in class org.apache.poi.xssf.model.SharedStringsTable

Returns:

throws UnsupportedOperationException

Throws:

java.lang.UnsupportedOperationException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class org.apache.poi.xssf.model.SharedStringsTable

Throws:

java.io.IOException