org.apache.poi.hssf.record
Class NumberRecord

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.NumberRecord
All Implemented Interfaces:
CellValueRecordInterface

public final class NumberRecord
extends Record
implements CellValueRecordInterface

NUMBER (0x0203) Contains a numeric cell value.

REFERENCE: PG 334 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)

Field Summary
static short sid
           
 
Constructor Summary
NumberRecord()
          Creates new NumberRecord
NumberRecord(RecordInputStream in)
           
 
Method Summary
 java.lang.Object clone()
           
 short getColumn()
           
 int getRecordSize()
          gives the current serialized size of the record.
 int getRow()
           
 short getSid()
          return the non static version of the id for this record.
 double getValue()
          get the value for the cell
 short getXFIndex()
          get the index to the ExtendedFormat
 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 setValue(double value)
          set the value for the cell
 void setXFIndex(short xf)
          set the index to the ExtendedFormat
 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, 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
Constructor Detail

NumberRecord

public NumberRecord()
Creates new NumberRecord


NumberRecord

public NumberRecord(RecordInputStream in)
Parameters:
in - the RecordInputstream to read the record from
Method Detail

setRow

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

setColumn

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

setXFIndex

public void setXFIndex(short xf)
set the index to the ExtendedFormat

Specified by:
setXFIndex in interface CellValueRecordInterface
Parameters:
xf - index to the XF record
See Also:
ExtendedFormatRecord

setValue

public void setValue(double value)
set the value for the cell

Parameters:
value - double representing the value

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()
get the index to the ExtendedFormat

Specified by:
getXFIndex in interface CellValueRecordInterface
Returns:
index to the XF record
See Also:
ExtendedFormatRecord

getValue

public double getValue()
get the value for the cell

Returns:
double representing the value

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)
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:
byte array containing instance data

getRecordSize

public int getRecordSize()
Description copied from class: Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Overrides:
getRecordSize in class Record

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

clone

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


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