org.apache.poi.hssf.record
Class DBCellRecord

java.lang.Object
  |
  +--org.apache.poi.hssf.record.Record
        |
        +--org.apache.poi.hssf.record.DBCellRecord

public class DBCellRecord
extends Record

Title: DBCell Record (Currently read only. Not required.) Description: Used to find rows in blocks...TODO

REFERENCE: PG 299/440 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:
2.0-pre
Author:
Andrew C. Oliver (acoliver at apache dot org)

Field Summary
static short sid
           
 
Constructor Summary
DBCellRecord()
           
DBCellRecord(short id, short size, byte[] data)
          Constructs a DBCellRecord and sets its fields appropriately
DBCellRecord(short id, short size, byte[] data, int offset)
          Constructs a DBCellRecord and sets its fields appropriately
 
Method Summary
 void addCellOffset(short offset)
           
protected  void fillFields(byte[] data, short size, int offset)
          called by the constructor, should set class level fields.
 short getCellOffsetAt(int index)
          return the cell offset in the array
 int getNumCellOffsets()
          get the number of cell offsets in the celloffset array
 int getRecordSize()
          gives the current serialized size of the record.
 int getRowOffset()
          gets offset from the start of this DBCellRecord to the start of the first cell in the next DBCell block.
 short getSid()
          return the non static version of the id for this record.
 boolean isInValueSection()
          DBCELL, ROW, VALUES all say yes
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setRowOffset(int offset)
          sets offset from the start of this DBCellRecord to the start of the first cell in the next DBCell block.
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
protected  void validateSid(short id)
          called by constructor, should throw runtime exception in the event of a record passed with a differing ID.
 
Methods inherited from class org.apache.poi.hssf.record.Record
fillFields, isValue, processContinueRecord, serialize
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
Constructor Detail

DBCellRecord

public DBCellRecord()

DBCellRecord

public DBCellRecord(short id,
                    short size,
                    byte[] data)
Constructs a DBCellRecord and sets its fields appropriately
Parameters:
id - id must be 0xd7 or an exception will be throw upon validation
size - the size of the data area of the record
data - data of the record (should not contain sid/len)

DBCellRecord

public DBCellRecord(short id,
                    short size,
                    byte[] data,
                    int offset)
Constructs a DBCellRecord and sets its fields appropriately
Parameters:
id - id must be 0xd7 or an exception will be throw upon validation
size - the size of the data area of the record
data - data of the record (should not contain sid/len)
offset - of the record's data
Method Detail

validateSid

protected void validateSid(short id)
Description copied from class: Record
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.
Overrides:
validateSid in class Record
Following copied from class: org.apache.poi.hssf.record.Record
Parameters:
id - alleged id for this record

fillFields

protected void fillFields(byte[] data,
                          short size,
                          int offset)
Description copied from class: Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.
Overrides:
fillFields in class Record
Following copied from class: org.apache.poi.hssf.record.Record
Parameters:
data - raw data
size - size of data
offset - of the record's data (provided a big array of the file)

setRowOffset

public void setRowOffset(int offset)
sets offset from the start of this DBCellRecord to the start of the first cell in the next DBCell block.
Parameters:
rowoffset - to the start of the first cell in the next DBCell block

addCellOffset

public void addCellOffset(short offset)

getRowOffset

public int getRowOffset()
gets offset from the start of this DBCellRecord to the start of the first cell in the next DBCell block.
Returns:
rowoffset to the start of the first cell in the next DBCell block

getCellOffsetAt

public short getCellOffsetAt(int index)
return the cell offset in the array
Parameters:
index - of the cell offset to retrieve
Returns:
celloffset from the celloffset array

getNumCellOffsets

public int getNumCellOffsets()
get the number of cell offsets in the celloffset array
Returns:
number of cell offsets

toString

public java.lang.String toString()
Description copied from class: Record
get a string representation of the record (for biffview/debugging)
Overrides:
toString in class Record

serialize

public int serialize(int offset,
                     byte[] data)
Description copied from class: Record
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.
Overrides:
serialize in class Record
Following copied from class: org.apache.poi.hssf.record.Record
Parameters:
offset - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

getRecordSize

public int getRecordSize()
Description copied from class: Record
gives the current serialized size of the record.
Overrides:
getRecordSize in class Record

getSid

public short getSid()
Description copied from class: Record
return the non static version of the id for this record.
Overrides:
getSid in class Record

isInValueSection

public boolean isInValueSection()
Description copied from class: Record
DBCELL, ROW, VALUES all say yes
Overrides:
isInValueSection in class Record


Copyright © 2002 Apache jakarta-poi project. All Rights Reserved.