io.starter.formats.XLS

Class Rk

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.XLSCellRecord

io.starter.formats.XLS.Rk

All Implemented Interfaces:

BlockByteConsumer, BiffRec, CellAddressible, CellRec, ColumnRange, Mulled, XLSConstants, Serializable

public final class Rk
extends XLSCellRecord
implements Mulled

RK: RK Number (7Eh)
This record stores an internal numeric type. Stores data in one of four RK 'types' which determine whether it is an integer or an IEEE floating point equivalent.

    offset  name        size    contents
    ---    
    4       rw          2       Row Number
    6       col         2       Column Number of the RK record
    8       ixfe        2       Index to XF cell format record
    10      rk          4       RK number
    

See Also:

MULRK, NUMBER, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.starter.formats.XLS.CellAddressible

CellAddressible.ColumnMajorComparator, CellAddressible.RangeBoundary, CellAddressible.Reference, CellAddressible.RowMajorComparator

Nested classes/interfaces inherited from interface io.starter.formats.XLS.ColumnRange

ColumnRange.Comparator

Field Summary

Fields

Modifier and Type	Field and Description
boolean	DEBUG
static int	RK_FP
static int	RK_FP_100
static int	RK_INT
static int	RK_INT_100

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
Rk() default constructor

Method Summary

Modifier and Type	Method and Description
void	close() clear out object references in prep for closing workbook
static void	convertRkToNumber(Rk reek, double d) Converts an RK valrec to a number record.
double	getDblVal() Get the value of the record as a Double.
float	getFloatVal() Get the value of the record as a Float.
int	getIntVal() Get the value of the record as an Integer.
Mul	getMyMul()
int	getRecordIndex() returns the position of this record in the array of records making up this file.
static byte[]	getRkBytes(double d) Structure of RkNumber: A - fX100 (1 bit): A bit that specifies whether num is the value of the RkNumber or 100 times the value of the RkNumber.
String	getStringVal() Return the string value.
int	getType()
String	getTypeName()
void	init() This init method pulls out the record header information, then sends the as-yet unmodded rkdata record across to the rktranslate method
static double	parseRkNumber(byte[] rkbytes) static method which parses a 4-byte RK number into a double value using specific MS Rules
void	setDoubleVal(double f)
void	setFloatVal(float f)
void	setIntVal(int f)
void	setMyMul(Mul m)
void	setNoMul()
protected void	setRKVal(double d) Allows writing back to the RKRec.
void	setStringVal(String s)
void	setXFRecord(int i) set the XF (format) record for this rec
static void	testVALUES() internal debugging method

Methods inherited from class io.starter.formats.XLS.XLSCellRecord

getColFirst, getColLast, isSingleCol

Methods inherited from class io.starter.formats.XLS.XLSRecord

addContinue, clone, copyFormat, getBooleanVal, getByteAt, getByteReader, getBytes, getBytesAt, getCellAddress, getCellAddressWithSheet, getCellType, getColNumber, getColorTable, getContinueVect, getData, getDataType, getDefaultVal, getEncryptedByteReader, getFirstBlock, getFont, getFormatPattern, getFormulaRec, getHyperlink, getInternalVal, getIntLocation, getIxfe, getLastBlock, getLength, getMergeRange, getOffset, getOpcode, getPrototype, getRealRecordIndex, getRecDesc, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getWorkBook, getXfRec, hasContinues, initRowCol, isFormula, isNumber, isReadOnly, isValueForCell, mergeContinues, postStream, preStream, remove, removeContinues, resetCacheBytes, setBooleanVal, setByteReader, setCol, setData, setDebugLevel, setEncryptedByteReader, setFirstBlock, setHyperlink, setIndex, setIsValueForCell, setIxfe, setLastBlock, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setRowNumber, setSheet, setStreamer, setValueForCell, setWorkBook, setXFRecord, shouldEncrypt, toHexDump, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.starter.formats.XLS.BiffRec

addContinue, copyFormat, getBooleanVal, getByteAt, getByteReader, getBytes, getBytesAt, getCellAddress, getColNumber, getContinueVect, getData, getDataType, getDefaultVal, getEncryptedByteReader, getFont, getFormatPattern, getFormulaRec, getHyperlink, getInternalVal, getIxfe, getLength, getMergeRange, getOffset, getOpcode, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getWorkBook, getXfRec, hasContinues, isReadOnly, isValueForCell, postStream, preStream, remove, removeContinues, setBooleanVal, setByteReader, setCol, setData, setDebugLevel, setEncryptedByteReader, setHyperlink, setIndex, setIsValueForCell, setIxfe, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setRowNumber, setSheet, setStreamer, setWorkBook, setXFRecord, toHexDump

Methods inherited from interface io.starter.formats.XLS.CellAddressible

getRowNumber

Field Detail

RK_FP

public static final int RK_FP

See Also:

Constant Field Values

RK_FP_100

public static final int RK_FP_100

See Also:

Constant Field Values

RK_INT

public static final int RK_INT

See Also:

Constant Field Values

RK_INT_100

public static final int RK_INT_100

See Also:

Constant Field Values

DEBUG

public boolean DEBUG

Constructor Detail

Rk

public Rk()

default constructor

Method Detail

setMyMul

public void setMyMul(Mul m)

Specified by:

setMyMul in interface Mulled

getMyMul

public Mul getMyMul()

Specified by:

getMyMul in interface Mulled

setNoMul

public void setNoMul()

Specified by:

setNoMul in interface Mulled

init

public void init()

This init method pulls out the record header information, then sends the as-yet unmodded rkdata record across to the rktranslate method

Specified by:

init in interface BiffRec

Overrides:

init in class XLSRecord

getRecordIndex

public int getRecordIndex()

returns the position of this record in the array of records making up this file.

Specified by:

getRecordIndex in interface BiffRec

Overrides:

getRecordIndex in class XLSRecord

parseRkNumber

public static double parseRkNumber(byte[] rkbytes)

static method which parses a 4-byte RK number into a double value using specific MS Rules

Parameters:

byte[] - rkbytes - 4 byte Rk Number

Returns:

double - translated from Rk bytes

See Also:

Rk

getIntVal

public int getIntVal()
              throws RuntimeException

Description copied from class: XLSRecord

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

Overrides:

getIntVal in class XLSRecord

Throws:

RuntimeException

getDblVal

public double getDblVal()

Description copied from class: XLSRecord

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

Overrides:

getDblVal in class XLSRecord

getFloatVal

public float getFloatVal()

Description copied from class: XLSRecord

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

Overrides:

getFloatVal in class XLSRecord

getStringVal

public String getStringVal()

Return the string value. If it is over 99999999999 or under -99999999999 then return a format using scientific notation. Note this is *not* significant digits, rather the actual size of the number. Emulates Excel functionality and display

Specified by:

getStringVal in interface BiffRec

Overrides:

getStringVal in class XLSRecord

setStringVal

public void setStringVal(String s)

Specified by:

setStringVal in interface BiffRec

Overrides:

setStringVal in class XLSRecord

setFloatVal

public void setFloatVal(float f)

Overrides:

setFloatVal in class XLSRecord

See Also:

XLSRecord.setFloatVal(float)

setIntVal

public void setIntVal(int f)

Specified by:

setIntVal in interface BiffRec

Overrides:

setIntVal in class XLSRecord

See Also:

XLSRecord.setIntVal(int)

setDoubleVal

public void setDoubleVal(double f)

Specified by:

setDoubleVal in interface BiffRec

Overrides:

setDoubleVal in class XLSRecord

See Also:

XLSRecord.setDoubleVal(double)

getTypeName

public String getTypeName()

getRkBytes

public static byte[] getRkBytes(double d)

Structure of RkNumber: A - fX100 (1 bit): A bit that specifies whether num is the value of the RkNumber or 100 times the value of the RkNumber. MUST be a value from the following table: 0 = The value of RkNumber is the value of num. 1 = The value of RkNumber is the value of num divided by 100. B - fInt (1 bit): A bit that specifies the type of num. 0 = num is the 30 most significant bits of a 64-bit binary floating-point number as defined in [IEEE754]. The remaining 34-bits of the floating-point number MUST be 0. 1 = num is a signed integer num (30 bits): A variable type field whose type and meaning is specified by the value of fInt, as defined in the following table:

setRKVal

protected void setRKVal(double d)

Allows writing back to the RKRec. In order to be written correctly the RK must conform to one of the cases below, if it does not it will need to be handled as a NUMBER. Note the last 2 bits of each record need to be set as an identifier for what type of RK record we are writing. Types 0 and 1 are stored as a 32 bit modified float, with the mantissa of a double and the final 2 bits changed to the RK type. Types 2 and 3 are stored as a 30 bit integer with the final 2 bits as RK type. Also note types 1 and 2 are stored in the excel file as x*100.

convertRkToNumber

public static void convertRkToNumber(Rk reek,
                                     double d)

Converts an RK valrec to a number record. This allows the number format to be changed within the cell

getType

public int getType()

setXFRecord

public void setXFRecord(int i)

set the XF (format) record for this rec

Specified by:

setXFRecord in interface BiffRec

Overrides:

setXFRecord in class XLSRecord

close

public void close()

Description copied from class: XLSRecord

clear out object references in prep for closing workbook

Overrides:

close in class XLSRecord

testVALUES

public static void testVALUES()

internal debugging method