FileDocCategorySizeDatePackage
BeginRecord.javaAPI DocApache Poi 3.0.12588Mon Jan 01 12:39:40 GMT 2007org.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.
see
EndRecord
author
Glen Stampoultzis (glens at apache.org)

Fields Summary
public static final short
sid
Constructors Summary
public BeginRecord()
public BeginRecord(RecordInputStream in)
Constructs a BeginRecord record and sets its fields appropriately.

param
id id must be 0x1033 or an exception will be throw upon validation
param
size the size of the data area of the record
param
data data of the record (should not contain sid/len)

        super(in);
Methods Summary
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)
public intgetRecordSize()

        return 4;
public shortgetSid()

        return sid;
public intserialize(int offset, byte[] data)

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset,
                              (( short ) 0));   // no record info
        return getRecordSize();
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[BEGIN]\n");
        buffer.append("[/BEGIN]\n");
        return buffer.toString();
protected voidvalidateSid(short id)

        if (id != sid)
        {
            throw new RecordFormatException("NOT A BEGIN RECORD");
        }