io.starter.formats.XLS

Class SxDI

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.SxDI

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public class SxDI
extends XLSRecord
implements XLSConstants

SXDI 0xC5 The SXDI record specifies a data item for a PivotTable view. isxvdData (2 bytes): A signed integer that specifies a pivot field index as specified in Pivot Fields. If the PivotTable view is a non-OLAP PivotTable view, the values in the source data associated with the associated cache field of the referenced pivot field are aggregated as specified in this record. If the PivotTable view is an OLAP PivotTable view, the associated pivot hierarchy of the referenced pivot field specifies the OLAPmeasure for this data item and the iiftab field is ignored. See Association of Pivot Hierarchies and Pivot Fields and Cache Fields to determine the associated pivot hierarchy. MUST be greater than or equal to zero and less than the value of the cDim field of the preceding SxView record. The value of the sxaxis.sxaxisData field of the Sxvd record of the referenced pivot field MUST be 1. iiftab (2 bytes): A signed integer that specifies the aggregation function. MUST be a value from the following table: Value Meaning 0x0000 Sum of values 0x0001 Count of values 0x0002 Average of values 0x0003 Max of values 0x0004 Min of values 0x0005 Product of values 0x0006 Count of numbers 0x0007 Statistical standard deviation (sample) 0x0008 Statistical standard deviation (population) 0x0009 Statistical variance (sample) 0x000A Statistical variance (population) df (2 bytes): A signed integer that specifies the calculation used to display the value of this data item. MUST be a value from the following table: Value Meaning 0x0000 The data item value is displayed. 0x0001 Display as the difference between this data item value and the value of the pivot item specified by isxvi. 0x0002 Display as a percentage of the value of the pivot item specified by isxvi. 0x0003 Display as a percentage difference from the value of the pivot item specified by isxvi. 0x0004 Display as the running total for successive pivot items in the pivot field specified by isxvd. 0x0005 Display as a percentage of the total for the row containing this data item. 0x0006 Display as a percentage of the total for the column containing this data item. 0x0007 Display as a percentage of the grand total of the data item. 0x0008 Calculate the value to display using the following formula: ((this data item value) * (grand total of grand totals)) / ((row grand total) * (column grand total)) isxvd (2 bytes): A signed integer that specifies a pivot field index as specified in Pivot Fields. The referenced pivot field is used in calculations as specified by the df field. If df is 0x0001, 0x0002, 0x0003, or 0x0004 then the value of isxvd MUST be greater than or equal to zero and less than the value of the cDim field in the preceding SxView record. Otherwise, the value of isxvd is undefined and MUST be ignored. isxvi (2 bytes): A signed integer that specifies the pivot item used by df. If df is 0x0001, 0x0002, or 0x0003 then the value of this field MUST be a value from the following table: Value Meaning 0 to 0x7EFE A pivot item index, as specified by Pivot Items, that specifies a pivot item in the pivot field specified by isxvd. MUST be less than the cItm field of the Sxvd record of the pivot field specified by isxvd. 0x7FFB The previous pivot item in the pivot field specified by isxvd. 0x7FFC The next pivot item in the pivot field specified by isxvd. Otherwise, the value is undefined and MUST be ignored. ifmt (2 bytes): An IFmt structure that specifies the number format for this item. cchName (2 bytes): An unsigned integer that specifies the length, in characters, of the XLUnicodeStringNoCch structure in the stName field. If the value is 0xFFFF then stName does not exist. Otherwise, the value MUST be greater than zero and less than or equal to 0x00FF. MUST NOT be 0xFFFF when the PivotCache functionality level is less than 3, or for non-OLAP PivotTable view . stName (variable): An XLUnicodeStringNoCch structure that specifies the name of this data item. A value that is not NULL specifies that this string is used to override the name in the corresponding cache field. MUST NOT exist if cchName is 0xFFFF. Otherwise, MUST exist and the length MUST equal cchName. If this string is not NULL and the PivotTable view is a non-OLAP PivotTable view, this field MUST be unique within all SXDI records in this PivotTable view.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SxDI.AGGREGATIONFUNCTIONS enum possible aggregation functions for Data axis fields Sum, Counta, Average, Max, Min, Product, Count, StdDev, StdDevP, Var, VarP
static class	SxDI.DISPLAYTYPES enum possible display types for Data axis fields value -- The data item value is displayed.

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

Method Summary

Modifier and Type	Method and Description
void	addDataField(int fieldIndex, String aggregationFunction, String name) adds the data field to the DATA axis and it's aggregation function ("sum" is default)
int	getAggregationFunction() returns the aggregation function for this data field
short	getCalculationPivotFieldIndex() specifies a pivot field index used in calculations as specified by the Display Calculation function
short	getCalculationPivotItemIndex() specifies a pivot item index used in calculations as specified by the Display Calculation function
int	getDisplayCalculation() A signed integer that specifies the calculation used to display the value of this data item.
String	getName() returns the name of this data item; if not null, overrides the name in the corresponding cache field
short	getNumberFormat() returns the index to the number format pattern for this data field
short	getPivotFieldIndex() returns the pivot field index for this data item; the values in the source data associated with the associated cache field of the referenced pivot field are aggregated as specified in this record.
static XLSRecord	getPrototype()
void	init() perform record initialization
void	setAggregationFunction(int af) sets the aggregation function for this data field
void	setCalculationPivotFieldIndex(int ci) specifies a pivot field index used in calculations as specified by the Display Calculation function
void	setCalculationPivotItemIndex(int ci) specifies a pivot item index used in calculations as specified by the Display Calculation function
void	setDisplayCalculation(int dc) sets the Display Calculation for the Data item: A signed integer that specifies the calculation used to display the value of this data item.
void	setName(String name) sets the name of this data item; if not null, overrides the name in the corresponding cache field for this pivot item
void	setNumberFormat(int i) sets the index to the number format pattern for this data field
void	setPivotFieldIndex(int fi) sets the pivot field index for this data item; the values in the source data associated with the associated cache field of the referenced pivot field are aggregated as specified in this record.

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

SxDI

public SxDI()

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

getPivotFieldIndex

public short getPivotFieldIndex()

returns the pivot field index for this data item;
the values in the source data associated with the associated cache field of the referenced pivot field are aggregated as specified in this record.

Returns:

setPivotFieldIndex

public void setPivotFieldIndex(int fi)

sets the pivot field index for this data item;
the values in the source data associated with the associated cache field of the referenced pivot field are aggregated as specified in this record.

getAggregationFunction

public int getAggregationFunction()

returns the aggregation function for this data field

Returns:

See Also:

SxDI.AGGREGATIONFUNCTIONS

setAggregationFunction

public void setAggregationFunction(int af)

sets the aggregation function for this data field

See Also:

SxDI.AGGREGATIONFUNCTIONS

addDataField

public void addDataField(int fieldIndex,
                         String aggregationFunction,
                         String name)

adds the data field to the DATA axis and it's aggregation function ("sum" is default)

Parameters:

fieldIndex -

aggregationFunction -

name -

getDisplayCalculation

public int getDisplayCalculation()

A signed integer that specifies the calculation used to display the value of this data item.

Returns:

See Also:

SxDI.DISPLAYTYPES

setDisplayCalculation

public void setDisplayCalculation(int dc)

sets the Display Calculation for the Data item: A signed integer that specifies the calculation used to display the value of this data item.

See Also:

SxDI.DISPLAYTYPES

getCalculationPivotFieldIndex

public short getCalculationPivotFieldIndex()

specifies a pivot field index used in calculations as specified by the Display Calculation function

Returns:

setCalculationPivotFieldIndex

public void setCalculationPivotFieldIndex(int ci)

specifies a pivot field index used in calculations as specified by the Display Calculation function

getCalculationPivotItemIndex

public short getCalculationPivotItemIndex()

specifies a pivot item index used in calculations as specified by the Display Calculation function

Returns:

setCalculationPivotItemIndex

public void setCalculationPivotItemIndex(int ci)

specifies a pivot item index used in calculations as specified by the Display Calculation function

getNumberFormat

public short getNumberFormat()

returns the index to the number format pattern for this data field

Returns:

setNumberFormat

public void setNumberFormat(int i)

sets the index to the number format pattern for this data field

getName

public String getName()

returns the name of this data item; if not null, overrides the name in the corresponding cache field

Returns:

setName

public void setName(String name)

sets the name of this data item; if not null, overrides the name in the corresponding cache field for this pivot item

getPrototype

public static XLSRecord getPrototype()