Package loci.poi.hssf.record
Class ExtSSTRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.ExtSSTRecord
Title: Extended Static String Table
Description: This record is used for a quick lookup into the SST record. This record breaks the SST table into a set of buckets. The offsets to these buckets within the SST record are kept as well as the position relative to the start of the SST record. REFERENCE: PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at apache dot org)
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final short -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a EOFRecord record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionvoidprotected voidcalled by the constructor, should set class level fields.getInfoRecordAt(int elem) static final intgetNumberOfInfoRecsForStrings(int numStrings) intshortintReturns the size of this recordstatic final intgetRecordSizeForStrings(int numStrings) Given a number of strings (in the sst), returns the size of the extsst recordshortgetSid()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.voidsetBucketOffsets(int[] bucketAbsoluteOffsets, int[] bucketRelativeOffsets) voidsetNumStringsPerBucket(short numStrings) 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
-
DEFAULT_BUCKET_SIZE
public static final int DEFAULT_BUCKET_SIZE- See Also:
-
MAX_BUCKETS
public static final int MAX_BUCKETS- See Also:
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
ExtSSTRecord
public ExtSSTRecord() -
ExtSSTRecord
Constructs a EOFRecord 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
-
setNumStringsPerBucket
public void setNumStringsPerBucket(short numStrings) -
addInfoRecord
-
getNumStringsPerBucket
public short getNumStringsPerBucket() -
getNumInfoRecords
public int getNumInfoRecords() -
getInfoRecordAt
-
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()Returns the size of this record- Overrides:
getRecordSizein classRecord
-
getNumberOfInfoRecsForStrings
public static final int getNumberOfInfoRecsForStrings(int numStrings) -
getRecordSizeForStrings
public static final int getRecordSizeForStrings(int numStrings) Given a number of strings (in the sst), returns the size of the extsst record -
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
setBucketOffsets
public void setBucketOffsets(int[] bucketAbsoluteOffsets, int[] bucketRelativeOffsets)
-