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

SeriesChartGroupIndexRecord

public class SeriesChartGroupIndexRecord extends Record
The series chart group index record stores the index to the CHARTFORMAT record (0 based). NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
author
Glen Stampoultzis (glens at apache.org)

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

param
id id must be 0x1045 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()

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

        field_1_chartGroupIndex        = in.readShort();
public shortgetChartGroupIndex()
Get the chart group index field for the SeriesChartGroupIndex record.

        return field_1_chartGroupIndex;
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_chartGroupIndex);

        return getRecordSize();
public voidsetChartGroupIndex(short field_1_chartGroupIndex)
Set the chart group index field for the SeriesChartGroupIndex record.

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

        StringBuffer buffer = new StringBuffer();

        buffer.append("[SERTOCRT]\n");
        buffer.append("    .chartGroupIndex      = ")
            .append("0x").append(HexDump.toHex(  getChartGroupIndex ()))
            .append(" (").append( getChartGroupIndex() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

        buffer.append("[/SERTOCRT]\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 SeriesChartGroupIndex record");
        }