Package loci.poi.hssf.record
Class AxisRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.AxisRecord
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)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final shortstatic final shortstatic final shortstatic final short -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a Axis record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortGet the axis type field for the Axis record.intSize of record (exluding 4 byte header)intGet the reserved1 field for the Axis record.intGet the reserved2 field for the Axis record.intGet the reserved3 field for the Axis record.intGet the reserved4 field for the Axis record.shortgetSid()return the non static version of the id for this record.intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetAxisType(short field_1_axisType) Set the axis type field for the Axis record.voidsetReserved1(int field_2_reserved1) Set the reserved1 field for the Axis record.voidsetReserved2(int field_3_reserved2) Set the reserved2 field for the Axis record.voidsetReserved3(int field_4_reserved3) Set the reserved3 field for the Axis record.voidsetReserved4(int field_5_reserved4) Set the reserved4 field for the Axis record.toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) Checks the sid matches the expected side for this recordMethods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
AXIS_TYPE_CATEGORY_OR_X_AXIS
public static final short AXIS_TYPE_CATEGORY_OR_X_AXIS- See Also:
-
AXIS_TYPE_VALUE_AXIS
public static final short AXIS_TYPE_VALUE_AXIS- See Also:
-
AXIS_TYPE_SERIES_AXIS
public static final short AXIS_TYPE_SERIES_AXIS- See Also:
-
-
Constructor Details
-
AxisRecord
public AxisRecord() -
AxisRecord
Constructs a Axis record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Checks the sid matches the expected side for this record- Specified by:
validateSidin classRecord- Parameters:
id- the expected sid.
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled 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. -
getRecordSize
public int getRecordSize()Size of record (exluding 4 byte header)- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-
getAxisType
public short getAxisType()Get the axis type field for the Axis record.- Returns:
- One of AXIS_TYPE_CATEGORY_OR_X_AXIS AXIS_TYPE_VALUE_AXIS AXIS_TYPE_SERIES_AXIS
-
setAxisType
public void setAxisType(short field_1_axisType) Set the axis type field for the Axis record.- Parameters:
field_1_axisType- One of AXIS_TYPE_CATEGORY_OR_X_AXIS AXIS_TYPE_VALUE_AXIS AXIS_TYPE_SERIES_AXIS
-
getReserved1
public int getReserved1()Get the reserved1 field for the Axis record. -
setReserved1
public void setReserved1(int field_2_reserved1) Set the reserved1 field for the Axis record. -
getReserved2
public int getReserved2()Get the reserved2 field for the Axis record. -
setReserved2
public void setReserved2(int field_3_reserved2) Set the reserved2 field for the Axis record. -
getReserved3
public int getReserved3()Get the reserved3 field for the Axis record. -
setReserved3
public void setReserved3(int field_4_reserved3) Set the reserved3 field for the Axis record. -
getReserved4
public int getReserved4()Get the reserved4 field for the Axis record. -
setReserved4
public void setReserved4(int field_5_reserved4) Set the reserved4 field for the Axis record.
-