Package loci.poi.hssf.record
Class DataFormatRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.DataFormatRecord
The data format record is used to index into a series.
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
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a DataFormat record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortGet the format flags field for the DataFormat record.shortGet the point number field for the DataFormat record.intSize of record (exluding 4 byte header)shortGet the series index field for the DataFormat record.shortGet the series number field for the DataFormat record.shortgetSid()return the non static version of the id for this record.booleanset true to use excel 4 colors.intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetFormatFlags(short field_4_formatFlags) Set the format flags field for the DataFormat record.voidsetPointNumber(short field_1_pointNumber) Set the point number field for the DataFormat record.voidsetSeriesIndex(short field_2_seriesIndex) Set the series index field for the DataFormat record.voidsetSeriesNumber(short field_3_seriesNumber) Set the series number field for the DataFormat record.voidsetUseExcel4Colors(boolean value) Sets the use excel 4 colors field value.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
-
DataFormatRecord
public DataFormatRecord() -
DataFormatRecord
Constructs a DataFormat 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
-
getPointNumber
public short getPointNumber()Get the point number field for the DataFormat record. -
setPointNumber
public void setPointNumber(short field_1_pointNumber) Set the point number field for the DataFormat record. -
getSeriesIndex
public short getSeriesIndex()Get the series index field for the DataFormat record. -
setSeriesIndex
public void setSeriesIndex(short field_2_seriesIndex) Set the series index field for the DataFormat record. -
getSeriesNumber
public short getSeriesNumber()Get the series number field for the DataFormat record. -
setSeriesNumber
public void setSeriesNumber(short field_3_seriesNumber) Set the series number field for the DataFormat record. -
getFormatFlags
public short getFormatFlags()Get the format flags field for the DataFormat record. -
setFormatFlags
public void setFormatFlags(short field_4_formatFlags) Set the format flags field for the DataFormat record. -
setUseExcel4Colors
public void setUseExcel4Colors(boolean value) Sets the use excel 4 colors field value. set true to use excel 4 colors. -
isUseExcel4Colors
public boolean isUseExcel4Colors()set true to use excel 4 colors.- Returns:
- the use excel 4 colors field value.
-