org.apache.poi.hssf.record
Class HeaderRecord

java.lang.Object
  |
  +--org.apache.poi.hssf.record.Record
        |
        +--org.apache.poi.hssf.record.HeaderRecord

public class HeaderRecord

extends Record

Title: Header Record

Description: Specifies a header for a sheet

REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:

2.0-pre

Author:

Andrew C. Oliver (acoliver at apache dot org), Shawn Laubach (laubach@acm.org) Modified 3/14/02

Field Summary

static short

sid

Constructor Summary

HeaderRecord()

HeaderRecord(short id, short size, byte[] data)
Constructs an Header record and sets its fields appropriately.

HeaderRecord(short id, short size, byte[] data, int offset)
Constructs an Header record and sets its fields appropriately.

Method Summary

protected void	fillFields(byte[] data, short size, int offset) called by the constructor, should set class level fields.
java.lang.String	getHeader() get the header string
short	getHeaderLength() get the length of the header string
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) called by the class that is responsible for writing this sucker.
void	setHeader(java.lang.String header) set the header string
void	setHeaderLength(byte len) set the length of the header string
java.lang.String	toString() get a string representation of the record (for biffview/debugging)
protected void	validateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

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

fillFields, isInValueSection, isValue, processContinueRecord, serialize

Methods inherited from class java.lang.Object

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

Field Detail

sid

public static final short sid

Constructor Detail

HeaderRecord

public HeaderRecord()

HeaderRecord

public HeaderRecord(short id,
                    short size,
                    byte[] data)

Constructs an Header record and sets its fields appropriately.

Parameters:

id - id must be 0x14 or an exception will be throw upon validation

size - the size of the data area of the record

data - data of the record (should not contain sid/len)

HeaderRecord

public HeaderRecord(short id,
                    short size,
                    byte[] data,
                    int offset)

Constructs an Header record and sets its fields appropriately.

Parameters:

id - id must be 0x14 or an exception will be throw upon validation

size - the size of the data area of the record

data - data of the record (should not contain sid/len)

offset - of the record's data

Method Detail

validateSid

protected void validateSid(short id)

Description copied from class: Record

called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

Overrides:

validateSid in class Record

Following copied from class: org.apache.poi.hssf.record.Record

Parameters:

id - alleged id for this record

fillFields

protected void fillFields(byte[] data,
                          short size,
                          int offset)

Description copied from class: Record

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

Overrides:

fillFields in class Record

Following copied from class: org.apache.poi.hssf.record.Record

Parameters:

data - raw data

size - size of data

offset - of the record's data (provided a big array of the file)

setHeaderLength

public void setHeaderLength(byte len)

set the length of the header string

Parameters:

len - length of the header string

See Also:

setHeader(String)

setHeader

public void setHeader(java.lang.String header)

set the header string

Parameters:

header - string to display

See Also:

setHeaderLength(byte)

getHeaderLength

public short getHeaderLength()

get the length of the header string

Returns:

length of the header string

See Also:

getHeader()

getHeader

public java.lang.String getHeader()

get the header string

Returns:

header string to display

See Also:

getHeaderLength()

toString

public java.lang.String toString()

Description copied from class: Record

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class Record

serialize

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

Description copied from class: Record

called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Overrides:

serialize in class Record

Following copied from class: org.apache.poi.hssf.record.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.

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.

Overrides:

getSid in class Record