Package loci.poi.hssf.record
Class MulRKRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.poi.hssf.record.MulRKRecord
-
public class MulRKRecord extends Record
Used to store multiple RK numbers on a row. 1 MulRk = Multiple Cell values. HSSF just converts this into multiple NUMBER records. READ-ONLY SUPPORT!REFERENCE: PG 330 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org)
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description MulRKRecord()
Creates new MulRKRecordMulRKRecord(RecordInputStream in)
Constructs a MulRK record and sets its fields appropriately.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.short
getFirstColumn()
starting column (first cell this holds in the row)short
getLastColumn()
ending column (last cell this holds in the row)int
getNumColumns()
get the number of columns this contains (last-first +1)double
getRKNumberAt(int coffset)
returns the rk number for column (coffset = column - field_2_first_col)int
getRow()
short
getSid()
return the non static version of the id for this record.short
getXFAt(int coffset)
returns the xf index for column (coffset = column - field_2_first_col)int
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.String
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.-
Methods inherited from class loci.poi.hssf.record.Record
clone, getRecordSize, isInValueSection, isValue, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MulRKRecord
public MulRKRecord()
Creates new MulRKRecord
-
MulRKRecord
public MulRKRecord(RecordInputStream in)
Constructs a MulRK record and sets its fields appropriately.- Parameters:
in
- the RecordInputstream to read the record from
-
-
Method Detail
-
getRow
public int getRow()
-
getFirstColumn
public short getFirstColumn()
starting column (first cell this holds in the row)- Returns:
- first column number
-
getLastColumn
public short getLastColumn()
ending column (last cell this holds in the row)- Returns:
- first column number
-
getNumColumns
public int getNumColumns()
get the number of columns this contains (last-first +1)- Returns:
- number of columns (last - first +1)
-
getXFAt
public short getXFAt(int coffset)
returns the xf index for column (coffset = column - field_2_first_col)- Returns:
- the XF index for the column
-
getRKNumberAt
public double getRKNumberAt(int coffset)
returns the rk number for column (coffset = column - field_2_first_col)- Returns:
- the value (decoded into a double)
-
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
-
toString
public String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
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.
-
serialize
public int serialize(int offset, byte[] data)
Description copied from class:Record
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.
-
-