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

AxisRecord

public class AxisRecord extends Record
The axis record defines the type of an axis. 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_axisType
public static final short
AXIS_TYPE_CATEGORY_OR_X_AXIS
public static final short
AXIS_TYPE_VALUE_AXIS
public static final short
AXIS_TYPE_SERIES_AXIS
private int
field_2_reserved1
private int
field_3_reserved2
private int
field_4_reserved3
private int
field_5_reserved4
Constructors Summary
public AxisRecord()
public AxisRecord(RecordInputStream in)
Constructs a Axis record and sets its fields appropriately.

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

        AxisRecord rec = new AxisRecord();
    
        rec.field_1_axisType = field_1_axisType;
        rec.field_2_reserved1 = field_2_reserved1;
        rec.field_3_reserved2 = field_3_reserved2;
        rec.field_4_reserved3 = field_4_reserved3;
        rec.field_5_reserved4 = field_5_reserved4;
        return rec;
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_axisType               = in.readShort();
        field_2_reserved1              = in.readInt();
        field_3_reserved2              = in.readInt();
        field_4_reserved3              = in.readInt();
        field_5_reserved4              = in.readInt();
public shortgetAxisType()
Get the axis type field for the Axis record.

return
One of AXIS_TYPE_CATEGORY_OR_X_AXIS AXIS_TYPE_VALUE_AXIS AXIS_TYPE_SERIES_AXIS

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

        return 4  + 2 + 4 + 4 + 4 + 4;
public intgetReserved1()
Get the reserved1 field for the Axis record.

        return field_2_reserved1;
public intgetReserved2()
Get the reserved2 field for the Axis record.

        return field_3_reserved2;
public intgetReserved3()
Get the reserved3 field for the Axis record.

        return field_4_reserved3;
public intgetReserved4()
Get the reserved4 field for the Axis record.

        return field_5_reserved4;
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_axisType);
        LittleEndian.putInt(data, 6 + offset + pos, field_2_reserved1);
        LittleEndian.putInt(data, 10 + offset + pos, field_3_reserved2);
        LittleEndian.putInt(data, 14 + offset + pos, field_4_reserved3);
        LittleEndian.putInt(data, 18 + offset + pos, field_5_reserved4);

        return getRecordSize();
public voidsetAxisType(short field_1_axisType)
Set the axis type field for the Axis record.

param
field_1_axisType One of AXIS_TYPE_CATEGORY_OR_X_AXIS AXIS_TYPE_VALUE_AXIS AXIS_TYPE_SERIES_AXIS

        this.field_1_axisType = field_1_axisType;
public voidsetReserved1(int field_2_reserved1)
Set the reserved1 field for the Axis record.

        this.field_2_reserved1 = field_2_reserved1;
public voidsetReserved2(int field_3_reserved2)
Set the reserved2 field for the Axis record.

        this.field_3_reserved2 = field_3_reserved2;
public voidsetReserved3(int field_4_reserved3)
Set the reserved3 field for the Axis record.

        this.field_4_reserved3 = field_4_reserved3;
public voidsetReserved4(int field_5_reserved4)
Set the reserved4 field for the Axis record.

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

        StringBuffer buffer = new StringBuffer();

        buffer.append("[AXIS]\n");
        buffer.append("    .axisType             = ")
            .append("0x").append(HexDump.toHex(  getAxisType ()))
            .append(" (").append( getAxisType() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .reserved1            = ")
            .append("0x").append(HexDump.toHex(  getReserved1 ()))
            .append(" (").append( getReserved1() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .reserved2            = ")
            .append("0x").append(HexDump.toHex(  getReserved2 ()))
            .append(" (").append( getReserved2() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .reserved3            = ")
            .append("0x").append(HexDump.toHex(  getReserved3 ()))
            .append(" (").append( getReserved3() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .reserved4            = ")
            .append("0x").append(HexDump.toHex(  getReserved4 ()))
            .append(" (").append( getReserved4() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 

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