src/java/org/apache/poi/hssf/record/NumberRecord.java

   1
   2 /* ====================================================================
   3    Licensed to the Apache Software Foundation (ASF) under one or more
   4    contributor license agreements.  See the NOTICE file distributed with
   5    this work for additional information regarding copyright ownership.
   6    The ASF licenses this file to You under the Apache License, Version 2.0
   7    (the "License"); you may not use this file except in compliance with
   8    the License.  You may obtain a copy of the License at
   9
  10        http://www.apache.org/licenses/LICENSE-2.0
  11
  12    Unless required by applicable law or agreed to in writing, software
  13    distributed under the License is distributed on an "AS IS" BASIS,
  14    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15    See the License for the specific language governing permissions and
  16    limitations under the License.
  17 ==================================================================== */
  18
  19
  20 /*
  21  * NumberRecord.java
  22  *
  23  * Created on October 1, 2001, 8:01 PM
  24  */
  25 package org.apache.poi.hssf.record;
  26
  27 import org.apache.poi.util.LittleEndian;
  28 import org.apache.poi.hssf.record.Record;
  29
  30 /**
  31  * Contains a numeric cell value. <P>
  32  * REFERENCE:  PG 334 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
  33  * @author Andrew C. Oliver (acoliver at apache dot org)
  34  * @author Jason Height (jheight at chariot dot net dot au)
  35  * @version 2.0-pre
  36  */
  37
  38 public class NumberRecord
  39     extends Record
  40     implements CellValueRecordInterface, Comparable
  41 {
  42     public static final short sid = 0x203;
  43     //private short             field_1_row;
  44     private int             field_1_row;
  45     private short             field_2_col;
  46     private short             field_3_xf;
  47     private double            field_4_value;
  48
  49     /** Creates new NumberRecord */
  50     public NumberRecord()
  51     {
  52     }
  53
  54     /**
  55      * Constructs a Number record and sets its fields appropriately.
  56      *
  57      * @param in the RecordInputstream to read the record from
  58      */
  59
  60     public NumberRecord(RecordInputStream in)
  61     {
  62         super(in);
  63     }
  64
  65     /**
  66      * @param in the RecordInputstream to read the record from
  67      */
  68
  69     protected void fillFields(RecordInputStream in)
  70     {
  71         //field_1_row   = LittleEndian.getShort(data, 0 + offset);
  72         field_1_row   = in.readUShort();
  73         field_2_col   = in.readShort();
  74         field_3_xf    = in.readShort();
  75         field_4_value = in.readDouble();
  76     }
  77
  78     //public void setRow(short row)
  79     public void setRow(int row)
  80     {
  81         field_1_row = row;
  82     }
  83
  84     public void setColumn(short col)
  85     {
  86         field_2_col = col;
  87     }
  88
  89     /**
  90      * set the index to the ExtendedFormat
  91      * @see org.apache.poi.hssf.record.ExtendedFormatRecord
  92      * @param xf  index to the XF record
  93      */
  94
  95     public void setXFIndex(short xf)
  96     {
  97         field_3_xf = xf;
  98     }
  99
 100     /**
 101      * set the value for the cell
 102      *
 103      * @param value  double representing the value
 104      */
 105
 106     public void setValue(double value)
 107     {
 108         field_4_value = value;
 109     }
 110
 111     //public short getRow()
 112     public int getRow()
 113     {
 114         return field_1_row;
 115     }
 116
 117     public short getColumn()
 118     {
 119         return field_2_col;
 120     }
 121
 122     /**
 123      * get the index to the ExtendedFormat
 124      * @see org.apache.poi.hssf.record.ExtendedFormatRecord
 125      * @return index to the XF record
 126      */
 127
 128     public short getXFIndex()
 129     {
 130         return field_3_xf;
 131     }
 132
 133     /**
 134      * get the value for the cell
 135      *
 136      * @return double representing the value
 137      */
 138
 139     public double getValue()
 140     {
 141         return field_4_value;
 142     }
 143
 144     public String toString()
 145     {
 146         StringBuffer buffer = new StringBuffer();
 147
 148         buffer.append("[NUMBER]\n");
 149         buffer.append("    .row            = ")
 150             .append(Integer.toHexString(getRow())).append("\n");
 151         buffer.append("    .col            = ")
 152             .append(Integer.toHexString(getColumn())).append("\n");
 153         buffer.append("    .xfindex        = ")
 154             .append(Integer.toHexString(getXFIndex())).append("\n");
 155         buffer.append("    .value          = ").append(getValue())
 156             .append("\n");
 157         buffer.append("[/NUMBER]\n");
 158         return buffer.toString();
 159     }
 160
 161     /**
 162      * called by the class that is responsible for writing this sucker.
 163      * Subclasses should implement this so that their data is passed back in a
 164      * byte array.
 165      *
 166      * @return byte array containing instance data
 167      */
 168
 169     public int serialize(int offset, byte [] data)
 170     {
 171         LittleEndian.putShort(data, 0 + offset, sid);
 172         LittleEndian.putShort(data, 2 + offset, ( short ) 14);
 173         //LittleEndian.putShort(data, 4 + offset, getRow());
 174         LittleEndian.putShort(data, 4 + offset, ( short ) getRow());
 175         LittleEndian.putShort(data, 6 + offset, getColumn());
 176         LittleEndian.putShort(data, 8 + offset, getXFIndex());
 177         LittleEndian.putDouble(data, 10 + offset, getValue());
 178         return getRecordSize();
 179     }
 180
 181     public int getRecordSize()
 182     {
 183         return 18;
 184     }
 185
 186     /**
 187      * called by constructor, should throw runtime exception in the event of a
 188      * record passed with a differing ID.
 189      *
 190      * @param id alleged id for this record
 191      */
 192
 193     protected void validateSid(short id)
 194     {
 195         if (id != sid)
 196         {
 197             throw new RecordFormatException("NOT A Number RECORD");
 198         }
 199     }
 200
 201     public short getSid()
 202     {
 203         return sid;
 204     }
 205
 206     public boolean isBefore(CellValueRecordInterface i)
 207     {
 208         if (this.getRow() > i.getRow())
 209         {
 210             return false;
 211         }
 212         if ((this.getRow() == i.getRow())
 213                 && (this.getColumn() > i.getColumn()))
 214         {
 215             return false;
 216         }
 217         if ((this.getRow() == i.getRow())
 218                 && (this.getColumn() == i.getColumn()))
 219         {
 220             return false;
 221         }
 222         return true;
 223     }
 224
 225     public boolean isAfter(CellValueRecordInterface i)
 226     {
 227         if (this.getRow() < i.getRow())
 228         {
 229             return false;
 230         }
 231         if ((this.getRow() == i.getRow())
 232                 && (this.getColumn() < i.getColumn()))
 233         {
 234             return false;
 235         }
 236         if ((this.getRow() == i.getRow())
 237                 && (this.getColumn() == i.getColumn()))
 238         {
 239             return false;
 240         }
 241         return true;
 242     }
 243
 244     public boolean isEqual(CellValueRecordInterface i)
 245     {
 246         return ((this.getRow() == i.getRow())
 247                 && (this.getColumn() == i.getColumn()));
 248     }
 249
 250     public boolean isInValueSection()
 251     {
 252         return true;
 253     }
 254
 255     public boolean isValue()
 256     {
 257         return true;
 258     }
 259
 260     public int compareTo(Object obj)
 261     {
 262         CellValueRecordInterface loc = ( CellValueRecordInterface ) obj;
 263
 264         if ((this.getRow() == loc.getRow())
 265                 && (this.getColumn() == loc.getColumn()))
 266         {
 267             return 0;
 268         }
 269         if (this.getRow() < loc.getRow())
 270         {
 271             return -1;
 272         }
 273         if (this.getRow() > loc.getRow())
 274         {
 275             return 1;
 276         }
 277         if (this.getColumn() < loc.getColumn())
 278         {
 279             return -1;
 280         }
 281         if (this.getColumn() > loc.getColumn())
 282         {
 283             return 1;
 284         }
 285         return -1;
 286     }
 287
 288     public boolean equals(Object obj)
 289     {
 290         if (!(obj instanceof CellValueRecordInterface))
 291         {
 292             return false;
 293         }
 294         CellValueRecordInterface loc = ( CellValueRecordInterface ) obj;
 295
 296         if ((this.getRow() == loc.getRow())
 297                 && (this.getColumn() == loc.getColumn()))
 298         {
 299             return true;
 300         }
 301         return false;
 302     }
 303
 304     public Object clone() {
 305       NumberRecord rec = new NumberRecord();
 306       rec.field_1_row = field_1_row;
 307       rec.field_2_col = field_2_col;
 308       rec.field_3_xf = field_3_xf;
 309       rec.field_4_value = field_4_value;
 310       return rec;
 311     }
 312 }