Package org.apache.poi.hssf.record
Class MulRKRecord
- java.lang.Object
-
- org.apache.poi.hssf.record.RecordBase
-
- org.apache.poi.hssf.record.Record
-
- org.apache.poi.hssf.record.StandardRecord
-
- org.apache.poi.hssf.record.MulRKRecord
-
- All Implemented Interfaces:
Duplicatable
,GenericRecord
public final class MulRKRecord extends StandardRecord
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!- Since:
- 2.0-pre
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description MulRKRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MulRKRecord
copy()
protected int
getDataSize()
short
getFirstColumn()
starting column (first cell this holds in the row)Map<String,Supplier<?>>
getGenericProperties()
HSSFRecordTypes
getGenericRecordType()
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)void
serialize(LittleEndianOutput out)
Write the data content of this BIFF record.-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MulRKRecord
public MulRKRecord(RecordInputStream in)
- 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)- Parameters:
coffset
- the 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)- Parameters:
coffset
- the coffset = column - field_2_first_col- Returns:
- the value (decoded into a double)
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
serialize
public void serialize(LittleEndianOutput out)
Description copied from class:StandardRecord
Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.The number of bytes written must equal the record size reported by
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()
- Specified by:
getDataSize
in classStandardRecord
-
copy
public MulRKRecord copy()
- Specified by:
copy
in interfaceDuplicatable
- Specified by:
copy
in classStandardRecord
- Returns:
- a deep copy of the implementing class / instance
-
getGenericRecordType
public HSSFRecordTypes getGenericRecordType()
- Specified by:
getGenericRecordType
in interfaceGenericRecord
- Specified by:
getGenericRecordType
in classRecord
-
-