io.starter.formats.XLS

Class Sxvd

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.Sxvd

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public class Sxvd
extends XLSRecord

SXVD b[1]h: View Fields The Sxvd record specifies pivot field properties and specifies the beginning of a collection of records. This collection of records specifies details for a pivot field.

    offset  name        size    contents
    ---    
    4       sxaxis      2       0x0 = no axis
                                0x1 = row
                                0x2 = col
                                0x4 = page
                                0x8 = data
    6       cSub        2       Number of subtotals attached
    8       grbitSub    2       Item subtotal type (see subtable)
    10      cItm        2       Number of items
    12      cchName     2       Length of the name if name= 0xFFFF, rgch is null and name in cache used.
    14      rgch        var     name

    name        contents
    --------------------------------
    bitFNone    0000
    bitFDefault 0001
    bitFSum     0002
    bitFCounta  0004
    bitFAvg     0008
    bitFMax     0010
    bitFMin     0020
    
    

MORE INFO: sxaxis (2 bytes): An SXAxis structure that specifies the PivotTable axis that this pivot field is on. If the sxaxis.sxaxisData field equals 1, there MUST be a corresponding SXDI record with an isxvd field that specifies this Sxvd record. cSub (2 bytes): An unsigned integer that specifies the number of subtotal functions used for this pivot field. MUST equal the count of subtotal fields of this record whose value is 1. The subtotal fields of this record are fDefault, fSum, fCounta, fAverage, fMax, fMin, fProduct, fCount, fStdev, fStdevp, fVariance, and fVariancep. For more information, see Subtotalling. A - fDefault (1 bit): A bit that specifies whether the default subtotal function is applied. The default subtotal is separately determined for each data item. If the fDefault field equals 1 and the sxaxis.sxaxisRw field equals 1 or if the sxaxis.sxaxisCol field equals 1 or if the sxaxis.sxaxisPage field equals 1, there MUST be one SXVI record with the itmType field of the SXVI record equal to 1. MUST be a value from the following table: Value Meaning 0 The default subtotal function is not applied. 1 The default subtotal function is applied. B - fSum (1 bit): A bit that specifies whether the sum subtotal function is displayed. If the fDefault field equals 1, this value MUST be zero. If the fSum field equals 1 and the sxaxis.sxaxisRw field equals 1 or if the sxaxis.sxaxisCol field equals 1 or if the sxaxis.sxaxisPage field equals 1, there MUST be one SXVI record with the itmType field of the SXVI record equal to 2. MUST be a value from the following table: Value Meaning 0 The sum subtotal function is not displayed. 1 The sum subtotal function is displayed. C - fCounta (1 bit): A bit that specifies whether the count subtotal function is displayed. If the fDefault field equals 1, this value MUST be zero. If the fCounta field equals 1 and the sxaxis.sxaxisRw field equals 1 or if the sxaxis.sxaxisCol field equals 1 or if the sxaxis.sxaxisPage field equals 1, there MUST be one SXVI record with the itmType field of the SXVI record equal to 3. MUST be a value from the following table: Value Meaning 0 The count subtotal function is not displayed. 1 The count subtotal function is displayed. D - fAverage (1 bit): A bit that specifies whether the average subtotal function is displayed. If the fDefault field equals 1, this value MUST be zero. If the fAverage field equals 1 and the sxaxis.sxaxisRw field equals 1 or if the sxaxis.sxaxisCol field equals 1 or if the sxaxis.sxaxisPage field equals 1, there MUST be one SXVI record with the itmType field of the SXVI record equal to 4. MUST be a value from the following table: Value Meaning 0 The average subtotal function is not displayed. 1 The average subtotal function is displayed. E - fMax (1 bit): A bit that specifies whether the max subtotal function is displayed. If the fDefault field equals 1, this value MUST be zero. If the fMax field equals 1 and the sxaxis.sxaxisRw field equals 1 or if the sxaxis.sxaxisCol field equals 1 or if the sxaxis.sxaxisPage field equals 1, there MUST be one SXVI record with the itmType field of the SXVI record equal to 5. MUST be a value from the following table: Value Meaning 0 The max subtotal function is not displayed. 1 The max subtotal function is displayed. F - fMin (1 bit): A bit that specifies whether the min subtotal function is displayed. If the fDefault field equals 1, this value MUST be zero. If the fMin field equals 1 and the sxaxis.sxaxisRw field equals 1 or if the sxaxis.sxaxisCol field equals 1 or if the sxaxis.sxaxisPage field equals 1, there MUST be one SXVI record with the itmType field of the SXVI record equal to 6. MUST be a value from the following table: Value Meaning 0 The min subtotal function is not displayed. 1 The min subtotal function is displayed. G - fProduct (1 bit): A bit that specifies whether the product subtotal function is displayed. If the fDefault field is 1, this value MUST be zero. If the fProduct field is 1 and the sxaxis.sxaxisRw field equals 1 or if the sxaxis.sxaxisCol field equals 1 or if the sxaxis.sxaxisPage field equals 1, there MUST be one SXVI record with the itmType field of the SXVI record equal to 7. MUST be a value from the following table: Value Meaning 0 The product subtotal function is not displayed. 1 The product subtotal function is displayed. H - fCount (1 bit): A bit that specifies whether the count numbers subtotal function is displayed. If the fDefault field is 1, this value MUST be zero. If the fCount field equals 1 and the sxaxis.sxaxisRw field equals 1 or if the sxaxis.sxaxisCol field equals 1 or if the sxaxis.sxaxisPage field equals 1, there MUST be one SXVI record with the itmType field of the SXVI record equal to 8. MUST be a value from the following table: Value Meaning 0 The count numbers subtotal function is not displayed. 1 The count numbers subtotal function is displayed. I - fStdev (1 bit): A bit that specifies whether the standard deviation subtotal function is displayed. If the fDefault field is 1, this value MUST be zero. If the fStdev field equals 1 and the sxaxis.sxaxisRw field equals 1 or if the sxaxis.sxaxisCol field equals 1 or if the sxaxis.sxaxisPage field equals 1, there MUST be one SXVI record with the itmType field of the SXVI record equal to 9. MUST be a value from the following table: Value Meaning 0 The standard deviation subtotal function is not displayed. 1 The standard deviation subtotal function is displayed. J - fStdevp (1 bit): A bit that specifies whether the standard deviation population subtotal function is displayed. If the fDefault field equals 1, this value MUST be zero. If the fStdevp field equals 1 and the sxaxis.sxaxisRw field equals 1 or if the sxaxis.sxaxisCol field equals 1 or if the sxaxis.sxaxisPage field equals 1, there MUST be one SXVI record with the itmType field of the SXVI record equal to 10. MUST be a value from the following table: Value Meaning 0 The standard deviation population subtotal function is not displayed. 1 The standard deviation population subtotal function is displayed. K - fVariance (1 bit): A bit that specifies whether the variance subtotal function is displayed. If the fDefault field is 1, this value MUST be zero. If the fVariance field is 1 and the sxaxis.sxaxisRw field equals 1 or if the sxaxis.sxaxisCol field equals 1 or if the sxaxis.sxaxisPage field equals 1, there MUST be one SXVI record with the itmType field of the SXVI record equal to 11. MUST be a value from the following table: Value Meaning 0 The variance subtotal function is not displayed. 1 The variance subtotal function is displayed. L - fVariancep (1 bit): A bit that specifies whether the variance population subtotal function is displayed. If the fDefault field is 1, the value MUST be zero. If the fVariancep field equals 1 and sxaxis.sxaxisRw field equals 1 or if the sxaxis.sxaxisCol field equals 1 or if the sxaxis.sxaxisPage field equals 1, there MUST be one SXVI record with the itmType field of the SXVI record equal to 12. MUST be a value from the following table: Value Meaning 0 The variance population subtotal function is not displayed. 1 The variance population subtotal function is displayed. M - reserved (4 bits): MUST be zero, and MUST be ignored. cItm (2 bytes): A signed integer that specifies the number of pivot items for this pivot field. This value MUST match the number of SXVI records following this record and MUST be less than or equal to the following formula: 32500 + the cSub field cchName (2 bytes): An unsigned integer that specifies the length, in characters, of the stName field. If the value is 0xFFFF then stName is NULL. The value MUST be 0xFFFF or greater than zero and less than or equal to 255. stName (variable): An XLUnicodeStringNoCch structure that specifies the caption of this pivot field. A non-NULL value specifies that this string is used to override the stFieldName field in SXFDB record from the associated cache field, as specified in pivot fields. The length is specified in cchName. This field exists only if the value of cchName is not 0xFFFF. If this PivotTable view is not an OLAP PivotTable view and this string is non-NULL, then stName MUST be unique within all Sxvd records in this PivotTable view.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static short	AXIS_COL
static short	AXIS_DATA
static short	AXIS_NONE
static short	AXIS_PAGE
static short	AXIS_ROW

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

Method Summary

Modifier and Type	Method and Description
static XLSRecord	getPrototype()
String	getSubTotalFunction() returns the String representation of the subtotal function for the axis defined in this record
void	init() perform record initialization
void	setAxis(int axis) sets the axis for this pivot field 1= row 2= col 4= page 8= data
void	setNumItems(int n)
void	setSubTotalFunction(String[] f) Sets the subtotal function(s) for this pivot field.
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

AXIS_NONE

public static final short AXIS_NONE

See Also:

Constant Field Values

AXIS_ROW

public static final short AXIS_ROW

See Also:

Constant Field Values

AXIS_COL

public static final short AXIS_COL

See Also:

Constant Field Values

AXIS_PAGE

public static final short AXIS_PAGE

See Also:

Constant Field Values

AXIS_DATA

public static final short AXIS_DATA

See Also:

Constant Field Values

Constructor Detail

Sxvd

public Sxvd()

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

getSubTotalFunction

public String getSubTotalFunction()

returns the String representation of the subtotal function for the axis defined in this record

Returns:

setSubTotalFunction

public void setSubTotalFunction(String[] f)

Sets the subtotal function(s) for this pivot field.

"Default"; "Sum"; "Count"; "Average"; "Max"; "Min"; "Product"; "Stddev"; "StddevP"; "Variance"; "VarianceP";

Parameters:

f -

setAxis

public void setAxis(int axis)

sets the axis for this pivot field

1= row 2= col 4= page 8= data