XLSRecord (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.XLSRecord

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable

Direct Known Subclasses:

Array, AutoFilter, BookBool, BottomMargin, Boundsheet, CalcMode, Cf, Cf12, Codename, Colinfo, Condfmt, Condfmt12, Continue, Country, Crn, Dbcell, DConBin, DConName, DConRef, DefaultRowHeight, DefColWidth, Dimensions, Dsf, Dv, Dval, Eof, Externname, Externsheet, Extsst, FeatHeadr, Font, FontBasis, Footerrec, Format, GenericChartObject, Guts, HCenter, Headerrec, Hlink, Index, LeftMargin, Mergedcells, MSODrawing, MSODrawingGroup, MSODrawingSelection, Mulrk, Name, NineteenOhFour, Note, Obj, ObjProtect, Obproj, Palette, Pane, Password, Phonetic, Pls, PLV, PrintGrid, PrintRowCol, Prot4rev, Protect, QsiSXTag, RightMargin, Row, Rstring, ScenProtect, Scl, Selection, Setup, Shrfmla, Sst, StringRec, Style, Supbook, SxAddl, SXBool, SxDB, SxDBB, SXDBEx, SxDI, SxEX, SxFDB, SXFDBType, Sxformat, Sxivd, Sxli, SXNum, SxPI, SxStreamID, SXString, Sxvd, SxVdEX, Sxvi, Sxview, SxVIEWEX9, SxVS, TabID, TableStyles, TopMargin, Txo, UnencryptedXLSRecord, Usersviewbegin, Usersviewend, VCenter, Window1, Window2, Writeaccess, WsBool, Xct, Xf, XLSCellRecord
```
public class XLSRecord
extends Object
implements BiffRec, BlockByteConsumer, Serializable, XLSConstants
```
```
    The XLS byte stream is composed of records delimited by a header with type
    and data length information, followed by a record Body which contains

    the byte[] data for the record.
    
    XLSRecord subclasses provide specific functionality.

    
```
See Also:

WorkBook, Boundsheet, Index, Dbcell, Row, Cell, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected short`	`col`
`protected AbstractList`	`continues`
`protected int`	`DEBUGLEVEL`
`Hlink`	`hyperlink`
`protected Index`	`idx`
`boolean`	`isBlank`
`boolean`	`isBoolean`
`protected boolean`	`isContinueMerged`
`boolean`	`isString`
`int`	`lastidx`
`Xf`	`myxf`
`int`	`offset`
`protected int`	`rw`
`protected ByteStreamer`	`streamer`
`protected WorkBook`	`wkbook`
`protected Sheet`	`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

XLSRecord()

Constructors
Constructor and Description
`XLSRecord()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addContinue(Continue c)` adds a CONTINUE record to the array of CONTINUE records for this record, containing all data beyond the 8224 byte record size limit.
`Object`	`clone()` clone a record
`void`	`close()` clear out object references in prep for closing workbook
`void`	`copyFormat(BiffRec source)` Copy all formatting info from source biffrec
`boolean`	`getBooleanVal()` Get the value of the record as a Boolean.
`byte`	`getByteAt(int off)` Gets the byte from the specified position in the record byte array.
`BlockByteReader`	`getByteReader()` Get the BlockByteReader for this Consumer
`byte[]`	`getBytes()` Gets the byte from the specified position in the record byte array.
`byte[]`	`getBytesAt(int off, int len)` Gets the byte from the specified position in the record byte array.
`String`	`getCellAddress()` get a string address for the cell based on row and col ie: "H22"
`String`	`getCellAddressWithSheet()` return the cell address with sheet reference eg Sheet!A12
`int`	`getCellType()` get the int val of the type for the valrec
`short`	`getColNumber()`
`Color[]`	`getColorTable()` Get the color table for the associated workbook.
`List`	`getContinueVect()` returns the array of CONTINUE records for this record, containing all data beyond the 8224 byte record size limit.
`byte[]`	`getData()` gets the record data merging any Continue record data.
`String`	`getDataType()` get the data type name for this record
`double`	`getDblVal()` Get the value of the record as a Double.
`Object`	`getDefaultVal()` get a default "empty" data value for this record
`BlockByteReader`	`getEncryptedByteReader()`
`int`	`getFirstBlock()` Returns the index of the first block
`float`	`getFloatVal()` Get the value of the record as a Float.
`Font`	`getFont()` returns the existing font record for this Cell
`String`	`getFormatPattern()` set the Formatting for this BiffRec from the pattern match.
`Formula`	`getFormulaRec()`
`Hlink`	`getHyperlink()`
`Object`	`getInternalVal()` get the int val of the type for the valrec
`int[]`	`getIntLocation()` returns the cell address in int[] {row, col} format
`int`	`getIntVal()` Get the value of the record as an Integer.
`int`	`getIxfe()` get the ixfe
`int`	`getLastBlock()` Returns the index of the last block
`int`	`getLength()` Returns the length of this record, including the 4 header bytes
`CellRange`	`getMergeRange()`
`int`	`getOffset()` Get the relative position within the data underlying the block vector represented by the BlockByteReader.
`short`	`getOpcode()`
`protected static XLSRecord`	`getPrototype()` get a new, generic instance of a Record.
`int`	`getRealRecordIndex()` return the real (not just boundsheet) record index of this object
`String`	`getRecDesc()`
`int`	`getRecordIndex()` return the record index of this object
`Row`	`getRow()` get the row of this cell
`int`	`getRowNumber()`
`Boundsheet`	`getSheet()` get the WorkSheet for this record.
`ByteStreamer`	`getStreamer()`
`String`	`getStringVal()` Get the value of the record as a String.
`String`	`getStringVal(String encoding)` Get the value of the record as a String.
`WorkBook`	`getWorkBook()`
`Xf`	`getXfRec()`
`boolean`	`hasContinues()` returns whether this record has a CONTINUE record containing data beyond the 8228 byte record size limit.
`void`	`init()` perform record initialization
`protected void`	`initRowCol()`
`boolean`	`isFormula()` return whether this is a formula record
`boolean`	`isNumber()` return whether this is a numeric type
`boolean`	`isReadOnly()`
`boolean`	`isValueForCell()`
`protected void`	`mergeContinues()` Merge continue data in to the record data array
`void`	`postStream()` do any post-streaming cleanup such as expensive index updates or other deferrable processing.
`void`	`preStream()` do any pre-streaming processing such as expensive index updates or other deferrable processing.
`boolean`	`remove(boolean nullme)` Removes this BiffRec from the WorkSheet
`void`	`removeContinues()` remove all Continue records
`void`	`resetCacheBytes()` resets the cache bytes so they do not take up space
`void`	`setBooleanVal(boolean b)`
`void`	`setByteReader(BlockByteReader db)` Set the BlockByteReader for this Consumer
`void`	`setCol(short i)` set the column
`void`	`setData(byte[] b)`
`void`	`setDebugLevel(int b)` set the DEBUG level
`void`	`setDoubleVal(double v)`
`void`	`setEncryptedByteReader(BlockByteReader db)` Hold onto the original encrypted bytes so we can do a look ahead on records
`void`	`setFirstBlock(int i)` Sets the index of the first block
`void`	`setFloatVal(float v)`
`void`	`setHyperlink(Hlink hl)`
`void`	`setIndex(Index id)` associate this record with its Index record
`void`	`setIntVal(int v)`
`void`	`setIsValueForCell(boolean b)` set whether this record contains the value of the Cell.
`void`	`setIxfe(int i)` set the XF (format) record for this rec
`void`	`setLastBlock(int i)` Sets the index of the last block
`void`	`setLength(int len)`
`void`	`setMergeRange(CellRange range)`
`void`	`setOffset(int pos)` Set the relative position within the data underlying the block vector represented by the BlockByteReader.
`void`	`setOpcode(short op)`
`void`	`setRow(Row r)`
`void`	`setRowCol(int[] x)`
`void`	`setRowNumber(int i)` set the row
`void`	`setSheet(Sheet b)` Associate this record with a worksheet.
`void`	`setStreamer(ByteStreamer str)`
`void`	`setStringVal(String v)`
`void`	`setValueForCell(boolean isVal)`
`void`	`setWorkBook(WorkBook wk)`
`void`	`setXFRecord()` set the XF (format) record for this rec
`void`	`setXFRecord(int i)` set the XF (format) record for this rec
`boolean`	`shouldEncrypt()`
`String`	`toHexDump()` Dumps this record as a human-readable string.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - isContinueMerged
```
protected boolean isContinueMerged
```
  - DEBUGLEVEL
```
protected transient int DEBUGLEVEL
```
  - isString
```
public boolean isString
```
  - isBoolean
```
public boolean isBoolean
```
  - isBlank
```
public boolean isBlank
```
  - rw
```
protected int rw
```
  - col
```
protected short col
```
  - offset
```
public int offset
```
  - idx
```
protected transient Index idx
```
  - worksheet
```
protected Sheet worksheet
```
  - myxf
```
public transient Xf myxf
```
  - wkbook
```
protected transient WorkBook wkbook
```
  - streamer
```
protected transient ByteStreamer streamer
```
  - continues
```
protected AbstractList continues
```
  - hyperlink
```
public Hlink hyperlink
```
  - lastidx
```
public int lastidx
```
- Constructor Detail
  - XLSRecord
```
public XLSRecord()
```
- Method Detail
  - getOpcode
```
public short getOpcode()
```
    Specified by:
    
    getOpcode in interface BiffRec
  - setOpcode
```
public void setOpcode(short op)
```
    Specified by:
    
    setOpcode in interface BiffRec
  - setHyperlink
```
public void setHyperlink(Hlink hl)
```
    Specified by:
    
    setHyperlink in interface BiffRec
  - getFormulaRec
```
public Formula getFormulaRec()
```
    Specified by:
    
    getFormulaRec in interface BiffRec
  - shouldEncrypt
```
public boolean shouldEncrypt()
```
  - setRow
```
public void setRow(Row r)
```
    Specified by:
    
    setRow in interface BiffRec
  - getRow
```
public Row getRow()
```
    get the row of this cell
    
    Specified by:
    
    getRow in interface BiffRec
  - getXfRec
```
public Xf getXfRec()
```
    Specified by:
    
    getXfRec in interface BiffRec
  - getFont
```
public Font getFont()
```
    returns the existing font record for this Cell
    
    Specified by:
    
    getFont in interface BiffRec
  - getMergeRange
```
public CellRange getMergeRange()
```
    Specified by:
    
    getMergeRange in interface BiffRec
    
    Returns:
  - setMergeRange
```
public void setMergeRange(CellRange range)
```
    Specified by:
    
    setMergeRange in interface BiffRec
    
    Parameters:
    
    range -
  - remove
```
public boolean remove(boolean nullme)
```
    Removes this BiffRec from the WorkSheet
    
    Specified by:
    
    remove in interface BiffRec
    
    Parameters:
    
    whether - to nullify this Cell
  - getFormatPattern
```
public String getFormatPattern()
```
    set the Formatting for this BiffRec from the pattern match. case insensitive pattern match is performed...
    
    Specified by:
    
    getFormatPattern in interface BiffRec
  - getCellType
```
public int getCellType()
```
    get the int val of the type for the valrec
  - setOffset
```
public void setOffset(int pos)
```
    Set the relative position within the data underlying the block vector represented by the BlockByteReader. In other words, this is the relative position used by the BlockByteReader to offset the Consumer's read position within the collection of Data Blocks. This may be an offset relative to the data in a file, or within a Storage contained in a file. The Workbook Storage for example will contain a non-contiguous collection of Blocks containing data from any number of positions in a file. This collection forms a contiguous span of bytes comprising an XLS Workbook. The XLSRecords within this span of bytes will set their relative position within this 'virtual' array. Thus the XLSRecord positions are relative to the order of bytes contained in the Block collection. The BOF record then is at offset 0 within the data of the first Block, even though the underlying data of this first Block may be anywhere on disk.
    
    Specified by:
    
    setOffset in interface BlockByteConsumer
    
    Specified by:
    
    setOffset in interface BiffRec
    
    Parameters:
    
    pos -
  - getOffset
```
public int getOffset()
```
    Get the relative position within the data underlying the block vector represented by the BlockByteReader.
    
    Specified by:
    
    getOffset in interface BlockByteConsumer
    
    Specified by:
    
    getOffset in interface BiffRec
    
    Returns:
    
    relative position
  - setFirstBlock
```
public void setFirstBlock(int i)
```
    Sets the index of the first block
    
    Specified by:
    
    setFirstBlock in interface BlockByteConsumer
  - setLastBlock
```
public void setLastBlock(int i)
```
    Sets the index of the last block
    
    Specified by:
    
    setLastBlock in interface BlockByteConsumer
  - getFirstBlock
```
public int getFirstBlock()
```
    Returns the index of the first block
    
    Specified by:
    
    getFirstBlock in interface BlockByteConsumer
    
    Returns:
  - getLastBlock
```
public int getLastBlock()
```
    Returns the index of the last block
    
    Specified by:
    
    getLastBlock in interface BlockByteConsumer
    
    Returns:
  - initRowCol
```
protected void initRowCol()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getRecDesc
```
public String getRecDesc()
```
  - toHexDump
```
public String toHexDump()
```
    Dumps this record as a human-readable string.
    
    Specified by:
    
    toHexDump in interface BiffRec
  - copyFormat
```
public void copyFormat(BiffRec source)
```
    Copy all formatting info from source biffrec
    
    Specified by:
    
    copyFormat in interface BiffRec
    
    See Also:
    
    BiffRec.copyFormat(io.starter.formats.XLS.BiffRec)
  - clone
```
public Object clone()
```
    clone a record
    
    Overrides:
    
    clone in class Object
  - isNumber
```
public boolean isNumber()
```
    return whether this is a numeric type
  - isFormula
```
public boolean isFormula()
```
    return whether this is a formula record
  - setDebugLevel
```
public void setDebugLevel(int b)
```
    set the DEBUG level
    
    Specified by:
    
    setDebugLevel in interface BiffRec
  - getRealRecordIndex
```
public int getRealRecordIndex()
```
    return the real (not just boundsheet) record index of this object
  - getRecordIndex
```
public int getRecordIndex()
```
    return the record index of this object
    
    Specified by:
    
    getRecordIndex in interface BiffRec
  - addContinue
```
public void addContinue(Continue c)
```
    adds a CONTINUE record to the array of CONTINUE records for this record, containing all data beyond the 8224 byte record size limit.
    
    Specified by:
    
    addContinue in interface BiffRec
  - removeContinues
```
public void removeContinues()
```
    remove all Continue records
    
    Specified by:
    
    removeContinues in interface BiffRec
  - getContinueVect
```
public List getContinueVect()
```
    Description copied from interface: BiffRec
    
    returns the array of CONTINUE records for this record, containing all data beyond the 8224 byte record size limit.
    
    Specified by:
    
    getContinueVect in interface BiffRec
  - hasContinues
```
public boolean hasContinues()
```
    returns whether this record has a CONTINUE record containing data beyond the 8228 byte record size limit. XLSRecords can have 0 or more CONTINUE records.
    
    Specified by:
    
    hasContinues in interface BiffRec
  - setIsValueForCell
```
public void setIsValueForCell(boolean b)
```
    set whether this record contains the value of the Cell.
    
    Specified by:
    
    setIsValueForCell in interface BiffRec
  - setIndex
```
public void setIndex(Index id)
```
    associate this record with its Index record
    
    Specified by:
    
    setIndex in interface BiffRec
  - setSheet
```
public void setSheet(Sheet b)
```
    Associate this record with a worksheet. First checks to see if there is already a cell with this address.
    
    Specified by:
    
    setSheet in interface BiffRec
  - getSheet
```
public Boundsheet getSheet()
```
    get the WorkSheet for this record.
    
    Specified by:
    
    getSheet in interface BiffRec
  - setWorkBook
```
public void setWorkBook(WorkBook wk)
```
    Specified by:
    
    setWorkBook in interface BiffRec
  - getWorkBook
```
public WorkBook getWorkBook()
```
    Specified by:
    
    getWorkBook in interface BiffRec
  - setCol
```
public void setCol(short i)
```
    set the column
    
    Specified by:
    
    setCol in interface BiffRec
  - setRowCol
```
public void setRowCol(int[] x)
```
    Specified by:
    
    setRowCol in interface BiffRec
  - setRowNumber
```
public void setRowNumber(int i)
```
    set the row
    
    Specified by:
    
    setRowNumber in interface BiffRec
  - getColNumber
```
public short getColNumber()
```
    Specified by:
    
    getColNumber in interface BiffRec
  - getRowNumber
```
public int getRowNumber()
```
    Specified by:
    
    getRowNumber in interface BiffRec
  - getCellAddress
```
public String getCellAddress()
```
    get a string address for the cell based on row and col ie: "H22"
    
    Specified by:
    
    getCellAddress in interface BiffRec
  - getIntLocation
```
public int[] getIntLocation()
```
    returns the cell address in int[] {row, col} format
  - getCellAddressWithSheet
```
public String getCellAddressWithSheet()
```
    return the cell address with sheet reference eg Sheet!A12
    
    Returns:
    
    String
  - init
```
public void init()
```
    perform record initialization
    
    Specified by:
    
    init in interface BiffRec
  - getDefaultVal
```
public Object getDefaultVal()
```
    get a default "empty" data value for this record
    
    Specified by:
    
    getDefaultVal in interface BiffRec
  - getDataType
```
public String getDataType()
```
    get the data type name for this record
    
    Specified by:
    
    getDataType in interface BiffRec
  - getInternalVal
```
public Object getInternalVal()
```
    get the int val of the type for the valrec
    
    Specified by:
    
    getInternalVal in interface BiffRec
  - getBooleanVal
```
public boolean getBooleanVal()
```
    Get the value of the record as a Boolean. Value must be parseable as a Boolean.
    
    Specified by:
    
    getBooleanVal in interface BiffRec
  - getIntVal
```
public int getIntVal()
```
    Get the value of the record as an Integer. Value must be parseable as an Integer or it will throw a NumberFormatException.
    
    Specified by:
    
    getIntVal in interface BiffRec
  - getDblVal
```
public double getDblVal()
```
    Get the value of the record as a Double. Value must be parseable as an Double or it will throw a NumberFormatException.
    
    Specified by:
    
    getDblVal in interface BiffRec
  - getFloatVal
```
public float getFloatVal()
```
    Get the value of the record as a Float. Value must be parseable as an Float or it will throw a NumberFormatException.
    
    Specified by:
    
    getFloatVal in interface BiffRec
  - getStringVal
```
public String getStringVal()
```
    Get the value of the record as a String.
    
    Specified by:
    
    getStringVal in interface BiffRec
  - getStringVal
```
public String getStringVal(String encoding)
```
    Get the value of the record as a String.
    
    Specified by:
    
    getStringVal in interface BiffRec
  - setStringVal
```
public void setStringVal(String v)
```
    Specified by:
    
    setStringVal in interface BiffRec
  - setBooleanVal
```
public void setBooleanVal(boolean b)
```
    Specified by:
    
    setBooleanVal in interface BiffRec
  - setIntVal
```
public void setIntVal(int v)
```
    Specified by:
    
    setIntVal in interface BiffRec
  - setFloatVal
```
public void setFloatVal(float v)
```
  - setDoubleVal
```
public void setDoubleVal(double v)
```
    Specified by:
    
    setDoubleVal in interface BiffRec
  - preStream
```
public void preStream()
```
    do any pre-streaming processing such as expensive index updates or other deferrable processing.
    
    Specified by:
    
    preStream in interface BiffRec
  - setXFRecord
```
public void setXFRecord()
```
    set the XF (format) record for this rec
    
    Specified by:
    
    setXFRecord in interface BiffRec
  - setXFRecord
```
public void setXFRecord(int i)
```
    set the XF (format) record for this rec
    
    Specified by:
    
    setXFRecord in interface BiffRec
  - setIxfe
```
public void setIxfe(int i)
```
    set the XF (format) record for this rec
    
    Specified by:
    
    setIxfe in interface BiffRec
  - getIxfe
```
public int getIxfe()
```
    get the ixfe
    
    Specified by:
    
    getIxfe in interface BiffRec
  - getPrototype
```
protected static XLSRecord getPrototype()
```
    get a new, generic instance of a Record.
  - setByteReader
```
public void setByteReader(BlockByteReader db)
```
    Description copied from interface: BlockByteConsumer
    
    Set the BlockByteReader for this Consumer
    
    Specified by:
    
    setByteReader in interface BlockByteConsumer
    
    Specified by:
    
    setByteReader in interface BiffRec
  - getByteReader
```
public BlockByteReader getByteReader()
```
    Description copied from interface: BlockByteConsumer
    
    Get the BlockByteReader for this Consumer
    
    Specified by:
    
    getByteReader in interface BlockByteConsumer
    
    Specified by:
    
    getByteReader in interface BiffRec
  - setEncryptedByteReader
```
public void setEncryptedByteReader(BlockByteReader db)
```
    Hold onto the original encrypted bytes so we can do a look ahead on records
    
    Specified by:
    
    setEncryptedByteReader in interface BiffRec
  - getEncryptedByteReader
```
public BlockByteReader getEncryptedByteReader()
```
    Specified by:
    
    getEncryptedByteReader in interface BiffRec
  - setData
```
public void setData(byte[] b)
```
    Specified by:
    
    setData in interface BiffRec
  - getData
```
public byte[] getData()
```
    gets the record data merging any Continue record data.
    
    Specified by:
    
    getData in interface BiffRec
  - mergeContinues
```
protected void mergeContinues()
```
    Merge continue data in to the record data array
  - getBytes
```
public byte[] getBytes()
```
    Gets the byte from the specified position in the record byte array.
    
    Specified by:
    
    getBytes in interface BiffRec
    
    Parameters:
    
    off -
    
    Returns:
  - getBytesAt
```
public byte[] getBytesAt(int off,
                         int len)
```
    Gets the byte from the specified position in the record byte array.
    
    Specified by:
    
    getBytesAt in interface BiffRec
    
    Parameters:
    
    off -
    
    Returns:
  - resetCacheBytes
```
public void resetCacheBytes()
```
    resets the cache bytes so they do not take up space
  - getByteAt
```
public byte getByteAt(int off)
```
    Gets the byte from the specified position in the record byte array.
    
    Specified by:
    
    getByteAt in interface BiffRec
    
    Parameters:
    
    off -
    
    Returns:
  - setLength
```
public void setLength(int len)
```
    Specified by:
    
    setLength in interface BiffRec
  - getLength
```
public int getLength()
```
    Returns the length of this record, including the 4 header bytes
    
    Specified by:
    
    getLength in interface BlockByteConsumer
    
    Specified by:
    
    getLength in interface BiffRec
    
    Returns:
  - isValueForCell
```
public boolean isValueForCell()
```
    Specified by:
    
    isValueForCell in interface BiffRec
    
    Returns:
    
    Returns the isValueForCell.
  - setValueForCell
```
public void setValueForCell(boolean isVal)
```
    Parameters:
    
    isVal - true if this is a cell-type record
  - isReadOnly
```
public boolean isReadOnly()
```
    Specified by:
    
    isReadOnly in interface BiffRec
    
    Returns:
    
    Returns the isReadOnly.
  - getStreamer
```
public ByteStreamer getStreamer()
```
    Specified by:
    
    getStreamer in interface BiffRec
    
    Returns:
    
    Returns the streamer.
  - setStreamer
```
public void setStreamer(ByteStreamer str)
```
    Specified by:
    
    setStreamer in interface BiffRec
    
    Parameters:
    
    streamer - The streamer to set.
  - getHyperlink
```
public Hlink getHyperlink()
```
    Specified by:
    
    getHyperlink in interface BiffRec
    
    Returns:
    
    Returns the hyperlink.
  - postStream
```
public void postStream()
```
    Description copied from interface: BiffRec
    
    do any post-streaming cleanup such as expensive index updates or other deferrable processing.
    
    Specified by:
    
    postStream in interface BiffRec
  - close
```
public void close()
```
    clear out object references in prep for closing workbook
  - getColorTable
```
public Color[] getColorTable()
```
    Get the color table for the associated workbook. If the workbook is null then the default colortable will be returned.

Class XLSRecord

Field Summary

Fields inherited from interface io.starter.formats.XLS.XLSConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

isContinueMerged

DEBUGLEVEL

isString

isBoolean

isBlank

rw

col

offset

idx

worksheet

myxf

wkbook

streamer

continues

hyperlink

lastidx

Constructor Detail

XLSRecord

Method Detail

getOpcode

setOpcode

setHyperlink

getFormulaRec

shouldEncrypt

setRow

getRow

getXfRec

getFont

getMergeRange

setMergeRange

remove

getFormatPattern

getCellType

setOffset

getOffset

setFirstBlock

setLastBlock

getFirstBlock

getLastBlock

initRowCol

toString

getRecDesc

toHexDump

copyFormat

clone

isNumber

isFormula

setDebugLevel

getRealRecordIndex

getRecordIndex

addContinue

removeContinues

getContinueVect

hasContinues

setIsValueForCell

setIndex

setSheet

getSheet

setWorkBook

getWorkBook

setCol

setRowCol

setRowNumber

getColNumber

getRowNumber

getCellAddress

getIntLocation

getCellAddressWithSheet

init

getDefaultVal

getDataType

getInternalVal

getBooleanVal