Top Description Inners Fields Constructors Methods
org.apache.poi.hssf.record

public final Class ExtSSTRecord

extends ContinuableRecord
Class Inheritance
Imports
java.util.ArrayList, .Map, java.util.function.Supplier, java.util.stream.Stream, org.apache.poi.common.usermodel.GenericRecord, org.apache.poi.hssf.record.cont.ContinuableRecord, .ContinuableRecordOutput, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Extended Static String Table (0x00FF)

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.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
ExtSSTRecord.InfoSubRecord

Field Summary

Modifier and TypeField and Description
private ExtSSTRecord.InfoSubRecord[]
_sstInfos

private short
_stringsPerBucket

public static final int
DEFAULT_BUCKET_SIZE

public static final int
MAX_BUCKETS

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
ExtSSTRecord()

public
ExtSSTRecord(ExtSSTRecord other)

public
ExtSSTRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public ExtSSTRecord
copy()

Implements abstract org.apache.poi.hssf.record.Record.copy.

Implements org.apache.poi.common.Duplicatable.copy.

pack-priv int
getDataSize()

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

pack-priv ExtSSTRecord.InfoSubRecord[]
getInfoSubRecords()

public static int
getNumberOfInfoRecsForStrings(int numStrings)

public static int

Returns:

the size of the extsst record
getRecordSizeForStrings(int
the number of strings
numStrings)

Given a number of strings (in the sst), returns the size of the extsst record

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public void
serialize(ContinuableRecordOutput
a data output stream
out)

Implements abstract org.apache.poi.hssf.record.cont.ContinuableRecord.serialize.

Serializes this record's content to the supplied data output.

public void
setBucketOffsets(int[] bucketAbsoluteOffsets, int[] bucketRelativeOffsets)

public void
setNumStringsPerBucket(short numStrings)

Inherited from org.apache.poi.hssf.record.cont.ContinuableRecord:
getRecordSizeserialize

Field Detail

_sstInfosback to summary
private ExtSSTRecord.InfoSubRecord[] _sstInfos
_stringsPerBucketback to summary
private short _stringsPerBucket
DEFAULT_BUCKET_SIZEback to summary
public static final int DEFAULT_BUCKET_SIZE
MAX_BUCKETSback to summary
public static final int MAX_BUCKETS
sidback to summary
public static final short sid

Constructor Detail

ExtSSTRecordback to summary
public ExtSSTRecord()
ExtSSTRecordback to summary
public ExtSSTRecord(ExtSSTRecord other)
ExtSSTRecordback to summary
public ExtSSTRecord(RecordInputStream in)

Method Detail

copyback to summary
public ExtSSTRecord copy()

Implements abstract org.apache.poi.hssf.record.Record.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:ExtSSTRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
pack-priv int getDataSize()
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getInfoSubRecordsback to summary
pack-priv ExtSSTRecord.InfoSubRecord[] getInfoSubRecords()
getNumberOfInfoRecsForStringsback to summary
public static int getNumberOfInfoRecsForStrings(int numStrings)
getRecordSizeForStringsback to summary
public static int getRecordSizeForStrings(int numStrings)

Given a number of strings (in the sst), returns the size of the extsst record

Parameters
numStrings:int

the number of strings

Returns:int

the size of the extsst record

getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

serializeback to summary
public void serialize(ContinuableRecordOutput out)

Implements abstract org.apache.poi.hssf.record.cont.ContinuableRecord.serialize.

Doc from org.apache.poi.hssf.record.cont.ContinuableRecord.serialize.

Serializes this record's content to the supplied data output.

The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so only BIFF data should be written by this method. Simple data types can be written with the standard LittleEndianOutput methods. Methods from ContinuableRecordOutput can be used to serialize strings (with ContinueRecords being written as required). If necessary, implementors can explicitly start ContinueRecords (regardless of the amount of remaining space).

Parameters
out:ContinuableRecordOutput

a data output stream

setBucketOffsetsback to summary
public void setBucketOffsets(int[] bucketAbsoluteOffsets, int[] bucketRelativeOffsets)
setNumStringsPerBucketback to summary
public void setNumStringsPerBucket(short numStrings)
org.apache.poi.hssf.record back to summary

public final Class ExtSSTRecord.InfoSubRecord

extends Object
implements GenericRecord
Class Inheritance
All Implemented Interfaces
org.apache.poi.common.usermodel.GenericRecord

Field Summary

Modifier and TypeField and Description
public static final int
ENCODED_SIZE

private int
field_1_stream_pos

private int
field_2_bucket_sst_offset

private short
field_3_zero

unused - supposed to be zero

Constructor Summary

AccessConstructor and Description
public
InfoSubRecord(int
stream pointer to the SST record
streamPos, int
... don't really understand this yet
bucketSstOffset)

Creates new ExtSSTInfoSubRecord

public
InfoSubRecord(ExtSSTRecord.InfoSubRecord other)

public
InfoSubRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public int
getBucketSSTOffset()

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public int
getStreamPos()

public void
serialize(LittleEndianOutput out)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ENCODED_SIZEback to summary
public static final int ENCODED_SIZE
field_1_stream_posback to summary
private int field_1_stream_pos
field_2_bucket_sst_offsetback to summary
private int field_2_bucket_sst_offset
field_3_zeroback to summary
private short field_3_zero

unused - supposed to be zero

Constructor Detail

InfoSubRecordback to summary
public InfoSubRecord(int streamPos, int bucketSstOffset)

Creates new ExtSSTInfoSubRecord

Parameters
streamPos:int

stream pointer to the SST record

bucketSstOffset:int

... don't really understand this yet

InfoSubRecordback to summary
public InfoSubRecord(ExtSSTRecord.InfoSubRecord other)
InfoSubRecordback to summary
public InfoSubRecord(RecordInputStream in)

Method Detail

getBucketSSTOffsetback to summary
public int getBucketSSTOffset()
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getStreamPosback to summary
public int getStreamPos()
serializeback to summary
public void serialize(LittleEndianOutput out)