loci.poi.hssf.record

Class SeriesTextRecord

java.lang.Object

loci.poi.hssf.record.Record

loci.poi.hssf.record.SeriesTextRecord

public class SeriesTextRecord
extends Record

Defines a series name NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.

Author:

Andrew C. Oliver (acoliver at apache.org)

Field Summary

Fields

Modifier and Type	Field and Description
private short	field_1_id
private byte	field_2_textLength
private byte	field_3_undocumented
private String	field_4_text
static short	sid

Constructor Summary

Constructors

Constructor and Description
SeriesTextRecord()
SeriesTextRecord(RecordInputStream in) Constructs a SeriesText record and sets its fields appropriately.

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
short	getId() Get the id field for the SeriesText record.
int	getRecordSize() Size of record (exluding 4 byte header)
short	getSid() return the non static version of the id for this record.
String	getText() Get the text field for the SeriesText record.
byte	getTextLength() Get the text length field for the SeriesText record.
byte	getUndocumented() Get the undocumented field for the SeriesText record.
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
void	setId(short field_1_id) Set the id field for the SeriesText record.
void	setText(String field_4_text) Set the text field for the SeriesText record.
void	setTextLength(byte field_2_textLength) Set the text length field for the SeriesText record.
void	setUndocumented(byte field_3_undocumented) Set the undocumented field for the SeriesText record.
String	toString() get a string representation of the record (for biffview/debugging)
protected void	validateSid(short id) Checks the sid matches the expected side for this record

Methods inherited from class loci.poi.hssf.record.Record

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

field_1_id

private short field_1_id

field_2_textLength

private byte field_2_textLength

field_3_undocumented

private byte field_3_undocumented

field_4_text

private String field_4_text

Constructor Detail

SeriesTextRecord

public SeriesTextRecord()

SeriesTextRecord

public SeriesTextRecord(RecordInputStream in)

Constructs a SeriesText record and sets its fields appropriately.

Parameters:

in - the RecordInputstream to read the record from

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)

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

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()

Size of record (exluding 4 byte header)

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

clone

public Object clone()

Overrides:

clone in class Record

getId

public short getId()

Get the id field for the SeriesText record.

setId

public void setId(short field_1_id)

Set the id field for the SeriesText record.

getTextLength

public byte getTextLength()

Get the text length field for the SeriesText record.

setTextLength

public void setTextLength(byte field_2_textLength)

Set the text length field for the SeriesText record.

getUndocumented

public byte getUndocumented()

Get the undocumented field for the SeriesText record.

setUndocumented

public void setUndocumented(byte field_3_undocumented)

Set the undocumented field for the SeriesText record.

getText

public String getText()

Get the text field for the SeriesText record.

setText

public void setText(String field_4_text)

Set the text field for the SeriesText record.