io.starter.formats.XLS

Class Dbcell

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.Dbcell

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public final class Dbcell
extends XLSRecord
implements XLSConstants

Dbcell: Stream Offsets 0xD7
Offsets for value records. There is one DBCELL for each 32-row block of Row records and associated cell records.

   offset  name        size    contents
   ---    
   4       dbRtrw      4       Offset from the start of the DBCELL 
                               to the start of the first Row in the block
   8       rgdb        var     Array of stream offsets, 2 bytes each.
   
   The internal format layout is basically:
   
   
   When a record value changes in size, it fires a CellChangeEvent 
   which cascades through the other associated objects.
   
   The record size change has the following effects on DBCELL record fields:
   
   1. Row records for the data block move relative to the
   DBCELL for the block.  The dbRtrw field tracks the position
   of the first Row record, so this needs to be updated in the
   DBCELL only for the changed record block.
   
   2. The *record*  offsets for the Row stored in the rgdb array
   change starting with the changed value.  These only change
   for the record block containing the changed value -- subsequent
   blocks maintain their relative position to their row and row
   records.
   

See Also:

WorkBook, Boundsheet, Index, Dbcell, Row, Cell, XLSRecord, 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
Dbcell()

Method Summary

Modifier and Type	Method and Description
void	close() clear out object references in prep for closing workbook
int	getdbRtrw() gets the value and updates the pointer.
Index	getIDX() get the associated dbcell index
int	getNumRows() returns the number of rows contained in this DBCELL.
static XLSRecord	getPrototype() get a new, empty DBCELL
void	init() Initialize the Dbcell
void	initDbCell(int offsetToFirstRow, List valrecOffsets) Init the dbcell with it's new values TODO: review these calls to look for performance gain possibilities.
void	preStream() do any pre-streaming processing such as expensive index updates or other deferrable processing.
void	setIndex(Index idx) set the Index record for this RowBlock there are many RowBlocks per Index record Index records need to update their DBCELL pointers when we add or move a DBCELL.

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, getLength, getMergeRange, getOffset, getOpcode, getRealRecordIndex, getRecDesc, getRecordIndex, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getStringVal, getWorkBook, getXfRec, hasContinues, initRowCol, isFormula, isNumber, isReadOnly, isValueForCell, mergeContinues, postStream, remove, removeContinues, resetCacheBytes, setBooleanVal, setByteReader, setCol, setData, setDebugLevel, setDoubleVal, setEncryptedByteReader, setFirstBlock, setFloatVal, setHyperlink, setIntVal, setIsValueForCell, setIxfe, setLastBlock, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setRowNumber, setSheet, setStreamer, setStringVal, setValueForCell, setWorkBook, setXFRecord, setXFRecord, shouldEncrypt, toHexDump, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Dbcell

public Dbcell()

Method Detail

initDbCell

public void initDbCell(int offsetToFirstRow,
                       List valrecOffsets)

Init the dbcell with it's new values TODO: review these calls to look for performance gain possibilities. This method can get called a lot on output.

Parameters:

offsetToFirstRow - - offset from the dbcell to the top row

valrecOffsets - - array of offsets from row to row in valrecs

setIndex

public void setIndex(Index idx)

set the Index record for this RowBlock there are many RowBlocks per Index record Index records need to update their DBCELL pointers when we add or move a DBCELL.

Specified by:

setIndex in interface BiffRec

Overrides:

setIndex in class XLSRecord

getdbRtrw

public int getdbRtrw()

gets the value and updates the pointer. this is the position of the first row in the row block.

getPrototype

public static XLSRecord getPrototype()

get a new, empty DBCELL

getNumRows

public int getNumRows()

returns the number of rows contained in this DBCELL. There should never be more than 32.

getIDX

public Index getIDX()

get the associated dbcell index

init

public void init()

Initialize the Dbcell

Specified by:

init in interface BiffRec

Overrides:

init in class XLSRecord

preStream

public void preStream()

Description copied from class: XLSRecord

do any pre-streaming processing such as expensive index updates or other deferrable processing.

Specified by:

preStream in interface BiffRec

Overrides:

preStream in class XLSRecord

close

public void close()

Description copied from class: XLSRecord

clear out object references in prep for closing workbook

Overrides:

close in class XLSRecord