io.starter.formats.XLS

Class Sxli

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.Sxli

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

public class Sxli
extends XLSRecord

SxLI: The SXLI record specifies pivot lines for the row area or column area of a PivotTable view. SXLI B5h: This record stores an array of variable-length SXLI structures which describe row and col items. Thre are 2 of these recs per Table -- one for rows, one for cols

     offset  name        size    contents
     ---    
     4       rgsxli      var     Array of SXLI structures
 
 
     SXLI Structures have variable length but will always be at least 10 bytes long.
     
     offset  name        size    contents
     ---    
     0       cSic        2       count of identical items to previous 
                                        A signed integer that specifies the count of pivot item indexes in the beginning of the rgisxvi array that are identical to the same number of pivot item indexes 
                                        in the beginning of the rgisxvi array of the previous SXLIItem structure in the rgsxli array of the preceding SXLI record. 
                                        The value MUST be greater than or equal to 0 and less than the isxviMac field. If the fGrand field equals 1, then this value MUST be 0. 
     2       itmtype     2       type:
                                 0x0 = data
                                 0x1 = default
                                 0x2 = SUM
                                 0x3 = COUNTA
                                 0x4 = COUNT
                                 0x5 = AVERAGE
                                 0x6 = MAX
                                 0x7 = MIN
                                 0x8 = PRODUCT
                                 0x9 = STDEV
                                 0xA = STDEVP
                                 0xB = VAR
                                 0xC = VARP
                                 0xD = GRAND TOTAL
     4       isxviMac    2         Number of elements in the rgisxvi array that are displayed in this pivot line. MUST be greater than or equal to 0.
                                   If the fGrand field equals 1, then the value of this field MUST be 1. If the fGrand field equals zero and the preceding SXLI record contains row area pivot items, then this value MUST be less than or equal to the cDimRw field of the preceding SxView. If the fGrand field equals zero and the preceding SXLI record contains column area pivot items, then this value MUST be less than or equal to the cDimCol field of the preceding SxView.
             fMultiDataName (1 bit):  A bit that specifies whether the data field name is used for the total or the subtotal.
             iData (8 bits): An unsigned integer that specifies a data item index as specified in Data Items, for an SXDI record specifying a data item used for a subtotal. 
             fSbt (1 bit): A bit that specifies whether this pivot line is a subtotal. 
             fBlock (1 bit): A bit that specifies whether this pivot line is a block total.
             fGrand (1 bit): A bit that specifies whether this pivot line is a grand total.
             fMultiDataOnAxis (1 bit): A bit that specifies whether a pivot line entry in this pivot line is a data item index.            
                3 bits- unused
        rgisxvi (variable): An array of 2-byte signed integers that specifies a pivot line entry.  --> if 0x7FFF means no pivot line/blank      
     
     6       grbit       2       option flags
 8       rgisxvi     2       Array of indices to SXVI records -- number is isxviMac+1
 
 

 

more info: rgsxli (variable): An array of SXLIItem. Zero or two records of this type appear in the file for each PivotTable view depending on the values of the cRw and cCol fields of the associated SxView record. If the value of either of the cRw or cCol fields of the associated SxView is greater than zero, then two records of this type MUST exist in the file for the associated SxView. The first record contains row area pivot lines and the second record contains column area pivot lines. The count of SXLIItem structures in rgsxli, which are row area pivot lines, MUST equal the cRw field of SxView. The count of SXLIItem structures in rgsxli, which are column area pivot lines, MUST equal the cCol field of SxView. The associated SxView record is the SxView record of the PivotTable view. The SXLIItem structure specifies a pivot line in the row area or column area of a PivotTable view. cSic (2 bytes): A signed integer that specifies the count of pivot item indexes in the beginning of the rgisxvi array that are identical to the same number of pivot item indexes in the beginning of the rgisxvi array of the previous SXLIItem structure in the rgsxli array of the preceding SXLI record. The value MUST be greater than or equal to 0 and less than the isxviMac field. If the fGrand field equals 1, then this value MUST be 0. itmType (15 bits): An unsigned integer that specifies the type of this pivot line. MUST be a value from the table: ITMTYPEDATA 0x0000 A value in the data ITMTYPEDEFAULT 0x0001 Automatic subtotal selection ITMTYPESUM 0x0002 Sum of values in the data ITMTYPECOUNTA 0x0003 Count of values in the data ITMTYPECOUNT 0x0004 Count of numbers in the data ITMTYPEAVERAGE 0x0005 Average of values in the data ITMTYPEMAX 0x0006 Maximum value in the data ITMTYPEMIN 0x0007 Minimum value in the data ITMTYPEPRODUCT 0x0008 Product of values in the data ITMTYPESTDEV 0x0009 Statistical standard deviation (estimate) ITMTYPESTDEVP 0x000A Statistical standard deviation (entire population) ITMTYPEVAR 0x000B Statistical variance (estimate) ITMTYPEVARP 0x000C Statistical variance (entire population) ITMTYPEGRAND 0x000D Grand total ITMTYPEBLANK 0x000E Blank line A - reserved1 (1 bit): MUST be zero and MUST be ignored. isxviMac (2 bytes): A signed integer that specifies the number of elements in the rgisxvi array that are displayed in this pivot line. MUST be greater than or equal to 0. If the fGrand field equals 1, then the value of this field MUST be 1. If the fGrand field equals zero and the preceding SXLI record contains row area pivot items, then this value MUST be less than or equal to the cDimRw field of the preceding SxView. If the fGrand field equals zero and the preceding SXLI record contains column area pivot items, then this value MUST be less than or equal to the cDimCol field of the preceding SxView. B - fMultiDataName (1 bit): A bit that specifies whether the data field name is used for the total or the subtotal. MUST be a value from the following table: Value Meaning 0 The data field name is used for the total. 1 The data field name is used for the subtotal. If the fGrand field equals 1 or the fBlock field equals 1, then this value MUST equal the value in the fMultiDataOnAxis field. If the fGrand and fBlock fields equal zero, the fSbt and fMultiDataOnAxis fields equal 1, and the cSic field is less than iposData, then this value MUST equal 1. Otherwise, this value MUST be zero. iposData is specified as follows: If the preceding SXLI record contains row area pivot items, iposData equals the index of the SxIvdRw record in the rgSxivd array of the SxIvd containing SxIvdRw records where the rw field equals -2. If there is not an SxIvdRw record with the rw field equal to -2, iposData equals zero. If the preceding SXLI record contains column area pivot items, iposData equals the index of the SxIvdCol record in the rgSxivd array of the SxIvd containing SxIvdCol records where the col field equals -2. If there is not an SxIvdCol record with the col field equal to -2, iposData equals zero. iData (8 bits): An unsigned integer that specifies a data item index as specified in Data Items, for an SXDI record specifying a data item used for a subtotal. This field MUST be 0 if the cDimData field of the preceding SxView record is 0 or if the fGrand field equals 1. If the cDimData field of the preceding SxView is greater than 0, then this value MUST be greater than or equal to 0 and less than the cDimData field of the preceding SxView record. If the fMultiDataOnAxis field equals 1 and the itmType field does not equal ITMTYPEBLANK and the isxviMac field is greater than iposData as specified in fMultiDataName, then the value of this field MUST equal the value of the element of the rgisxvi array in the position equal to iposData as specified in fMultiDataName. C - fSbt (1 bit): A bit that specifies whether this pivot line is a subtotal. This value MUST equal 1 if the itmType field is greater than or equal to ITMTYPEDEFAULT and the itmType field is less than or equal to ITMTYPEGRAND and the fBlock field equals 0. Otherwise, this value MUST be 0. D - fBlock (1 bit): A bit that specifies whether this pivot line is a block total. A block total is a total of a group of pivot items. For more details see Grouping. If the fGrand field equals 0 and the fBlock field in the previous SXLIItem record equals 1, this value MUST be 1. E - fGrand (1 bit): A bit that specifies whether this pivot line is a grand total. If the fGrand field in the previous SXLIItem record is 1, then this value MUST be 1. Otherwise, if the itmType field equals ITMTYPEGRAND this field MUST equal 1 and if the itmType field does not equal ITMTYPEGRAND this field MUST equal 0. F - fMultiDataOnAxis (1 bit): A bit that specifies whether a pivot line entry in this pivot line is a data item index. If the preceding SXLI record contains row area pivot items, the cDimData field of the preceding SxView record is greater than 1, the sxaxis4Data.sxaxisRw field of the preceding SxView equals 1 and itmType is not equal to ITMTYPEBLANK, then this value MUST be 1. Otherwise, this value MUST be 0. If the preceding SXLI record contains column area pivot items, the cDimData field of the preceding SxView record is greater than 1, the sxaxis4Data.sxaxisCol field of the preceding SxView equals 1 and itmType is not equal to ITMTYPEBLANK, then this value MUST be 1. Otherwise, this value MUST be 0. G - unused1 (1 bit): Undefined, and MUST be ignored. H - unused2 (1 bit): Undefined, and MUST be ignored. I - reserved2 (1 bit): MUST be zero and MUST be ignored. rgisxvi (variable): An array of 2-byte signed integers that specifies a pivot line entry. Each element of this array is either a pivot item index or a data item index. If fGrand is 1 or itmType is ITMTYPEBLANK then all elements of this field are undefined and MUST be ignored. Otherwise each element MUST be a value from the following table: Value Meaning 0x0000 to 0x7EF4 This value specifies a data item index or pivot item index in the associated pivot field as specified in Pivot Items. 0x7FFF This value specifies that there is no pivot item and that the cell in the pivot line is blank. "http://www.extentech.com">Extentech Inc.

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

Method Summary

Modifier and Type	Method and Description
void	addField(int repeat, int nLines, int type, short[] indexes) adds a field to the end of this field list
static XLSRecord	getPrototype(WorkBook wkbook) return a new, blank SxLi
void	init() perform record initialization
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, getPrototype, 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

Sxli

public Sxli()

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

addField

public void addField(int repeat,
                     int nLines,
                     int type,
                     short[] indexes)

adds a field to the end of this field list

getPrototype

public static XLSRecord getPrototype(WorkBook wkbook)

return a new, blank SxLi

Returns: