Package loci.poi.hssf.record
Class AxisOptionsRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.AxisOptionsRecord
The axis options record provides unit information and other various tidbits about the axis.
NOTE: This source is automatically generated please do not modify this file. Either subclass or
remove the record in src/records/definitions.
- Author:
- Andrew C. Oliver(acoliver at apache.org)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a AxisOptions record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortGet the base unit field for the AxisOptions record.shortGet the crossing point field for the AxisOptions record.shortGet the major unit field for the AxisOptions record.shortGet the major unit value field for the AxisOptions record.shortGet the maximum category field for the AxisOptions record.shortGet the minimum category field for the AxisOptions record.shortGet the minor unit field for the AxisOptions record.shortGet the minor unit value field for the AxisOptions record.shortGet the options field for the AxisOptions record.intSize of record (exluding 4 byte header)shortgetSid()return the non static version of the id for this record.booleanuse the default base unitbooleanuse the default crossing pointbooleanuse default date setttings for this axisbooleanuse the default major unitbooleanuse the default maximum categorybooleanuse the default minimum categorybooleanuse the default minor unitbooleanisIsDate()this is a date axisintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetBaseUnit(short field_7_baseUnit) Set the base unit field for the AxisOptions record.voidsetCrossingPoint(short field_8_crossingPoint) Set the crossing point field for the AxisOptions record.voidsetDefaultBase(boolean value) Sets the default base field value.voidsetDefaultCross(boolean value) Sets the default cross field value.voidsetDefaultDateSettings(boolean value) Sets the default date settings field value.voidsetDefaultMajor(boolean value) Sets the default major field value.voidsetDefaultMaximum(boolean value) Sets the default maximum field value.voidsetDefaultMinimum(boolean value) Sets the default minimum field value.voidsetDefaultMinorUnit(boolean value) Sets the default minor unit field value.voidsetIsDate(boolean value) Sets the isDate field value.voidsetMajorUnit(short field_4_majorUnit) Set the major unit field for the AxisOptions record.voidsetMajorUnitValue(short field_3_majorUnitValue) Set the major unit value field for the AxisOptions record.voidsetMaximumCategory(short field_2_maximumCategory) Set the maximum category field for the AxisOptions record.voidsetMinimumCategory(short field_1_minimumCategory) Set the minimum category field for the AxisOptions record.voidsetMinorUnit(short field_6_minorUnit) Set the minor unit field for the AxisOptions record.voidsetMinorUnitValue(short field_5_minorUnitValue) Set the minor unit value field for the AxisOptions record.voidsetOptions(short field_9_options) Set the options field for the AxisOptions 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:
-
-
Constructor Details
-
AxisOptionsRecord
public AxisOptionsRecord() -
AxisOptionsRecord
Constructs a AxisOptions 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
-
getMinimumCategory
public short getMinimumCategory()Get the minimum category field for the AxisOptions record. -
setMinimumCategory
public void setMinimumCategory(short field_1_minimumCategory) Set the minimum category field for the AxisOptions record. -
getMaximumCategory
public short getMaximumCategory()Get the maximum category field for the AxisOptions record. -
setMaximumCategory
public void setMaximumCategory(short field_2_maximumCategory) Set the maximum category field for the AxisOptions record. -
getMajorUnitValue
public short getMajorUnitValue()Get the major unit value field for the AxisOptions record. -
setMajorUnitValue
public void setMajorUnitValue(short field_3_majorUnitValue) Set the major unit value field for the AxisOptions record. -
getMajorUnit
public short getMajorUnit()Get the major unit field for the AxisOptions record. -
setMajorUnit
public void setMajorUnit(short field_4_majorUnit) Set the major unit field for the AxisOptions record. -
getMinorUnitValue
public short getMinorUnitValue()Get the minor unit value field for the AxisOptions record. -
setMinorUnitValue
public void setMinorUnitValue(short field_5_minorUnitValue) Set the minor unit value field for the AxisOptions record. -
getMinorUnit
public short getMinorUnit()Get the minor unit field for the AxisOptions record. -
setMinorUnit
public void setMinorUnit(short field_6_minorUnit) Set the minor unit field for the AxisOptions record. -
getBaseUnit
public short getBaseUnit()Get the base unit field for the AxisOptions record. -
setBaseUnit
public void setBaseUnit(short field_7_baseUnit) Set the base unit field for the AxisOptions record. -
getCrossingPoint
public short getCrossingPoint()Get the crossing point field for the AxisOptions record. -
setCrossingPoint
public void setCrossingPoint(short field_8_crossingPoint) Set the crossing point field for the AxisOptions record. -
getOptions
public short getOptions()Get the options field for the AxisOptions record. -
setOptions
public void setOptions(short field_9_options) Set the options field for the AxisOptions record. -
setDefaultMinimum
public void setDefaultMinimum(boolean value) Sets the default minimum field value. use the default minimum category -
isDefaultMinimum
public boolean isDefaultMinimum()use the default minimum category- Returns:
- the default minimum field value.
-
setDefaultMaximum
public void setDefaultMaximum(boolean value) Sets the default maximum field value. use the default maximum category -
isDefaultMaximum
public boolean isDefaultMaximum()use the default maximum category- Returns:
- the default maximum field value.
-
setDefaultMajor
public void setDefaultMajor(boolean value) Sets the default major field value. use the default major unit -
isDefaultMajor
public boolean isDefaultMajor()use the default major unit- Returns:
- the default major field value.
-
setDefaultMinorUnit
public void setDefaultMinorUnit(boolean value) Sets the default minor unit field value. use the default minor unit -
isDefaultMinorUnit
public boolean isDefaultMinorUnit()use the default minor unit- Returns:
- the default minor unit field value.
-
setIsDate
public void setIsDate(boolean value) Sets the isDate field value. this is a date axis -
isIsDate
public boolean isIsDate()this is a date axis- Returns:
- the isDate field value.
-
setDefaultBase
public void setDefaultBase(boolean value) Sets the default base field value. use the default base unit -
isDefaultBase
public boolean isDefaultBase()use the default base unit- Returns:
- the default base field value.
-
setDefaultCross
public void setDefaultCross(boolean value) Sets the default cross field value. use the default crossing point -
isDefaultCross
public boolean isDefaultCross()use the default crossing point- Returns:
- the default cross field value.
-
setDefaultDateSettings
public void setDefaultDateSettings(boolean value) Sets the default date settings field value. use default date setttings for this axis -
isDefaultDateSettings
public boolean isDefaultDateSettings()use default date setttings for this axis- Returns:
- the default date settings field value.
-