Package loci.poi.hssf.record
Class StringRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.StringRecord
Supports the STRING record structure.
- Author:
- Glen Stampoultzis (glens at apache.org)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a String record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.intgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.booleanDBCELL, ROW, VALUES all say yesbooleanis this uncompressed unicode (16bit)? Or just 8-bit compressed?intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetCompressedFlag(byte unicode_flag) Sets whether the string is compressed or notvoidSets the string represented by this record.toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) Throw a runtime exception in the event of a record passed with a differing ID.
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
StringRecord
public StringRecord() -
StringRecord
Constructs a String record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Throw a 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
-
isInValueSection
public boolean isInValueSection()Description copied from class:RecordDBCELL, ROW, VALUES all say yes- Overrides:
isInValueSectionin classRecord
-
getRecordSize
public int getRecordSize()gives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
isUnCompressedUnicode
public boolean isUnCompressedUnicode()is this uncompressed unicode (16bit)? Or just 8-bit compressed?- Returns:
- isUnicode - True for 16bit- false for 8bit
-
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. -
getSid
public short getSid()return the non static version of the id for this record. -
getString
- Returns:
- The string represented by this record.
-
setCompressedFlag
public void setCompressedFlag(byte unicode_flag) Sets whether the string is compressed or not- Parameters:
unicode_flag- 1 = uncompressed, 0 = compressed
-
setString
Sets the string represented by this record. -
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
clone
-