io.starter.formats.XLS

Class QsiSXTag

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.QsiSXTag

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public class QsiSXTag
extends XLSRecord
implements XLSConstants

QxiSxTag 0x802 The QsiSXTag record specifies the name and refresh information for a query table or a PivotTable view, and specifies the beginning of a collection of records as defined by the Worksheet SubstreamABNF. The collection of records specifies additional information for a query table or a PivotTable view. If fSx is 0 and stName is equal to the rgchName field of a Qsi record in this worksheet substream, then this collection of records applies to the query table that the Qsi record is associated with. If fSx is 1 and stName is equal to the stName field of an SxView record in this worksheet substream, then this collection of records applies to the PivotTable view that the SxView record is associated with and its associated PivotCache. Otherwise, this collection of records MUST be ignored. frtHeaderOld (4 bytes): An FrtHeaderOld structure. The frtHeaderOld.rt field MUST be 0x0802. fSx (2 bytes): A Boolean (section 2.5.14) that specifies whether this record relates to a PivotTable view or a query table. Value Meaning 0x0000 Specifies that this record relates to a query table. 0x0001 Specifies that this record relates to a PivotTable view. A - fEnableRefresh (1 bit): A bit that specifies whether refresh of the PivotTable view or query table is enabled. MUST be 0 if fSx is 1 and the PivotCache functionality level of the associated PivotCache is greater than or equal to 3. Value Value of fSx Meaning 0 0 Whether refresh of the query table is enabled is specified by the fDisableRefresh field of the associated Qsi record. 0 1 Whether refresh of the associated PivotCache is enabled is specified by the fEnableRefresh field in the SXDB record of the PivotCache. 1 0 Specifies that refresh of the query table is enabled. 1 1 Specifies that refresh of the associated PivotCache is enabled. B - fInvalid (1 bit): A bit that specifies the invalid state of the cache records of the associated PivotCache; see Cache Records for more information. MUST be 1 if fSx is 1 and the PivotCache functionality level of the associated PivotCache is greater than or equal to 3. C - fTensorEx (1 bit): A bit that specifies whether the PivotTable view is an OLAP PivotTable view. MUST be equal to 0 if fSx is 0. reserved1 (13 bits): MUST be zero, and MUST be ignored. dwQsiFuture (4 bytes): This structure specifies additional option flags for a query table or a PivotTable view depending on the value of the fSx field. Value of fSx Fields Type of dwQsiFuture 0x0000 DwQsiFuture 0x0001 SXView9Save verSxLastUpdated (1 byte): A DataFunctionalityLevel value that specifies the data functionality level that the PivotTable view was last refreshed with. MUST be 0 if this record relates to a query table. verSxUpdatableMin (1 byte): A DataFunctionalityLevel value that specifies the minimum version of the application that can recalculate the PivotTable view. MUST be 0x00 or 0x03. MUST be 0 if this record is for a query table. MUST be 3 if the PivotCache functionality level of the associated PivotCache is 3. obCchName (1 byte): MUST be 0x10, and MUST be ignored. reserved2 (1 byte): MUST be zero, and MUST be ignored. stName (variable): An XLUnicodeString structure that specifies the query table or PivotTable view name. unused (2 bytes): Undefined and MUST be ignored.

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

Method Summary

Modifier and Type	Method and Description
String	getName() returns the name of this pivot item; if not null, is the caption for this pivot item
static XLSRecord	getPrototype()
void	init() perform record initialization
void	setName(String name) returns the name of this pivot item; if not null, is the caption for this pivot item

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, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

QsiSXTag

public QsiSXTag()

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

getName

public String getName()

returns the name of this pivot item; if not null, is the caption for this pivot item

Returns:

setName

public void setName(String name)

returns the name of this pivot item; if not null, is the caption for this pivot item

getPrototype

public static XLSRecord getPrototype()