Package loci.poi.hssf.record
Class FormatRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.FormatRecord
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 -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a Format record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcalled by the constructor, should set class level fields.get the format stringshortget the format index code (for built in formats)intgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.booleanget whether the string is unicodeintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidset the format stringvoidsetFormatStringLength(byte len) set the format string lengthvoidsetIndexCode(short index) set the format index code (for built in formats)voidsetUnicodeFlag(boolean unicode) set whether the string is unicodetoString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(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
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
FormatRecord
public FormatRecord() -
FormatRecord
Constructs a Format record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Description copied from class:Recordcalled by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- 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:
-
setFormatStringLength
public void setFormatStringLength(byte len) set the format string length- Parameters:
len- the length of the format string- See Also:
-
setUnicodeFlag
public void setUnicodeFlag(boolean unicode) set whether the string is unicode- Parameters:
unicode- flag for whether string is unicode
-
setFormatString
set the format string- Parameters:
fs- the format string- See Also:
-
getIndexCode
public short getIndexCode()get the format index code (for built in formats)- Returns:
- the format index code
- See Also:
-
getUnicodeFlag
public boolean getUnicodeFlag()get whether the string is unicode- Returns:
- flag for whether string is unicode
-
getFormatString
get the format string- Returns:
- the format string
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled 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. -
getRecordSize
public int getRecordSize()Description copied from class:Recordgives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record.
-