io.starter.formats.XLS

Class WorkBookFactory

java.lang.Object

io.starter.formats.XLS.WorkBookFactory

All Implemented Interfaces:

XLSConstants, ProgressNotifier, Serializable

public class WorkBookFactory
extends Object
implements ProgressNotifier, XLSConstants, Serializable

Factory for creating WorkBook objects from Byte streams.

See Also:

WorkBook, XLSRecord, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	DEBUGLEVEL
protected LEOFile	myLEO
static long	serialVersionUID

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
WorkBookFactory()

Method Summary

Modifier and Type	Method and Description
void	fireProgressChanged()
int	getDebugLevel()
String	getFileName() get the file name for the WorkBook
protected static int	getNextOpcodeOffset(short op, BlockByteConsumer rec, BlockByteReader parsedata) Find the location of the next particular opcode
int	getProgress()
String	getProgressText()
Book	getWorkBook(BlockByteReader parsedata, LEOFile leo) read in a WorkBook from a byte array.
Book	initWorkBook(Book book, BlockByteReader parsedata, LEOFile leo) Initialize the workbook
boolean	iscompleted()
short	lookAhead(BiffRec rec) return the next opcode/length in the Stream from the given record.
protected BiffRec	parse(Book book, short opcode, int offset, int datalen, BlockByteReader bytebuf) create the individual records based on type
void	register(ProgressListener j)
void	setDebugLevel(int d)
void	setFileName(String f) sets the workbook filename associated with this wbfactory
void	setProgress(int progress)
void	setProgressText(String s)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

DEBUGLEVEL

protected int DEBUGLEVEL

myLEO

protected LEOFile myLEO

Constructor Detail

WorkBookFactory

public WorkBookFactory()

Method Detail

setDebugLevel

public void setDebugLevel(int d)

getDebugLevel

public int getDebugLevel()

register

public void register(ProgressListener j)

Specified by:

register in interface ProgressNotifier

fireProgressChanged

public void fireProgressChanged()

Specified by:

fireProgressChanged in interface ProgressNotifier

getProgress

public int getProgress()

Specified by:

getProgress in interface ProgressNotifier

getProgressText

public String getProgressText()

Specified by:

getProgressText in interface ProgressNotifier

setProgress

public void setProgress(int progress)

Specified by:

setProgress in interface ProgressNotifier

setProgressText

public void setProgressText(String s)

Specified by:

setProgressText in interface ProgressNotifier

iscompleted

public boolean iscompleted()

Specified by:

iscompleted in interface ProgressNotifier

getFileName

public String getFileName()

get the file name for the WorkBook

setFileName

public void setFileName(String f)

sets the workbook filename associated with this wbfactory

Parameters:

f -

lookAhead

public short lookAhead(BiffRec rec)

return the next opcode/length in the Stream from the given record.

getWorkBook

public Book getWorkBook(BlockByteReader parsedata,
                        LEOFile leo)
                 throws InvalidRecordException

read in a WorkBook from a byte array.

Throws:

InvalidRecordException

initWorkBook

public Book initWorkBook(Book book,
                         BlockByteReader parsedata,
                         LEOFile leo)
                  throws InvalidRecordException

Initialize the workbook

Parameters:

book -

parsedata -

leo -

Returns:

Throws:

InvalidRecordException

parse

protected BiffRec parse(Book book,
                        short opcode,
                        int offset,
                        int datalen,
                        BlockByteReader bytebuf)
                 throws InvalidRecordException

create the individual records based on type

Throws:

InvalidRecordException

getNextOpcodeOffset

protected static int getNextOpcodeOffset(short op,
                                         BlockByteConsumer rec,
                                         BlockByteReader parsedata)

Find the location of the next particular opcode