Save This Page
Home » cocoon-2.1.11-src » org.apache.cocoon.poi » hssf » record » [javadoc | source]
org.apache.cocoon.poi.hssf.record
abstract public class: Record [javadoc | source]
java.lang.Object
   org.apache.cocoon.poi.hssf.record.Record

Direct Known Subclasses:
    DeltaRecord, ExtendedFormatRecord, FormulaRecord, IndexRecord, PasswordRev4Record, FormatRecord, CountryRecord, MulBlankRecord, UseSelFSRecord, WSBoolRecord, ProtectRecord, ContinueRecord, ColumnInfoRecord, HideObjRecord, PrecisionRecord, DefaultColWidthRecord, RKRecord, DateWindow1904Record, InterfaceEndRecord, LabelSSTRecord, FooterRecord, DSFRecord, StyleRecord, DBCellRecord, UnicodeString, CodepageRecord, ExtSSTRecord, BlankRecord, ProtectionRev4Record, HeaderRecord, VCenterRecord, CalcCountRecord, RefModeRecord, PrintGridlinesRecord, PrintSetupRecord, MulRKRecord, HCenterRecord, GutsRecord, NumberRecord, WindowProtectRecord, RowRecord, DimensionsRecord, RefreshAllRecord, EOFRecord, InterfaceHdrRecord, TabIdRecord, WriteAccessRecord, SaveRecalcRecord, PrintHeadersRecord, PasswordRecord, LabelRecord, MMSRecord, CalcModeRecord, WindowOneRecord, SSTRecord, BOFRecord, SelectionRecord, GridsetRecord, FnGroupCountRecord, UnknownRecord, BookBoolRecord, BoundSheetRecord, BackupRecord, ExtSSTInfoSubRecord, FontRecord, DefaultRowHeightRecord, IterationRecord, WindowTwoRecord

Title: Record Description: All HSSF Records inherit from this class. It populates the fields common to all records (id, size and data). Subclasses should be sure to validate the id, Copyright: Copyright (c) 2001 Company:
Field Summary
public  short sid    The static ID, subclasses should override this value with the id for the record type they handle. 
Constructor:
 public Record() 
 public Record(short id,
    short size,
    byte[] data) 
 public Record(short id,
    short size,
    byte[] data,
    int offset) 
Method from org.apache.cocoon.poi.hssf.record.Record Summary:
fillFields,   fillFields,   getRecordSize,   getSid,   isInValueSection,   isValue,   processContinueRecord,   serialize,   toString,   validateSid
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.cocoon.poi.hssf.record.Record Detail:
 protected  void fillFields(byte[] data,
    short size) 
    called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.
 abstract protected  void fillFields(byte[] data,
    short size,
    int offset)
    called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.
 public int getRecordSize() 
    gives the current serialized size of the record.
 abstract public short getSid()
    return the non static version of the id for this record.
 public boolean isInValueSection() 
    DBCELL, ROW, VALUES all say yes
 public boolean isValue() 
    tells whether this type of record contains a value
 public  void processContinueRecord(byte[] record) 
    Process a continuation record; default handling is to ignore it -- TODO add logging
 abstract public byte[] serialize()
    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 String toString() 
    get a string representation of the record (for biffview/debugging)
 abstract protected  void validateSid(short id)
    called by constructor, should throw runtime exception in the event of a record passed with a differing ID.