org.apache.poi.hssf.record
Class UnknownRecord

java.lang.Object
  org.apache.poi.hssf.record.Record
      org.apache.poi.hssf.record.UnknownRecord

public class UnknownRecord
extends Record

Title: Unknown Record (for debugging)

Description: 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!)

Company: SuperLink Software, Inc.

Author:

Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au), Glen Stampoultzis (glens at apache.org)

Constructor Summary

UnknownRecord()

UnknownRecord(RecordInputStream in)
construct an unknown record.

UnknownRecord(short id, byte[] data)

Method Summary

java.lang.Object	clone() Unlike the other Record.clone methods this is a shallow clone
protected void	fillFields(byte[] data, short sid)
protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
int	getRecordSize() gives the current serialized size of the record.
short	getSid() return the non static version of the id for this record.
int	serialize(int offset, byte[] data) spit the record out AS IS.
java.lang.String	toString() print a sort of string representation ([UNKNOWN RECORD] id = x [/UNKNOWN RECORD])
protected void	validateSid(short id) NO OP!

Methods inherited from class org.apache.poi.hssf.record.Record

cloneViaReserialise, isInValueSection, isValue, serialize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UnknownRecord

public UnknownRecord()

UnknownRecord

public UnknownRecord(short id,
                     byte[] data)

Parameters:

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

data - the data

UnknownRecord

public UnknownRecord(RecordInputStream in)

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

Parameters:

in - the RecordInputstream to read the record from

Method Detail

serialize

public int serialize(int offset,
                     byte[] data)

spit the record out AS IS. no interpretation or identification

Specified by:

serialize in class Record

Parameters:

offset - to begin writing at

data - byte array containing instance data

Returns:

number of bytes written

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 class Record

fillFields

protected void fillFields(byte[] data,
                          short sid)

validateSid

protected void validateSid(short id)

NO OP!

Specified by:

validateSid in class Record

Parameters:

id - alleged id for this record

toString

public java.lang.String toString()

print a sort of string representation ([UNKNOWN RECORD] id = x [/UNKNOWN RECORD])

Overrides:

toString in class Record

getSid

public short getSid()

Description copied from class: Record

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

Specified by:

getSid in class Record

fillFields

protected void fillFields(RecordInputStream in)

called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.

Specified by:

fillFields in class Record

Parameters:

in - the RecordInputstream to read the record from

clone

public java.lang.Object clone()

Unlike the other Record.clone methods this is a shallow clone

Overrides:

clone in class Record