org.apache.poi.hssf.record
Class BeginRecord

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

public class BeginRecord
extends Record

The begin record defines the start of a block of records for a (grpahing data object. This record is matched with a corresponding EndRecord.

Author:
Glen Stampoultzis (glens at apache.org)
See Also:
EndRecord

Field Summary
static short sid
           
 
Constructor Summary
BeginRecord()
           
BeginRecord(short id, short size, byte[] data)
          Constructs a BeginRecord record and sets its fields appropriately.
BeginRecord(short id, short size, byte[] data, int offset)
          Constructs a BeginRecord record and sets its fields appropriately.
 
Method Summary
protected  void fillFields(byte[] data, short size, int offset)
          called by the constructor, should set class level fields.
 int getRecordSize()
          gives the current serialized size of the record.
 short getSid()
          return the non static version of the id for this record.
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 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, isInValueSection, 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

BeginRecord

public BeginRecord()

BeginRecord

public BeginRecord(short id,
                   short size,
                   byte[] data)
Constructs a BeginRecord record and sets its fields appropriately.
Parameters:
id - id must be 0x1033 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)

BeginRecord

public BeginRecord(short id,
                   short size,
                   byte[] data,
                   int offset)
Constructs a BeginRecord record and sets its fields appropriately.
Parameters:
id - id must be 0x1033 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)

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


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