Package loci.poi.hssf.record
Class HeaderRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.HeaderRecord
Title: Header Record
Description: Specifies a header for a sheet
REFERENCE: PG 321 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 Laubach (slaubach at apache dot org) Modified 3/14/02, Jason Height (jheight at chariot dot net dot au)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an Header record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.get the header stringshortget the length of the header stringintgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.booleansee the unicode flagintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidset the header stringvoidsetHeaderLength(byte len) set the length of the header stringtoString()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
isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
HeaderRecord
public HeaderRecord() -
HeaderRecord
Constructs an Header 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
-
isMultibyte
public boolean isMultibyte()see the unicode flag- Returns:
- boolean flag true:footer string has at least one multibyte character
-
setHeaderLength
public void setHeaderLength(byte len) set the length of the header string- Parameters:
len- length of the header string- See Also:
-
setHeader
set the header string- Parameters:
header- string to display- See Also:
-
getHeaderLength
public short getHeaderLength()get the length of the header string- Returns:
- length of the header string
- See Also:
-
getHeader
get the header string- Returns:
- header string to display
- See Also:
-
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. -
clone
-