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

SeriesListRecord

public class SeriesListRecord extends Record
The series list record defines the series displayed as an overlay to the main chart record. 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_seriesNumbers
Constructors Summary
public SeriesListRecord()



     
    

    
public SeriesListRecord(RecordInputStream in)
Constructs a SeriesList record and sets its fields appropriately.

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

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

        field_1_seriesNumbers          = in.readShortArray();
    
public intgetRecordSize()
Size of record (exluding 4 byte header)

        return 4  + field_1_seriesNumbers.length * 2 + 2;
    
public short[]getSeriesNumbers()
Get the series numbers field for the SeriesList record.

        return field_1_seriesNumbers;
    
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.putShortArray(data, 4 + offset + pos, field_1_seriesNumbers);

        return getRecordSize();
    
public voidsetSeriesNumbers(short[] field_1_seriesNumbers)
Set the series numbers field for the SeriesList record.

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

        StringBuffer buffer = new StringBuffer();

        buffer.append("[SERIESLIST]\n");
        buffer.append("    .seriesNumbers        = ")
            .append(" (").append( getSeriesNumbers() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

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