Package loci.poi.hssf.record
Class NumberRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.poi.hssf.record.NumberRecord
-
- All Implemented Interfaces:
Comparable
,CellValueRecordInterface
public class NumberRecord extends Record implements CellValueRecordInterface, Comparable
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
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description NumberRecord()
Creates new NumberRecordNumberRecord(RecordInputStream in)
Constructs a Number record and sets its fields appropriately.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
clone()
int
compareTo(Object obj)
boolean
equals(Object obj)
protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.short
getColumn()
get the column this cell defines within the rowint
getRecordSize()
gives the current serialized size of the record.int
getRow()
get the row this cell occurs onshort
getSid()
return the non static version of the id for this record.double
getValue()
get the value for the cellshort
getXFIndex()
get the index to the ExtendedFormatboolean
isAfter(CellValueRecordInterface i)
returns whether this cell is after the passed in cellboolean
isBefore(CellValueRecordInterface i)
returns whether this cell is before the passed in cellboolean
isEqual(CellValueRecordInterface i)
returns whether this cell represents the same cell (NOT VALUE)boolean
isInValueSection()
DBCELL, ROW, VALUES all say yesboolean
isValue()
tells whether this type of record contains a valueint
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.void
setColumn(short col)
set the column this cell defines within the rowvoid
setRow(int row)
set the row this cell occurs onvoid
setValue(double value)
set the value for the cellvoid
setXFIndex(short xf)
set the index to the ExtendedFormatString
toString()
get a string representation of the record (for biffview/debugging)protected void
validateSid(short id)
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.
-
-
-
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)
Constructs a Number record and sets its fields appropriately.- Parameters:
in
- the RecordInputstream to read the record from
-
-
Method Detail
-
fillFields
protected void fillFields(RecordInputStream in)
Description copied from class:Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFields
in classRecord
- Parameters:
in
- the RecordInputstream to read the record from
-
setRow
public void setRow(int row)
Description copied from interface:CellValueRecordInterface
set the row this cell occurs on- Specified by:
setRow
in interfaceCellValueRecordInterface
- Parameters:
row
- the row this cell occurs within
-
setColumn
public void setColumn(short col)
Description copied from interface:CellValueRecordInterface
set the column this cell defines within the row- Specified by:
setColumn
in interfaceCellValueRecordInterface
- Parameters:
col
- the column this cell defines
-
setXFIndex
public void setXFIndex(short xf)
set the index to the ExtendedFormat- Specified by:
setXFIndex
in interfaceCellValueRecordInterface
- 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()
Description copied from interface:CellValueRecordInterface
get the row this cell occurs on- Specified by:
getRow
in interfaceCellValueRecordInterface
- Returns:
- the row
-
getColumn
public short getColumn()
Description copied from interface:CellValueRecordInterface
get the column this cell defines within the row- Specified by:
getColumn
in interfaceCellValueRecordInterface
- Returns:
- the column
-
getXFIndex
public short getXFIndex()
get the index to the ExtendedFormat- Specified by:
getXFIndex
in interfaceCellValueRecordInterface
- 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 String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
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.
-
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 classRecord
-
validateSid
protected void validateSid(short id)
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSid
in classRecord
- Parameters:
id
- alleged id for this record
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
isBefore
public boolean isBefore(CellValueRecordInterface i)
Description copied from interface:CellValueRecordInterface
returns whether this cell is before the passed in cell- Specified by:
isBefore
in interfaceCellValueRecordInterface
- Parameters:
i
- another cell interface record to compare- Returns:
- true if the cells is before, or false if not
-
isAfter
public boolean isAfter(CellValueRecordInterface i)
Description copied from interface:CellValueRecordInterface
returns whether this cell is after the passed in cell- Specified by:
isAfter
in interfaceCellValueRecordInterface
- Parameters:
i
- record to compare- Returns:
- true if the cell is after, false if not
-
isEqual
public boolean isEqual(CellValueRecordInterface i)
Description copied from interface:CellValueRecordInterface
returns whether this cell represents the same cell (NOT VALUE)- Specified by:
isEqual
in interfaceCellValueRecordInterface
- Parameters:
i
- record to compare- Returns:
- true if the cells are the same cell (positionally), false if not.
-
isInValueSection
public boolean isInValueSection()
Description copied from class:Record
DBCELL, ROW, VALUES all say yes- Overrides:
isInValueSection
in classRecord
-
isValue
public boolean isValue()
Description copied from class:Record
tells whether this type of record contains a value
-
compareTo
public int compareTo(Object obj)
- Specified by:
compareTo
in interfaceComparable
-
clone
public Object clone()
- Specified by:
clone
in interfaceCellValueRecordInterface
- Overrides:
clone
in classRecord
-
-