io.starter.formats.XLS

Class Sst

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.Sst

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public final class Sst
extends XLSRecord

Sst: Shared String Table 0xFCh
Sst records contain a table of Strings possibly spanning multiple Continue Records

     offset  name        size    contents
     ---    
     4       cstTotal    4       Total number of strings in this and the
                                 EXTSST record.
     8       cstUnique   4       Number of unique strings in this table.
 12      rgb         var     Array of unique strings
 
 

 

See Also:

Sst, Labelsst, Extsst, Serialized Form

Field Summary

Fields inherited from class io.starter.formats.XLS.XLSRecord

col, continues, DEBUGLEVEL, hyperlink, idx, isBlank, isBoolean, isContinueMerged, isString, lastidx, myxf, offset, rw, streamer, wkbook, worksheet

Fields inherited from interface io.starter.formats.XLS.XLSConstants

AI, ALLOWDUPES, ALRUNS, AREA, AREAFORMAT, ARRAY, ATTACHEDLABEL, AUTOFILTER, AXCENT, AXESUSED, AXIS, AXISLINEFORMAT, AXISPARENT, BACKUP, BAR, BEGIN, BLANK, BOF, BOOKBOOL, BOOLERR, BOPPOP, BOPPOPCUSTOM, BOTTOM_MARGIN, BOTTOMMARGIN, BOUNDSHEET, CALC_MODE_PROP, CALCCOUNT, CALCMODE, CALCULATE_ALWAYS, CALCULATE_AUTO, CALCULATE_EXPLICIT, CATLAB, CATSERRANGE, CF, CF12, CHART, CHART3DBARSHAPE, CHARTFORMAT, CHARTFORMATLINK, CHARTFRTINFO, CHARTLINE, CODENAME, COLINFO, CONDFMT, CONDFMT12, CONTINUE, COUNTRY, CRN, CRTLAYOUT12, CRTLAYOUT12A, DAT, DATAFORMAT, DATALABEXT, DATALABEXTCONTENTS, DATE1904, DBCELL, DCON, DCONBIN, DCONNAME, DCONREF, DEBUG_HIGH, DEBUG_LOW, DEBUG_MEDIUM, DEFAULTENCODING, DEFAULTROWHEIGHT, DEFAULTTEXT, DEFCOLWIDTH, DELTA, DIMENSIONS, DROPBAR, DSF, DV, DVAL, END, ENDBLOCK, ENDEXTSST, ENDOBJECT, EOF, EXCEL2K, EXTERNCOUNT, EXTERNNAME, EXTERNSHEET, EXTSST, FBI, FEATHEADR, FILE_LOCK, FILEPASS, FONT, FONTBASIS, FONTX, FOOTERREC, FORMAT, FORMULA, FRAME, FRTFONTLIST, FRTWRAPPER, GARBAGE, GELFRAME, GUTS, HCENTER, HEADERREC, HLINK, HORIZONTAL_PAGE_BREAKS, IFMT, INDEX, INTERFACE_HDR, ITERATION, LABEL, LABELSST, LEFT_MARGIN, LEFTMARGIN, LEGEND, LEGENDXN, LINE, LINEFORMAT, MARKERFORMAT, MAXCOLS, MAXCOLS_BIFF8, MAXRECLEN, MAXROWS, MAXROWS_BIFF8, MERGEDCELLS, MSODRAWING, MSODRAWINGGROUP, MSODRAWINGSELECTION, MULBLANK, MULRK, NAME, NOTE, NUMBER, OBJ, OBJECTLINK, OBJPROTECT, OBPROJ, PALETTE, PANE, PASSWORD, PHONETIC, PICF, PIE, PIEFORMAT, PIVOTCHARTBITS, PIVOTCHARTLINK, PLOTAREA, PLOTGROWTH, PLS, PLV, POS, PRECISION, PRINT_GRIDLINES, PRINT_ROW_HEADERS, PRINTGRID, PRINTROWCOL, PROT4REV, PROTECT, QSISXTAG, RADAR, RADARAREA, RANGEPROTECTION, REFMODE, REFTRACK_PROP, RIGHT_MARGIN, RIGHTMARGIN, RK, ROW, RRD_HEAD, RRD_INFO, RSTRING, RTENTEXU, RTMERGECELLS, SBASEREF, SCATTER, SCENPROTECT, SCL, SELECTION, SERAUXERRBAR, SERAUXTREND, SERFMT, SERIES, SERIESLIST, SERIESTEXT, SERPARENT, SERTOCRT, SETUP, SHAREDUPES, SHEETLAYOUT, SHEETPROTECTION, SHRFMLA, SHTPROPS, SIIINDEX, SST, STARTBLOCK, STARTOBJECT, STRING_ENCODING_AUTO, STRING_ENCODING_COMPRESSED, STRING_ENCODING_UNICODE, STRINGREC, STYLE, SUPBOOK, SURFACE, SXADDL, SXBOOL, SXDB, SXDBB, SXDBEX, SXDI, SXEX, SXFDB, SXFDBTYPE, SXFORMAT, SXIVD, SXLI, SXNUM, SXPI, SXSTREAMID, SXSTRING, SXVD, SXVDEX, SXVI, SXVIEW, SXVIEWEX9, SXVIEWLINK, SXVS, TABID, TABLE, TABLESTYLES, TEXTDISP, THREED, TICK, TOP_MARGIN, TOPMARGIN, TXO, TYPE_BLANK, TYPE_BOOLEAN, TYPE_DOUBLE, TYPE_FORMULA, TYPE_FP, TYPE_INT, TYPE_STRING, UNICODEENCODING, UNITS, USERBVIEW, USERSVIEWBEGIN, USERSVIEWEND, USETEMPFILE_PROP, USR_EXCL, VALIDATEWORKBOOK, VALUERANGE, VB_MODULE, VCENTER, VERTICAL_PAGE_BREAKS, WINDOW_PROTECT, WINDOW1, WINDOW2, WK_CHART, WK_FILE, WK_GLOBALS, WK_MACROSHEET, WK_WORKSHEET, WSBOOL, XCT, XF, XLS_MAX_COLS, YMULT

Constructor Summary

Constructors

Constructor and Description
Sst()

Method Summary

Modifier and Type	Method and Description
void	close() clear out object references in prep for closing workbook
static Unicodestring	createUnicodeString(String s, ArrayList formattingRuns, int ENCODINGMODE) Create a unicode string
ArrayList	getAllStrings() Returns all strings that are in the SharedStringTable for this workbook.
static Object[]	getContinueDef(Sst rec, boolean cached) return the sizes of Continue records for an Sst caches the read if neccesary
int	getLength() Returns the length of this record, including the 4 header bytes
int	getNumContinues() return # continues
int	getNumTotal() return the total number of strings in the SST
int	getNumUnique() return the number of unique strings in the SST
int	getRealOriginalSize()
List	getStringVector() Returns the String vector
boolean	getUpdatesAllBOFPositions() because the SST comes between the BOUNDSHEET records and all BOUNDSHEET BOFs, the lbPlyPos needs to change for all of them when record size changes.
void	init() perform record initialization
static void	init(Sst sst) Initializes the sst as well as initializing the UnicodeStrings contained within
static ArrayList	parseOOXML(WorkBookHandle bk, InputStream ii) given SharedStrings.xml OOXML inputstream, read in string and formatting data, if any and parse into ArrayList for later use in parseSheetOOXML
void	preStream() we need to override stream to update changes to the byte array
void	removeContinues() removes all existing Continues from the Sst
void	setData(byte[] b)
void	setStringEncodingMode(int mode)
String	toString()
void	writeOOXML(Writer zip) generate the OOXML necessary to describe this string table, also fill sststrings list with unique sststrings

Methods inherited from class io.starter.formats.XLS.XLSRecord

addContinue, clone, copyFormat, getBooleanVal, getByteAt, getByteReader, getBytes, getBytesAt, getCellAddress, getCellAddressWithSheet, getCellType, getColNumber, getColorTable, getContinueVect, getData, getDataType, getDblVal, getDefaultVal, getEncryptedByteReader, getFirstBlock, getFloatVal, getFont, getFormatPattern, getFormulaRec, getHyperlink, getInternalVal, getIntLocation, getIntVal, getIxfe, getLastBlock, getMergeRange, getOffset, getOpcode, getPrototype, getRealRecordIndex, getRecDesc, getRecordIndex, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getStringVal, getWorkBook, getXfRec, hasContinues, initRowCol, isFormula, isNumber, isReadOnly, isValueForCell, mergeContinues, postStream, remove, resetCacheBytes, setBooleanVal, setByteReader, setCol, setDebugLevel, setDoubleVal, setEncryptedByteReader, setFirstBlock, setFloatVal, setHyperlink, setIndex, setIntVal, setIsValueForCell, setIxfe, setLastBlock, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setRowNumber, setSheet, setStreamer, setStringVal, setValueForCell, setWorkBook, setXFRecord, setXFRecord, shouldEncrypt, toHexDump

Methods inherited from class java.lang.Object

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

Constructor Detail

Sst

public Sst()

Method Detail

getRealOriginalSize

public int getRealOriginalSize()

setData

public void setData(byte[] b)

Specified by:

setData in interface BiffRec

Overrides:

setData in class XLSRecord

removeContinues

public void removeContinues()

removes all existing Continues from the Sst

Specified by:

removeContinues in interface BiffRec

Overrides:

removeContinues in class XLSRecord

getUpdatesAllBOFPositions

public boolean getUpdatesAllBOFPositions()

because the SST comes between the BOUNDSHEET records and all BOUNDSHEET BOFs, the lbPlyPos needs to change for all of them when record size changes.

init

public void init()

Description copied from class: XLSRecord

perform record initialization

Specified by:

init in interface BiffRec

Overrides:

init in class XLSRecord

init

public static void init(Sst sst)

Initializes the sst as well as initializing the UnicodeStrings contained within

close

public void close()

clear out object references in prep for closing workbook

Overrides:

close in class XLSRecord

getContinueDef

public static Object[] getContinueDef(Sst rec,
                                      boolean cached)

return the sizes of Continue records for an Sst caches the read if neccesary

setStringEncodingMode

public void setStringEncodingMode(int mode)

createUnicodeString

public static Unicodestring createUnicodeString(String s,
                                                ArrayList formattingRuns,
                                                int ENCODINGMODE)

Create a unicode string

Parameters:

s -

formattingRuns -

ENCODINGMODE -

Returns:

getStringVector

public List getStringVector()

Returns the String vector

getNumTotal

public int getNumTotal()

return the total number of strings in the SST

Returns:

getNumUnique

public int getNumUnique()

return the number of unique strings in the SST

Returns:

getNumContinues

public int getNumContinues()

return # continues

Returns:

preStream

public void preStream()

we need to override stream to update changes to the byte array

Specified by:

preStream in interface BiffRec

Overrides:

preStream in class XLSRecord

toString

public String toString()

Overrides:

toString in class XLSRecord

writeOOXML

public void writeOOXML(Writer zip)
                throws IOException

generate the OOXML necessary to describe this string table, also fill sststrings list with unique sststrings

Parameters:

sststrings -

Throws:

IOException

parseOOXML

public static ArrayList parseOOXML(WorkBookHandle bk,
                                   InputStream ii)

given SharedStrings.xml OOXML inputstream, read in string and formatting data, if any and parse into ArrayList for later use in parseSheetOOXML

Parameters:

bk - WorkBookHandle

ii - InputStream

Returns:

String ArrayList return list of shared strings

See Also:

parseSheetOOXML

getAllStrings

public ArrayList getAllStrings()

Returns all strings that are in the SharedStringTable for this workbook. The SST contains all standard string records in cells, but may not include such things as strings that are contained within formulas. This is useful for such things as full text indexing of workbooks

Returns:

Strings in the workbook.

getLength

public int getLength()

Returns the length of this record, including the 4 header bytes

Specified by:

getLength in interface BlockByteConsumer

Specified by:

getLength in interface BiffRec

Overrides:

getLength in class XLSRecord

Returns: