loci.poi.hssf.record

Class FormatRecord

java.lang.Object

loci.poi.hssf.record.Record

loci.poi.hssf.record.FormatRecord

public class FormatRecord
extends Record

Title: Format Record

Description: describes a number format -- those goofy strings like $(#,###)

REFERENCE: PG 317 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 M. Laubach (slaubach at apache dot org)

Field Summary

Fields

Modifier and Type	Field and Description
private short	field_1_index_code
private boolean	field_3_unicode_flag
private short	field_3_unicode_len
private String	field_4_formatstring
static short	sid

Constructor Summary

Constructors

Constructor and Description
FormatRecord()
FormatRecord(RecordInputStream in) Constructs a Format record and sets its fields appropriately.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
String	getFormatString() get the format string
short	getIndexCode() get the format index code (for built in formats)
int	getRecordSize() gives the current serialized size of the record.
short	getSid() return the non static version of the id for this record.
boolean	getUnicodeFlag() get whether the string is unicode
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
void	setFormatString(String fs) set the format string
void	setFormatStringLength(byte len) set the format string length
void	setIndexCode(short index) set the format index code (for built in formats)
void	setUnicodeFlag(boolean unicode) set whether the string is unicode
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

sid

public static final short sid

See Also:

Constant Field Values

field_1_index_code

private short field_1_index_code

field_3_unicode_len

private short field_3_unicode_len

field_3_unicode_flag

private boolean field_3_unicode_flag

field_4_formatstring

private String field_4_formatstring

Constructor Detail

FormatRecord

public FormatRecord()

FormatRecord

public FormatRecord(RecordInputStream in)

Constructs a Format record and sets its fields appropriately.

Parameters:

in - the RecordInputstream to read the record from

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

setIndexCode

public void setIndexCode(short index)

set the format index code (for built in formats)

Parameters:

index - the format index code

See Also:

Workbook

setFormatStringLength

public void setFormatStringLength(byte len)

set the format string length

Parameters:

len - the length of the format string

See Also:

setFormatString(String)

setUnicodeFlag

public void setUnicodeFlag(boolean unicode)

set whether the string is unicode

Parameters:

unicode - flag for whether string is unicode

setFormatString

public void setFormatString(String fs)

set the format string

Parameters:

fs - the format string

See Also:

setFormatStringLength(byte)

getIndexCode

public short getIndexCode()

get the format index code (for built in formats)

Returns:

the format index code

See Also:

Workbook

getUnicodeFlag

public boolean getUnicodeFlag()

get whether the string is unicode

Returns:

flag for whether string is unicode

getFormatString

public String getFormatString()

get the format string

Returns:

the format string

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