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

DataFormatRecord

public class DataFormatRecord extends Record
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)

Fields Summary
public static final short
sid
private short
field_1_pointNumber
private short
field_2_seriesIndex
private short
field_3_seriesNumber
private short
field_4_formatFlags
private BitField
useExcel4Colors
Constructors Summary
public DataFormatRecord()



     
    

    
public DataFormatRecord(RecordInputStream in)
Constructs a DataFormat record and sets its fields appropriately.

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

        DataFormatRecord rec = new DataFormatRecord();
    
        rec.field_1_pointNumber = field_1_pointNumber;
        rec.field_2_seriesIndex = field_2_seriesIndex;
        rec.field_3_seriesNumber = field_3_seriesNumber;
        rec.field_4_formatFlags = field_4_formatFlags;
        return rec;
    
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_pointNumber            = in.readShort();
        field_2_seriesIndex            = in.readShort();
        field_3_seriesNumber           = in.readShort();
        field_4_formatFlags            = in.readShort();
    
public shortgetFormatFlags()
Get the format flags field for the DataFormat record.

        return field_4_formatFlags;
    
public shortgetPointNumber()
Get the point number field for the DataFormat record.

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

        return 4  + 2 + 2 + 2 + 2;
    
public shortgetSeriesIndex()
Get the series index field for the DataFormat record.

        return field_2_seriesIndex;
    
public shortgetSeriesNumber()
Get the series number field for the DataFormat record.

        return field_3_seriesNumber;
    
public shortgetSid()

        return sid;
    
public booleanisUseExcel4Colors()
set true to use excel 4 colors.

return
the use excel 4 colors field value.

        return useExcel4Colors.isSet(field_4_formatFlags);
    
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_pointNumber);
        LittleEndian.putShort(data, 6 + offset + pos, field_2_seriesIndex);
        LittleEndian.putShort(data, 8 + offset + pos, field_3_seriesNumber);
        LittleEndian.putShort(data, 10 + offset + pos, field_4_formatFlags);

        return getRecordSize();
    
public voidsetFormatFlags(short field_4_formatFlags)
Set the format flags field for the DataFormat record.

        this.field_4_formatFlags = field_4_formatFlags;
    
public voidsetPointNumber(short field_1_pointNumber)
Set the point number field for the DataFormat record.

        this.field_1_pointNumber = field_1_pointNumber;
    
public voidsetSeriesIndex(short field_2_seriesIndex)
Set the series index field for the DataFormat record.

        this.field_2_seriesIndex = field_2_seriesIndex;
    
public voidsetSeriesNumber(short field_3_seriesNumber)
Set the series number field for the DataFormat record.

        this.field_3_seriesNumber = field_3_seriesNumber;
    
public voidsetUseExcel4Colors(boolean value)
Sets the use excel 4 colors field value. set true to use excel 4 colors.

        field_4_formatFlags = useExcel4Colors.setShortBoolean(field_4_formatFlags, value);
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[DATAFORMAT]\n");
        buffer.append("    .pointNumber          = ")
            .append("0x").append(HexDump.toHex(  getPointNumber ()))
            .append(" (").append( getPointNumber() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .seriesIndex          = ")
            .append("0x").append(HexDump.toHex(  getSeriesIndex ()))
            .append(" (").append( getSeriesIndex() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .seriesNumber         = ")
            .append("0x").append(HexDump.toHex(  getSeriesNumber ()))
            .append(" (").append( getSeriesNumber() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("    .formatFlags          = ")
            .append("0x").append(HexDump.toHex(  getFormatFlags ()))
            .append(" (").append( getFormatFlags() ).append(" )");
        buffer.append(System.getProperty("line.separator")); 
        buffer.append("         .useExcel4Colors          = ").append(isUseExcel4Colors()).append('\n"); 

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