FileDocCategorySizeDatePackage
SeriesIndexRecord.javaAPI DocApache Poi 3.0.13798Mon Jan 01 12:39:40 GMT 2007org.apache.poi.hssf.record

SeriesIndexRecord

public class SeriesIndexRecord extends Record
links a series to its position in the series list. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
author
Andrew C. Oliver (acoliver at apache.org)

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

param
id id must be 0x1065 or an exception will be throw upon validation
param
size 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
public java.lang.Objectclone()

        SeriesIndexRecord rec = new SeriesIndexRecord();
    
        rec.field_1_index = field_1_index;
        return rec;
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_index                  = in.readShort();
public shortgetIndex()
Get the index field for the SeriesIndex record.

        return field_1_index;
public intgetRecordSize()
Size of record (exluding 4 byte header)

        return 4  + 2;
public shortgetSid()

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

        int pos = 0;

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset, (short)(getRecordSize() - 4));

        LittleEndian.putShort(data, 4 + offset + pos, field_1_index);

        return getRecordSize();
public voidsetIndex(short field_1_index)
Set the index field for the SeriesIndex record.

        this.field_1_index = field_1_index;
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[SINDEX]\n");
        buffer.append("    .index                = ")
            .append("0x").append(HexDump.toHex(  getIndex ()))
            .append(" (").append( getIndex() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

        buffer.append("[/SINDEX]\n");
        return buffer.toString();
protected voidvalidateSid(short id)
Checks the sid matches the expected side for this record

param
id the expected sid.

        if (id != sid)
        {
            throw new RecordFormatException("Not a SeriesIndex record");
        }