Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hssf » record » [javadoc | source]
org.apache.poi.hssf.record
public class: StringRecord [javadoc | source]
java.lang.Object
   org.apache.poi.hssf.record.Record
      org.apache.poi.hssf.record.StringRecord
Supports the STRING record structure.
Field Summary
public static final  short sid     
Constructor:
 public StringRecord() 
 public StringRecord(RecordInputStream in) 
    Constructs a String record and sets its fields appropriately.
    Parameters:
    in - the RecordInputstream to read the record from
Method from org.apache.poi.hssf.record.StringRecord Summary:
clone,   fillFields,   getRecordSize,   getSid,   getString,   isInValueSection,   isUnCompressedUnicode,   processContinueRecord,   serialize,   setCompressedFlag,   setString,   toString,   validateSid
Methods from org.apache.poi.hssf.record.Record:
clone,   cloneViaReserialise,   fillFields,   getRecordSize,   getSid,   isInValueSection,   isValue,   serialize,   serialize,   toString,   validateSid
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hssf.record.StringRecord Detail:
 public Object clone() 
 protected  void fillFields(RecordInputStream in) 
 public int getRecordSize() 
    gives the current serialized size of the record. Should include the sid and reclength (4 bytes).
 public short getSid() 
    return the non static version of the id for this record.
 public String getString() 
 public boolean isInValueSection() 
 public boolean isUnCompressedUnicode() 
    is this uncompressed unicode (16bit)? Or just 8-bit compressed?
 public  void processContinueRecord(byte[] data) 
 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.
 public  void setCompressedFlag(byte unicode_flag) 
    Sets whether the string is compressed or not
 public  void setString(String string) 
    Sets the string represented by this record.
 public String toString() 
 protected  void validateSid(short id) 
    Throw a runtime exception in the event of a record passed with a differing ID.