jxl.biff: abstract public class: WritableRecordData

jxl.biff
abstract public class: WritableRecordData [javadoc | source]

java.lang.Object
   jxl.biff.RecordData
      jxl.biff.WritableRecordData

All Implemented Interfaces:
ByteData

Direct Known Subclasses:
PaletteRecord, PaneRecord, WritableFontRecord, AutoFilterRecord, HeaderRecord, TabIdRecord, PaletteRecord, LeftMarginRecord, ReadNumberFormulaRecord, CalcCountRecord, MsoDrawingRecord, Formula, RefModeRecord, DSFRecord, BooleanRecord, ExtendedSSTRecord, ButtonPropertySetRecord, GridSetRecord, ConditionalFormatRangeRecord, DBCellRecord, BlankRecord, PrecisionRecord, SortRecord, ProtectRecord, ReadDateFormulaRecord, ScenarioProtectRecord, Prot4RevPassRecord, FunctionGroupCountRecord, DateFormat, ArbitraryRecord, IterationRecord, LabelRecord, BookboolRecord, FontRecord, WorkspaceInformationRecord, WritableCellFormat, BuiltInStyle, WindowProtectRecord, CalcModeRecord, DateFormatRecord, WritableHyperlink, XFRecord, HyperlinkRecord, Window2Record, DefaultRowHeightRecord, NineteenFourRecord, Weird1Record, BackupRecord, WriteAccessRecord, SaveRecalcRecord, RefreshAllRecord, DataValiditySettingsRecord, ColumnInfoRecord, ReadFormulaRecord, MergedCellsRecord, SetupRecord, IndexRecord, DeltaRecord, FormulaRecord, NumberFormat, CellXFRecord, BoundsheetRecord, BottomMarginRecord, FooterRecord, UsesElfsRecord, TextObjectRecord, SCLRecord, InterfaceHeaderRecord, TopMarginRecord, NoteRecord, ObjectProtectRecord, NumberRecord, VerticalPageBreaksRecord, PrintGridLinesRecord, CellValue, SSTContinueRecord, MMSRecord, MulRKRecord, Prot4RevRecord, ContinueRecord, NumberFormatRecord, ReadErrorFormulaRecord, ObjProjRecord, RightMarginRecord, Window1Record, InterfaceEndRecord, ReadBooleanFormulaRecord, MarginRecord, DateRecord, ExternalSheetRecord, PrintHeadersRecord, HorizontalCentreRecord, FilterModeRecord, StringRecord, Blank, Font, RowRecord, CountryRecord, DimensionRecord, SSTRecord, ObjRecord, VerticalCentreRecord, Number, CodepageRecord, DataValidityListRecord, SupbookRecord, GuttersRecord, AutoFilterInfoRecord, NameRecord, ReadStringFormulaRecord, PLSRecord, Boolean, DefaultColumnWidth, StyleXFRecord, MsoDrawingGroupRecord, WritableFont, FormatRecord, ConditionalFormatRecord, BOFRecord, HorizontalPageBreaksRecord, HideobjRecord, SelectionRecord, PasswordRecord, Label, ExternalNameRecord, EOFRecord, DateTime

Extension of the standard RecordData which is used to support those records which, once read, may also be written

Field Summary
protected static final int	maxRecordLength	The maximum length allowed by Excel for any record length

Constructor:

Constructor:
protected WritableRecordData(Type t) { super(t); } Constructor used by the writable records Parameters: `t` - the biff type of this record
protected WritableRecordData(Record t) { super(t); } Constructor used when reading a record Parameters: `t` - the raw data read from the biff file

 protected WritableRecordData(Type t) {
                   
    super(t);
}

Constructor used by the writable records

Parameters:

t - the biff type of this record

 protected WritableRecordData(Record t) {
    super(t);
}

Constructor used when reading a record

Parameters:

t - the raw data read from the biff file

Method from jxl.biff.WritableRecordData Summary:
getBytes, getData

Methods from jxl.biff.RecordData:
getCode, getRecord

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from jxl.biff.WritableRecordData Detail:
public final byte[] getBytes() { byte[] data = getData(); int dataLength = data.length; // Don't the call the automatic continuation code for now // Assert.verify(dataLength < = maxRecordLength - 4); // If the bytes length is greater than the max record length // then split out the data set into continue records if (data.length > maxRecordLength - 4) { dataLength = maxRecordLength - 4; data = handleContinueRecords(data); } byte[] bytes = new byte[data.length + 4]; System.arraycopy(data, 0, bytes, 4, data.length); IntegerHelper.getTwoBytes(getCode(), bytes, 0); IntegerHelper.getTwoBytes(dataLength, bytes, 2); return bytes; } Used when writing out records. This portion of the method handles the biff code and the length of the record and appends on the data retrieved from the subclasses
abstract protected byte[] getData() Abstract method called by the getBytes method. Subclasses implement this method to incorporate their specific binary data - excluding the biff code and record length, which is handled by this class

Method from jxl.biff.WritableRecordData Detail:

 public final byte[] getBytes() {
    byte[] data = getData();
    int dataLength = data.length;
    // Don't the call the automatic continuation code for now
    //    Assert.verify(dataLength < = maxRecordLength - 4);
    // If the bytes length is greater than the max record length
    // then split out the data set into continue records
    if (data.length  > maxRecordLength - 4)
    {
      dataLength = maxRecordLength - 4;
      data = handleContinueRecords(data);
    }
    byte[]  bytes = new byte[data.length + 4];
    System.arraycopy(data, 0, bytes, 4, data.length);
    IntegerHelper.getTwoBytes(getCode(), bytes, 0);
    IntegerHelper.getTwoBytes(dataLength, bytes, 2);
    return bytes;
}

Used when writing out records. This portion of the method handles the biff code and the length of the record and appends on the data retrieved from the subclasses

 abstract protected byte[] getData()Abstract method called by the getBytes method. Subclasses implement
this method to incorporate their specific binary data - excluding the
biff code and record length, which is handled by this class