Package loci.poi.hssf.record
Class SupBookRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.SupBookRecord
Title: Sup Book
Description: A Extrenal Workbook Deciption (Sup Book) Its only a dummy record for making new ExternSheet Record
REFERENCE:
- Author:
- Libin Roman (Vista Portal LDT. Developer), Andrew C. Oliver (acoliver@apache.org)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a Extern Sheet record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcalled by the constructor, should set class level fields.shortgetFlag()shortintgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetFlag(short flag) voidsetNumberOfSheets(short number) toString()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
-
SupBookRecord
public SupBookRecord() -
SupBookRecord
Constructs a Extern Sheet 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
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) 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. -
setNumberOfSheets
public void setNumberOfSheets(short number) -
getNumberOfSheets
public short getNumberOfSheets() -
setFlag
public void setFlag(short flag) -
getFlag
public short getFlag() -
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.
-