org.apache.poi.hssf.record
Class SeriesChartGroupIndexRecord

java.lang.Object
  |
  +--org.apache.poi.hssf.record.Record
        |
        +--org.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)

Field Summary
static short sid
           
 
Constructor Summary
SeriesChartGroupIndexRecord()
           
SeriesChartGroupIndexRecord(short id, short size, byte[] data)
          Constructs a SeriesChartGroupIndex record and sets its fields appropriately.
SeriesChartGroupIndexRecord(short id, short size, byte[] data, int offset)
          Constructs a SeriesChartGroupIndex 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.
 short getChartGroupIndex()
          Get the chart group index field for the SeriesChartGroupIndex record.
 int getRecordSize()
          Size of record (exluding 4 byte header)
 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.
 void setChartGroupIndex(short field_1_chartGroupIndex)
          Set the chart group index field for the SeriesChartGroupIndex record.
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
protected  void validateSid(short id)
          Checks the sid matches the expected side for this record
 
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

SeriesChartGroupIndexRecord

public SeriesChartGroupIndexRecord()

SeriesChartGroupIndexRecord

public SeriesChartGroupIndexRecord(short id,
                                   short size,
                                   byte[] data)
Constructs a SeriesChartGroupIndex record and sets its fields appropriately.
Parameters:
id - id must be 0x1045 or an exception will be throw upon validation
size - size the size of the data area of the record
data - data of the record (should not contain sid/len)

SeriesChartGroupIndexRecord

public SeriesChartGroupIndexRecord(short id,
                                   short size,
                                   byte[] data,
                                   int offset)
Constructs a SeriesChartGroupIndex record and sets its fields appropriately.
Parameters:
id - id must be 0x1045 or an exception will be throw upon validation
size - 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)
Checks the sid matches the expected side for this record
Overrides:
validateSid in class Record
Parameters:
id - the expected sid.

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()
Size of record (exluding 4 byte header)
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

getChartGroupIndex

public short getChartGroupIndex()
Get the chart group index field for the SeriesChartGroupIndex record.

setChartGroupIndex

public void setChartGroupIndex(short field_1_chartGroupIndex)
Set the chart group index field for the SeriesChartGroupIndex record.


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