org.apache.poi.hssf.record
Class ExtSSTInfoSubRecord

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

public class ExtSSTInfoSubRecord

extends Record

Extended SST table info subrecord

contains the elements of "info" in the SST's array field

WE HAVE VERY LITTLE INFORMATION ON HOW TO IMPLEMENT THIS RECORD! (EXTSSST)

Version:

2.0-pre

Author:

Andrew C. Oliver (acoliver at apache dot org)

See Also:

ExtSSTRecord

Field Summary

static short

sid

Constructor Summary

ExtSSTInfoSubRecord()
Creates new ExtSSTInfoSubRecord

ExtSSTInfoSubRecord(short id, short size, byte[] data)

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

Method Summary

protected void	fillFields(byte[] data, short size, int offset) called by the constructor, should set class level fields.
short	getBucketSSTOffset()
int	getRecordSize() gives the current serialized size of the record.
short	getSid() return the non static version of the id for this record.
int	getStreamPos()
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
void	setBucketSSTOffset(short offset)
void	setStreamPos(int pos)
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

ExtSSTInfoSubRecord

public ExtSSTInfoSubRecord()

Creates new ExtSSTInfoSubRecord

ExtSSTInfoSubRecord

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

ExtSSTInfoSubRecord

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

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)

setStreamPos

public void setStreamPos(int pos)

setBucketSSTOffset

public void setBucketSSTOffset(short offset)

getStreamPos

public int getStreamPos()

getBucketSSTOffset

public short getBucketSSTOffset()

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