XSSFBSharedStringsTable (POI API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.xssf.binary
Class XSSFBSharedStringsTable

java.lang.Object
  org.apache.poi.xssf.binary.XSSFBSharedStringsTable

@Internal public class XSSFBSharedStringsTable
extends java.lang.Object
extends java.lang.Object

Since:: 3.16-beta3

Constructor Summary
`XSSFBSharedStringsTable(OPCPackage pkg)`

Method Summary
`int`	`getCount()` Return an integer representing the total count of strings in the workbook.
`java.lang.String`	`getEntryAt(int i)`
`java.util.List<java.lang.String>`	`getItems()`
`int`	`getUniqueCount()` Returns an integer representing the total count of unique strings in the Shared String Table.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

XSSFBSharedStringsTable

public XSSFBSharedStringsTable(OPCPackage pkg)
                        throws java.io.IOException,
                               org.xml.sax.SAXException

Parameters:: pkg - The OPCPackage to use as basis for the shared-strings table.
Throws:: java.io.IOException - If reading the data from the package fails.; org.xml.sax.SAXException - if parsing the XML data fails.

Method Detail

getItems

public java.util.List<java.lang.String> getItems()

Returns:: a defensive copy of strings

getEntryAt

public java.lang.String getEntryAt(int i)

getCount

public int getCount()

Return an integer representing the total count of strings in the workbook. This count does not include any numbers, it counts only the total of text strings in the workbook.

Returns:: the total count of strings in the workbook

getUniqueCount

public int getUniqueCount()

Returns an integer representing the total count of unique strings in the Shared String Table. A string is unique even if it is a copy of another string, but has different formatting applied at the character level.

Returns:: the total count of unique strings in the workbook