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

public final Class UnknownRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Locale, .Map, java.util.function.Supplier, org.apache.poi.hssf.record.aggregates.PageSettingsBlock, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Unknown record just tells you the sid so you can figure out what records you are missing. Also helps us read/modify sheets we don't know all the records to. (HSSF leaves these alone!)

Field Summary

Modifier and TypeField and Description
private byte[]
_rawData

private int
_sid

public static final int
BITMAP_00E9

public static final int
CODENAME_1BA

public static final int
LABELRANGES_015F

public static final int
PHONETICPR_00EF

public static final int
PLS_004D

Environment-Specific Print Record

public static final int
PLV_MAC

public static final int
PRINTSIZE_0033

seems to be part of the PageSettingsBlock.

public static final int
QUICKTIP_0800

public static final int
SCL_00A0

public static final int
SHEETEXT_0862

public static final int
SHEETPR_0081

public static final int
SHEETPROTECTION_0867

public static final int
SORT_0090

public static final int
STANDARDWIDTH_0099

Constructor Summary

AccessConstructor and Description
public
UnknownRecord(int
id of the record -not validated, just stored for serialization
id, byte[]
the data
data)

public
UnknownRecord(RecordInputStream
the RecordInputstream to read the record from
in)

construct an unknown record.

Method Summary

Modifier and TypeMethod and Description
public UnknownRecord
copy()

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

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

public static String

Returns:

the documented name of this BIFF record type, null if unknown to POI
getBiffName(int
The identifier for an unknown record type
sid)

These BIFF record types are known but still uninterpreted by POI

protected int
getDataSize()

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

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
getSid()

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

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

private static boolean

Returns:

true if the unknown record id has been observed in POI unit tests
isObservedButUnknown(int sid)

public void
serialize(LittleEndianOutput
the output object
out)

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

spit the record out AS IS.

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

Field Detail

_rawDataback to summary
private byte[] _rawData
_sidback to summary
private int _sid
BITMAP_00E9back to summary
public static final int BITMAP_00E9
CODENAME_1BAback to summary
public static final int CODENAME_1BA
LABELRANGES_015Fback to summary
public static final int LABELRANGES_015F
PHONETICPR_00EFback to summary
public static final int PHONETICPR_00EF
PLS_004Dback to summary
public static final int PLS_004D

Environment-Specific Print Record

PLV_MACback to summary
public static final int PLV_MAC
PRINTSIZE_0033back to summary
public static final int PRINTSIZE_0033

seems to be part of the PageSettingsBlock. Not interpreted by POI. The name 'PRINTSIZE' was taken from OOO source.

The few POI test samples with this record have data { 0x03, 0x00 }.

QUICKTIP_0800back to summary
public static final int QUICKTIP_0800
SCL_00A0back to summary
public static final int SCL_00A0
SHEETEXT_0862back to summary
public static final int SHEETEXT_0862
SHEETPR_0081back to summary
public static final int SHEETPR_0081
SHEETPROTECTION_0867back to summary
public static final int SHEETPROTECTION_0867
SORT_0090back to summary
public static final int SORT_0090
STANDARDWIDTH_0099back to summary
public static final int STANDARDWIDTH_0099

Constructor Detail

UnknownRecordback to summary
public UnknownRecord(int id, byte[] data)
Parameters
id:int

id of the record -not validated, just stored for serialization

data:byte[]

the data

UnknownRecordback to summary
public UnknownRecord(RecordInputStream in)

construct an unknown record. No fields are interpreted and the record will be serialized in its original form more or less

Parameters
in:RecordInputStream

the RecordInputstream to read the record from

Method Detail

copyback to summary
public UnknownRecord copy()

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

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

Returns:UnknownRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getBiffNameback to summary
public static String getBiffName(int sid)

These BIFF record types are known but still uninterpreted by POI

Parameters
sid:int

The identifier for an unknown record type

Returns:String

the documented name of this BIFF record type, null if unknown to POI

getDataSizeback to summary
protected int getDataSize()

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

Annotations
@Override
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
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
isObservedButUnknownback to summary
private static boolean isObservedButUnknown(int sid)
Returns:boolean

true if the unknown record id has been observed in POI unit tests

serializeback to summary
public void serialize(LittleEndianOutput out)

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

spit the record out AS IS. no interpretation or identification

Parameters
out:LittleEndianOutput

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

the output object

Annotations
@Override