Top Description Inners Fields Constructors Methods
org.apache.poi.hssf.record

public final Class MulRKRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.common.usermodel.GenericRecord, org.apache.poi.hssf.util.RKUtil, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput, .RecordFormatException
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

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
MulRKRecord.RkRec

Field Summary

Modifier and TypeField and Description
private final int
field_1_row

private final short
field_2_first_col

private final MulRKRecord.RkRec[]
field_3_rks

private final short
field_4_last_col

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
MulRKRecord(RecordInputStream
the RecordInputstream to read the record from
in)

Method Summary

Modifier and TypeMethod and Description
public MulRKRecord
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

public short

Returns:

first column number
getFirstColumn()

starting column (first cell this holds in the row)

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public short

Returns:

first column number
getLastColumn()

ending column (last cell this holds in the row)

public int

Returns:

number of columns (last - first +1)
getNumColumns()

get the number of columns this contains (last-first +1)

public double

Returns:

the value (decoded into a double)
getRKNumberAt(int
the coffset = column - field_2_first_col
coffset)

returns the rk number for column (coffset = column - field_2_first_col)

public int
getRow()

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public short

Returns:

the XF index for the column
getXFAt(int
the coffset = column - field_2_first_col
coffset)

returns the xf index for column (coffset = column - field_2_first_col)

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

field_1_rowback to summary
private final int field_1_row
field_2_first_colback to summary
private final short field_2_first_col
field_3_rksback to summary
private final MulRKRecord.RkRec[] field_3_rks
field_4_last_colback to summary
private final short field_4_last_col
sidback to summary
public static final short sid

Constructor Detail

MulRKRecordback to summary
public MulRKRecord(RecordInputStream in)
Parameters
in:RecordInputStream

the RecordInputstream to read the record from

Method Detail

copyback to summary
public MulRKRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:MulRKRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

Annotations
@Override
getFirstColumnback to summary
public short getFirstColumn()

starting column (first cell this holds in the row)

Returns:short

first column number

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getLastColumnback to summary
public short getLastColumn()

ending column (last cell this holds in the row)

Returns:short

first column number

getNumColumnsback to summary
public int getNumColumns()

get the number of columns this contains (last-first +1)

Returns:int

number of columns (last - first +1)

getRKNumberAtback to summary
public double getRKNumberAt(int coffset)

returns the rk number for column (coffset = column - field_2_first_col)

Parameters
coffset:int

the coffset = column - field_2_first_col

Returns:double

the value (decoded into a double)

getRowback to summary
public int getRow()
getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

Annotations
@Override
getXFAtback to summary
public short getXFAt(int coffset)

returns the xf index for column (coffset = column - field_2_first_col)

Parameters
coffset:int

the coffset = column - field_2_first_col

Returns:short

the XF index for the column

serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

Annotations
@Override
org.apache.poi.hssf.record back to summary

private final Class MulRKRecord.RkRec

extends Object
implements GenericRecord
Class Inheritance
All Implemented Interfaces
org.apache.poi.common.usermodel.GenericRecord

Field Summary

Modifier and TypeField and Description
public static final int
ENCODED_SIZE

public final int
rk

public final short
xf

Constructor Summary

AccessConstructor and Description
private
RkRec(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public static MulRKRecord.RkRec[]
parseRKs(RecordInputStream in)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ENCODED_SIZEback to summary
public static final int ENCODED_SIZE
rkback to summary
public final int rk
xfback to summary
public final short xf

Constructor Detail

RkRecback to summary
private RkRec(RecordInputStream in)

Method Detail

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
parseRKsback to summary
public static MulRKRecord.RkRec[] parseRKs(RecordInputStream in)