org.apache.poi.hssf.record
Class NoteStructureSubRecord

java.lang.Object
  org.apache.poi.hssf.record.Record
      org.apache.poi.hssf.record.SubRecord
          org.apache.poi.hssf.record.NoteStructureSubRecord

public class NoteStructureSubRecord
extends SubRecord

Represents a NoteStructure (0xD) sub record.

The docs say nothing about it. The length of this record is always 26 bytes.

Author:

Yegor Kozlov

Field Summary

static short

sid

Constructor Summary

NoteStructureSubRecord()
Construct a new NoteStructureSubRecord and fill its data with the default values

NoteStructureSubRecord(RecordInputStream in)
Constructs a NoteStructureSubRecord and sets its fields appropriately.

Method Summary

java.lang.Object	clone()
protected void	fillFields(RecordInputStream in) Read the record data from the supplied RecordInputStream
int	getRecordSize() Size of record
short	getSid() return the non static version of the id for this record.
int	serialize(int offset, byte[] data) Serialize the record data into the supplied array of bytes
java.lang.String	toString() Convert this record to string.
protected void	validateSid(short id) Checks the sid matches the expected side for this record

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

createSubRecord

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

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

NoteStructureSubRecord

public NoteStructureSubRecord()

Construct a new NoteStructureSubRecord and fill its data with the default values

NoteStructureSubRecord

public NoteStructureSubRecord(RecordInputStream in)

Constructs a NoteStructureSubRecord and sets its fields appropriately.

Method Detail

validateSid

protected void validateSid(short id)

Checks the sid matches the expected side for this record

Specified by:

validateSid in class Record

Parameters:

id - the expected sid.

fillFields

protected void fillFields(RecordInputStream in)

Read the record data from the supplied RecordInputStream

Specified by:

fillFields in class Record

Parameters:

in - the RecordInputstream to read the record from

toString

public java.lang.String toString()

Convert this record to string. Used by BiffViewer and other utulities.

Overrides:

toString in class Record

serialize

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

Serialize the record data into the supplied array of bytes

Specified by:

serialize in class Record

Parameters:

offset - offset in the data

data - the data to serialize into

Returns:

size of the record

getRecordSize

public int getRecordSize()

Size of record

Overrides:

getRecordSize 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

Returns:

id of this record.

clone

public java.lang.Object clone()

Overrides:

clone in class Record