io.starter.formats.XLS

Class SxDB

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.SxDB

All Implemented Interfaces:

BlockByteConsumer, BiffRec, PivotCacheRecord, XLSConstants, Serializable

public class SxDB
extends XLSRecord
implements XLSConstants, PivotCacheRecord

SXDB 0xC6 The SXDB record specifies PivotCache properties. crdbdb (4 bytes): A signed integer that specifies the number of cache records for this PivotCache. MUST be greater than or equal to 0. MUST be 0 for OLAP PivotCaches. MUST be ignored if fSaveData is 0. idstm (2 bytes): An unsigned integer that specifies the stream that contains the data for this PivotCache. MUST be equal to the value of the idstm field of the SXStreamID record that specifies the PivotCache stream that contains this record. A - fSaveData (1 bit): A bit that specifies whether cache records exist. MUST be 0 for OLAP PivotCaches. B - fInvalid (1 bit): A bit that specifies whether the cache records are in the not-valid state. MUST be equal to 1 if the PivotCache functionality level is greater than or equal to 3. MUST be equal to 1 for OLAP PivotCaches. See cache records for more information. C - fRefreshOnLoad (1 bit): A bit that specifies whether the PivotCache is refreshed on load. D - fOptimizeCache (1 bit): A bit that specifies whether optimization is applied to the PivotCache to reduce memory usage. MUST be 0 and MUST be ignored for a non-ODBC PivotCache. E - fBackgroundQuery (1 bit): A bit that specifies whether the query used to refresh the PivotCache is executed asynchronously. MUST be ignored if vsType not equals 0x0002. F - fEnableRefresh (1 bit): A bit that specifies whether refresh of the PivotCache is enabled. MUST be equal to 0 if the PivotCache functionality level is greater than or equal to 3. MUST be equal to 0 for OLAP PivotCaches. unused1 (10 bits): Undefined and MUST be ignored. unused2 (2 bytes): Undefined and MUST be ignored. cfdbdb (2 bytes): A signed integer that specifies the number of cache fields that corresponds to the source data. MUST be greater than or equal to 0. cfdbTot (2 bytes): A signed integer that specifies the number of cache fields in the PivotCache. MUST be greater than or equal to 0. crdbUsed (2 bytes): An unsigned integer that specifies the number of records used to calculate the PivotTable report. Records excluded by PivotTable view filtering are not included in this value. MUST be 0 for OLAP PivotCaches. vsType (2 bytes): An unsigned integer that specifies the type of source data. MUST be equal to the value of the sxvs field of the SXVS record that follows the SXStreamID record that specifies the PivotCache stream that contains this record. cchWho (2 bytes): An unsigned integer that specifies the number of characters in rgb. MUST be equal to 0xFFFF, or MUST be greater than or equal to 1 and less than or equal to 0x00FF. rgb (variable): An optional XLUnicodeStringNoCch structure that specifies the name of the user who last refreshed the PivotCache. MUST exist if and only if the value of cchWho is not equal to 0xFFFF. If this field exists, the length MUST equal cchWho. The length of this value MUST be less than 256 characters. The name is an application-specific setting that is not necessarily related to the User Names StreamABNF.

See Also:

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

Method Summary

Modifier and Type	Method and Description
int	getNCacheFields() returns the number of cache fields (==columns) for the pivot cache
int	getNCacheRecords() returns the number of cache records (= number of non-header rows)
static XLSRecord	getPrototype() create a new minimum SXDB
byte[]	getRecord() return the bytes describing this record, including the header
short	getStreamID() returns the streamId -- index linked back to SxStreamID
void	init() perform record initialization
void	setNCacheFields(int n) sets the number of cache fields (==columns) for the pivot cache
void	setNCacheRecords(int n) sets the number of cache records (= number of non-header rows)
void	setStreamID(int sid) sets the streamId -- index linked back to SxStreamID
String	toString()

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

addContinue, clone, close, 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, preStream, remove, removeContinues, resetCacheBytes, setBooleanVal, setByteReader, setCol, setData, 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

SxDB

public SxDB()

Method Detail

init

public void init()

Description copied from class: XLSRecord

perform record initialization

Specified by:

init in interface BiffRec

Overrides:

init in class XLSRecord

toString

public String toString()

Overrides:

toString in class XLSRecord

getPrototype

public static XLSRecord getPrototype()

create a new minimum SXDB

Returns:

getRecord

public byte[] getRecord()

return the bytes describing this record, including the header

Specified by:

getRecord in interface PivotCacheRecord

Returns:

setNCacheRecords

public void setNCacheRecords(int n)

sets the number of cache records (= number of non-header rows)

Parameters:

n -

getNCacheRecords

public int getNCacheRecords()

returns the number of cache records (= number of non-header rows)

Returns:

getStreamID

public short getStreamID()

returns the streamId -- index linked back to SxStreamID

Returns:

setStreamID

public void setStreamID(int sid)

sets the streamId -- index linked back to SxStreamID

Parameters:

sid -

setNCacheFields

public void setNCacheFields(int n)

sets the number of cache fields (==columns) for the pivot cache

Parameters:

n -

getNCacheFields

public int getNCacheFields()

returns the number of cache fields (==columns) for the pivot cache