org.apache.poi.hssf.record
Class RKRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.RKRecord
All Implemented Interfaces:
CellValueRecordInterface

public final class RKRecord
extends Record
implements CellValueRecordInterface

Title: RK Record (0x027E) Description: An internal 32 bit number with the two most significant bits storing the type. This is part of a bizarre scheme to save disk space and memory (gee look at all the other whole records that are in the file just "cause"..,far better to waste processor cycles on this then leave on of those "valuable" records out).

We support this in READ-ONLY mode. HSSF converts these to NUMBER records

REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:
2.0-pre
Author:
Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)
See Also:
NumberRecord

Field Summary
static short RK_IEEE_NUMBER
           
static short RK_IEEE_NUMBER_TIMES_100
           
static short RK_INTEGER
           
static short RK_INTEGER_TIMES_100
           
static short sid
           
 
Constructor Summary
RKRecord()
           
RKRecord(RecordInputStream in)
           
 
Method Summary
 java.lang.Object clone()
           
 short getColumn()
           
 int getRKField()
           
 double getRKNumber()
          Extract the value of the number
 short getRKType()
          Get the type of the number
 int getRow()
           
 short getSid()
          return the non static version of the id for this record.
 short getXFIndex()
           
static void main(java.lang.String[] ignored_args)
          Debugging main()
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setColumn(short col)
           
 void setRow(int row)
           
 void setXFIndex(short xf)
          NO OP!
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
 
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, getRecordSize, serialize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values

RK_IEEE_NUMBER

public static final short RK_IEEE_NUMBER
See Also:
Constant Field Values

RK_IEEE_NUMBER_TIMES_100

public static final short RK_IEEE_NUMBER_TIMES_100
See Also:
Constant Field Values

RK_INTEGER

public static final short RK_INTEGER
See Also:
Constant Field Values

RK_INTEGER_TIMES_100

public static final short RK_INTEGER_TIMES_100
See Also:
Constant Field Values
Constructor Detail

RKRecord

public RKRecord()

RKRecord

public RKRecord(RecordInputStream in)
Method Detail

getRow

public int getRow()
Specified by:
getRow in interface CellValueRecordInterface
Returns:
the row this cell occurs on

getColumn

public short getColumn()
Specified by:
getColumn in interface CellValueRecordInterface
Returns:
the column this cell defines within the row

getXFIndex

public short getXFIndex()
Specified by:
getXFIndex in interface CellValueRecordInterface

getRKField

public int getRKField()

getRKType

public short getRKType()
Get the type of the number

Returns:
one of these values:
  1. RK_IEEE_NUMBER
  2. RK_IEEE_NUMBER_TIMES_100
  3. RK_INTEGER
  4. RK_INTEGER_TIMES_100

getRKNumber

public double getRKNumber()
Extract the value of the number

The mechanism for determining the value is dependent on the two low order bits of the raw number. If bit 1 is set, the number is an integer and can be cast directly as a double, otherwise, it's apparently the exponent and mantissa of a double (and the remaining low-order bits of the double's mantissa are 0's).

If bit 0 is set, the result of the conversion to a double is divided by 100; otherwise, the value is left alone.

[insert picture of Screwy Squirrel in full Napoleonic regalia]

Returns:
the value as a proper double (hey, it could happen)

toString

public java.lang.String toString()
Description copied from class: Record
get a string representation of the record (for biffview/debugging)

Overrides:
toString in class Record

serialize

public int serialize(int offset,
                     byte[] data)
Description copied from class: RecordBase
called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Specified by:
serialize in class RecordBase
Parameters:
offset - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

main

public static void main(java.lang.String[] ignored_args)
Debugging main()

Normally I'd do this in a junit test, but let's face it -- once this algorithm has been tested and it works, we are never ever going to change it. This is driven by the Faceless Enemy's minions, who dare not change the algorithm out from under us.

Parameters:
ignored_args - command line arguments, which we blithely ignore

getSid

public short getSid()
Description copied from class: Record
return the non static version of the id for this record.

Specified by:
getSid in class Record

setColumn

public void setColumn(short col)
Specified by:
setColumn in interface CellValueRecordInterface
Parameters:
col - the column this cell defines

setRow

public void setRow(int row)
Specified by:
setRow in interface CellValueRecordInterface
Parameters:
row - the row this cell occurs within

setXFIndex

public void setXFIndex(short xf)
NO OP!

Specified by:
setXFIndex in interface CellValueRecordInterface

clone

public java.lang.Object clone()
Overrides:
clone in class Record


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.