loci.poi.hssf.record

Class ExtSSTInfoSubRecord

java.lang.Object

loci.poi.hssf.record.Record

loci.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

Version:

2.0-pre

Author:

Andrew C. Oliver (acoliver at apache dot org)

See Also:

ExtSSTRecord

Field Summary

Fields

Modifier and Type	Field and Description
private int	field_1_stream_pos
private short	field_2_bucket_sst_offset
private short	field_3_zero
static int	INFO_SIZE
static short	sid

Constructor Summary

Constructors

Constructor and Description
ExtSSTInfoSubRecord() Creates new ExtSSTInfoSubRecord
ExtSSTInfoSubRecord(RecordInputStream in)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	fillFields(RecordInputStream in) 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	setBucketRecordOffset(short offset)
void	setStreamPos(int pos)
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 loci.poi.hssf.record.Record

clone, isInValueSection, isValue, serialize

Methods inherited from class java.lang.Object

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

Field Detail

INFO_SIZE

public static final int INFO_SIZE

See Also:

Constant Field Values

sid

public static final short sid

See Also:

Constant Field Values

field_1_stream_pos

private int field_1_stream_pos

field_2_bucket_sst_offset

private short field_2_bucket_sst_offset

field_3_zero

private short field_3_zero

Constructor Detail

ExtSSTInfoSubRecord

public ExtSSTInfoSubRecord()

Creates new ExtSSTInfoSubRecord

ExtSSTInfoSubRecord

public ExtSSTInfoSubRecord(RecordInputStream in)

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.

Specified by:

validateSid in class Record

Parameters:

id - alleged id for this record

fillFields

protected void fillFields(RecordInputStream in)

Description copied from class: Record

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

setStreamPos

public void setStreamPos(int pos)

setBucketRecordOffset

public void setBucketRecordOffset(short offset)

getStreamPos

public int getStreamPos()

getBucketSSTOffset

public short getBucketSSTOffset()

toString

public 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.

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

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