io.starter.formats.XLS

Class ByteStreamer

java.lang.Object

io.starter.formats.XLS.ByteStreamer

All Implemented Interfaces:

XLSConstants, Serializable

public class ByteStreamer
extends Object
implements Serializable, XLSConstants

ByteStreamer Handles the low-level byte array streaming of the WorkBook. Basically a collection of XLS and methods for getting at their data.

See Also:

WorkBook, Boundsheet, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected WorkBook	workbook

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
ByteStreamer(WorkBook bk)

Method Summary

Modifier and Type	Method and Description
void	addRecord(BiffRec rec) add an BiffRec to this streamer.
void	addRecordAt(BiffRec rec, int idx) add an BiffRec to this streamer at the specified index.
void	addRecordToBookStreamerAt(BiffRec rec, int idx) Bypass the sheet vecs...
void	addRecordToSheetStreamerAt(BiffRec rec, int idx, Boundsheet sht) add an BiffRec to this streamer at the specified index.
void	close() clear out object references
Object[]	getBiffRecords() Returns an array of all the BiffRecs in the streamer.
byte[]	getBytes()
String	getName()
int	getRealRecordIndex(BiffRec rec) get the real (non-boundsheet based) recvec index of this record
BiffRec	getRecordAt(int t) get a record from the underlying array
BiffRec	getRecordAt(int t, BiffRec rec) get a record from the underlying array
int	getRecordIndex(BiffRec rec) get the recvec index of this record
int	getRecordIndex(int opcode)
int	getRecVecSize()
short	getSubstreamType()
String	getSubstreamTypeName()
void	initTestRecVect()
boolean	removeRecord(BiffRec rec) remove a record from the underlying array
void	setBiffRecords(Collection recs)
void	setBytes(byte[] b)
int	streamOut(OutputStream _out) stream the bytes to an outputstream
void	WriteAllRecs(String fName)
void	WriteAllRecs(String fName, boolean bWriteSheetRecs) Debug utility to write out ALL BIFF records
StringBuffer	writeOut(OutputStream out) Write all of the records to the output stream, including creating lbplypos records, assembling continues, etc.
void	writeRecord(OutputStream out, BiffRec rec)
static int	writeRecs(ArrayList recArr, BufferedWriter writer, int ctr, int level) Debug utility to write out BIFF records in friendly fashion

Methods inherited from class java.lang.Object

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

Field Detail

workbook

protected WorkBook workbook

Constructor Detail

ByteStreamer

public ByteStreamer(WorkBook bk)

Method Detail

getRecordIndex

public int getRecordIndex(int opcode)

initTestRecVect

public void initTestRecVect()

getBiffRecords

public Object[] getBiffRecords()

Returns an array of all the BiffRecs in the streamer. For debug purposes, as there is no way to directy view the FastAddVector

Returns:

setBiffRecords

public void setBiffRecords(Collection recs)

setBytes

public void setBytes(byte[] b)

getBytes

public byte[] getBytes()

getRecVecSize

public int getRecVecSize()

getName

public String getName()

getSubstreamTypeName

public String getSubstreamTypeName()

getSubstreamType

public short getSubstreamType()

getRecordAt

public BiffRec getRecordAt(int t,
                           BiffRec rec)

get a record from the underlying array

getRecordAt

public BiffRec getRecordAt(int t)

get a record from the underlying array

removeRecord

public boolean removeRecord(BiffRec rec)

remove a record from the underlying array

getRecordIndex

public int getRecordIndex(BiffRec rec)

get the recvec index of this record

getRealRecordIndex

public int getRealRecordIndex(BiffRec rec)

get the real (non-boundsheet based) recvec index of this record

addRecord

public void addRecord(BiffRec rec)

add an BiffRec to this streamer.

addRecordToBookStreamerAt

public void addRecordToBookStreamerAt(BiffRec rec,
                                      int idx)

Bypass the sheet vecs...

Parameters:

rec -

idx -

addRecordToSheetStreamerAt

public void addRecordToSheetStreamerAt(BiffRec rec,
                                       int idx,
                                       Boundsheet sht)

add an BiffRec to this streamer at the specified index.

addRecordAt

public void addRecordAt(BiffRec rec,
                        int idx)

add an BiffRec to this streamer at the specified index.

streamOut

public int streamOut(OutputStream _out)

stream the bytes to an outputstream

writeRecord

public void writeRecord(OutputStream out,
                        BiffRec rec)
                 throws IOException

Throws:

IOException

writeOut

public StringBuffer writeOut(OutputStream out)

Write all of the records to the output stream, including creating lbplypos records, assembling continues, etc.

WriteAllRecs

public void WriteAllRecs(String fName)

WriteAllRecs

public void WriteAllRecs(String fName,
                         boolean bWriteSheetRecs)

Debug utility to write out ALL BIFF records

Parameters:

fName - output filename

bWriteSheeRecs - truth of "include sheet records in output"

writeRecs

public static int writeRecs(ArrayList recArr,
                            BufferedWriter writer,
                            int ctr,
                            int level)

Debug utility to write out BIFF records in friendly fashion

Parameters:

recArr - array of records

writer - BufferedWriter

level - For ChartRecs that have sub-records, recurse Level

close

public void close()

clear out object references