io.starter.formats.XLS

Class Sxvi

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.Sxvi

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public class Sxvi
extends XLSRecord

SXVI B2h: This record stores view information about an Item. itmType (2 bytes): A signed integer that specifies the pivot item type. The value MUST be one of the following values: Value Name Meaning 0x0000 itmtypeData A data value 0x0001 itmtypeDEFAULT Default subtotal for the pivot field 0x0002 itmtypeSUM Sum of values in the pivot field 0x0003 itmtypeCOUNTA Count of values in the pivot field 0x0004 itmtypeAVERAGE Average of values in the pivot field 0x0005 itmtypeMAX Max of values in the pivot field 0x0006 itmtypeMIN Min of values in the pivot field 0x0007 itmtypePRODUCT Product of values in the pivot field 0x0008 itmtypeCOUNT Count of numbers in the pivot field 0x0009 itmtypeSTDEV Statistical standard deviation (estimate) of the pivot field 0x000A itmtypeSTDEVP Statistical standard deviation (entire population) of the pivot field 0x000B itmtypeVAR Statistical variance (estimate) of the pivot field 0x000C itmtypeVARP Statistical variance (entire population) of the pivot field A - fHidden (1 bit): A bit that specifies whether this pivot item is hidden. MUST be zero if itmType is not itmtypeData. MUST be zero for OLAP PivotTable view. B - fHideDetail (1 bit): A bit that specifies whether the pivot item detail is collapsed. MUST be zero for OLAP PivotTable view. C - reserved1 (1 bit): MUST be zero, and MUST be ignored. D - fFormula (1 bit): A bit that specifies whether this pivot item is a calculated item. This field MUST be zero if any of the following apply: itmType is not zero. This item is in an OLAP PivotTable view. The sxaxisPage field of sxaxis in the Sxvd record of the pivot field equals 1 (the associated Sxvd is the last Sxvd record before this record in the stream (1)). The fCalculatedField field in the SXVDEx record of the pivot field equals 1. There is not an associated SXFDB record in the associated PivotCache. The fRangeGroup field of the SXFDB record, of the associated cache field of the pivot field, equals 1. The fCalculatedField field of the SXFDB record, of the associated cache field of the pivot field, equals 1. E - fMissing (1 bit): A bit that specifies if this pivot item does not exist in the data source (1). MUST be zero if itmType is not zero. MUST be zero for OLAP PivotTable view. reserved2 (11 bits): MUST be zero, and MUST be ignored. iCache (2 bytes): A signed integer that specifies a reference to a cache item. MUST be a value from the following table: Value Meaning -1 No cache item is referenced. 0+ A cache item index in the cache field associated with the pivot field, as specified by Cache Items. If itmType is not zero, a reference to a cache item is not specified and this value MUST be -1. Otherwise, this value MUST be greater than or equal to 0. cchName (2 bytes): An unsigned integer that specifies the length of the stName string. If the value is 0xFFFF then stName is NULL. Otherwise, the value MUST be less than or equal to 254. stName (variable): An XLUnicodeStringNoCch structure that specifies the name of this pivot item. If not NULL, this is used as the caption of the pivot item instead of the value in the cache item specified by iCache. The length of this field is specified in cchName. This field exists only if cchName is not 0xFFFF. If this is in a non-OLAP PivotTable view and this string is not NULL, it MUST be unique within all SXVI records in associated with the pivot field.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static short	itmtypeAVERAGE
static short	itmtypeCOUNT
static short	itmtypeCOUNTA
static short	itmtypeData
static short	itmtypeDEFAULT
static short	itmtypeMAX
static short	itmtypeMIN
static short	itmtypePRODUCT
static short	itmtypeSTDEV
static short	itmtypeSTDEVP
static short	itmtypeSUM
static short	itmtypeVAR
static short	itmtypeVARP

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

Method Summary

Modifier and Type	Method and Description
boolean	getIsCollapsed() specifies whether the pivot item detail is collapsed.
boolean	getIsHidden() returns true if this pivot item is hidden
short	getItemType() returns the type of this pivot item one of: 0x0000 itmtypeData A data value 0x0001 itmtypeDEFAULT Default subtotal for the pivot field 0x0002 itmtypeSUM Sum of values in the pivot field 0x0003 itmtypeCOUNTA Count of values in the pivot field 0x0004 itmtypeAVERAGE Average of values in the pivot field 0x0005 itmtypeMAX Max of values in the pivot field 0x0006 itmtypeMIN Min of values in the pivot field 0x0007 itmtypePRODUCT Product of values in the pivot field 0x0008 itmtypeCOUNT Count of numbers in the pivot field 0x0009 itmtypeSTDEV Statistical standard deviation (estimate) of the pivot field 0x000A itmtypeSTDEVP Statistical standard deviation (entire population) of the pivot field 0x000B itmtypeVAR Statistical variance (estimate) of the pivot field 0x000C itmtypeVARP Statistical variance (entire population) of the pivot field
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	setCacheItem(int icache) reference to a cache item : -1 No cache item is referenced.
void	setIsCollapsed(boolean b) specifies whether the pivot item detail is collapsed.
void	setIsHidden(boolean b) sets the hidden state for this pivot item
void	setItemType(int type) sets the pivot item type: one of: 0x0000 itmtypeData A data value 0x0001 itmtypeDEFAULT Default subtotal for the pivot field 0x0002 itmtypeSUM Sum of values in the pivot field 0x0003 itmtypeCOUNTA Count of values in the pivot field 0x0004 itmtypeAVERAGE Average of values in the pivot field 0x0005 itmtypeMAX Max of values in the pivot field 0x0006 itmtypeMIN Min of values in the pivot field 0x0007 itmtypePRODUCT Product of values in the pivot field 0x0008 itmtypeCOUNT Count of numbers in the pivot field 0x0009 itmtypeSTDEV Statistical standard deviation (estimate) of the pivot field 0x000A itmtypeSTDEVP Statistical standard deviation (entire population) of the pivot field 0x000B itmtypeVAR Statistical variance (estimate) of the pivot field 0x000C itmtypeVARP Statistical variance (entire population) of the pivot field
void	setName(String name) returns the name of this pivot item; if not null, is the caption for this pivot item
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

Field Detail

itmtypeData

public static final short itmtypeData

See Also:

Constant Field Values

itmtypeDEFAULT

public static final short itmtypeDEFAULT

See Also:

Constant Field Values

itmtypeSUM

public static final short itmtypeSUM

See Also:

Constant Field Values

itmtypeCOUNTA

public static final short itmtypeCOUNTA

See Also:

Constant Field Values

itmtypeAVERAGE

public static final short itmtypeAVERAGE

See Also:

Constant Field Values

itmtypeMAX

public static final short itmtypeMAX

See Also:

Constant Field Values

itmtypeMIN

public static final short itmtypeMIN

See Also:

Constant Field Values

itmtypePRODUCT

public static final short itmtypePRODUCT

See Also:

Constant Field Values

itmtypeCOUNT

public static final short itmtypeCOUNT

See Also:

Constant Field Values

itmtypeSTDEV

public static final short itmtypeSTDEV

See Also:

Constant Field Values

itmtypeSTDEVP

public static final short itmtypeSTDEVP

See Also:

Constant Field Values

itmtypeVAR

public static final short itmtypeVAR

See Also:

Constant Field Values

itmtypeVARP

public static final short itmtypeVARP

See Also:

Constant Field Values

Constructor Detail

Sxvi

public Sxvi()

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

getItemType

public short getItemType()

returns the type of this pivot item
one of:

0x0000 itmtypeData A data value 0x0001 itmtypeDEFAULT Default subtotal for the pivot field 0x0002 itmtypeSUM Sum of values in the pivot field 0x0003 itmtypeCOUNTA Count of values in the pivot field 0x0004 itmtypeAVERAGE Average of values in the pivot field 0x0005 itmtypeMAX Max of values in the pivot field 0x0006 itmtypeMIN Min of values in the pivot field 0x0007 itmtypePRODUCT Product of values in the pivot field 0x0008 itmtypeCOUNT Count of numbers in the pivot field 0x0009 itmtypeSTDEV Statistical standard deviation (estimate) of the pivot field 0x000A itmtypeSTDEVP Statistical standard deviation (entire population) of the pivot field 0x000B itmtypeVAR Statistical variance (estimate) of the pivot field 0x000C itmtypeVARP Statistical variance (entire population) of the pivot field

Returns:

setItemType

public void setItemType(int type)

sets the pivot item type:
one of:

0x0000 itmtypeData A data value 0x0001 itmtypeDEFAULT Default subtotal for the pivot field 0x0002 itmtypeSUM Sum of values in the pivot field 0x0003 itmtypeCOUNTA Count of values in the pivot field 0x0004 itmtypeAVERAGE Average of values in the pivot field 0x0005 itmtypeMAX Max of values in the pivot field 0x0006 itmtypeMIN Min of values in the pivot field 0x0007 itmtypePRODUCT Product of values in the pivot field 0x0008 itmtypeCOUNT Count of numbers in the pivot field 0x0009 itmtypeSTDEV Statistical standard deviation (estimate) of the pivot field 0x000A itmtypeSTDEVP Statistical standard deviation (entire population) of the pivot field 0x000B itmtypeVAR Statistical variance (estimate) of the pivot field 0x000C itmtypeVARP Statistical variance (entire population) of the pivot field