KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > poi > hssf > record > PrecisionRecord


1
2 /* ====================================================================
3    Copyright 2002-2004 Apache Software Foundation
4
5    Licensed under the Apache License, Version 2.0 (the "License");
6    you may not use this file except in compliance with the License.
7    You may obtain a copy of the License at
8
9        http://www.apache.org/licenses/LICENSE-2.0
10
11    Unless required by applicable law or agreed to in writing, software
12    distributed under the License is distributed on an "AS IS" BASIS,
13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14    See the License for the specific language governing permissions and
15    limitations under the License.
16 ==================================================================== */
17         
18
19 package org.apache.poi.hssf.record;
20
21 import org.apache.poi.util.LittleEndian;
22
23 /**
24  * Title: Precision Record<P>
25  * Description: defines whether to store with full precision or what's displayed by the gui
26  * (meaning have really screwed up and skewed figures or only think you do!)<P>
27  * REFERENCE: PG 372 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
28  * @author Andrew C. Oliver (acoliver at apache dot org)
29  * @version 2.0-pre
30  */
31
32 public class PrecisionRecord
33     extends Record
34 {
35     public final static short sid = 0xE;
36     public short field_1_precision;
37
38     public PrecisionRecord()
39     {
40     }
41
42     /**
43      * Constructs a Precision record and sets its fields appropriately.
44      *
45      * @param id id must be 0xe or an exception will be throw upon validation
46      * @param size the size of the data area of the record
47      * @param data data of the record (should not contain sid/len)
48      */
49
50     public PrecisionRecord(short id, short size, byte [] data)
51     {
52         super(id, size, data);
53     }
54
55     /**
56      * Constructs a Precision record and sets its fields appropriately.
57      *
58      * @param id id must be 0xe or an exception will be throw upon validation
59      * @param size the size of the data area of the record
60      * @param data data of the record (should not contain sid/len)
61      * @param offset of the record
62      */
63
64     public PrecisionRecord(short id, short size, byte [] data, int offset)
65     {
66         super(id, size, data, offset);
67     }
68
69     protected void validateSid(short id)
70     {
71         if (id != sid)
72         {
73             throw new RecordFormatException("NOT A PRECISION RECORD");
74         }
75     }
76
77     protected void fillFields(byte [] data, short size, int offset)
78     {
79         field_1_precision = LittleEndian.getShort(data, 0 + offset);
80     }
81
82     /**
83      * set whether to use full precision or just skew all you figures all to hell.
84      *
85      * @param fullprecision - or not
86      */
87
88     public void setFullPrecision(boolean fullprecision)
89     {
90         if (fullprecision == true)
91         {
92             field_1_precision = 1;
93         }
94         else
95         {
96             field_1_precision = 0;
97         }
98     }
99
100     /**
101      * get whether to use full precision or just skew all you figures all to hell.
102      *
103      * @return fullprecision - or not
104      */
105
106     public boolean getFullPrecision()
107     {
108         return (field_1_precision == 1);
109     }
110
111     public String JavaDoc toString()
112     {
113         StringBuffer JavaDoc buffer = new StringBuffer JavaDoc();
114
115         buffer.append("[PRECISION]\n");
116         buffer.append(" .precision = ").append(getFullPrecision())
117             .append("\n");
118         buffer.append("[/PRECISION]\n");
119         return buffer.toString();
120     }
121
122     public int serialize(int offset, byte [] data)
123     {
124         LittleEndian.putShort(data, 0 + offset, sid);
125         LittleEndian.putShort(data, 2 + offset,
126                               (( short ) 0x02)); // 2 bytes (6 total)
127 LittleEndian.putShort(data, 4 + offset, field_1_precision);
128         return getRecordSize();
129     }
130
131     public int getRecordSize()
132     {
133         return 6;
134     }
135
136     public short getSid()
137     {
138         return this.sid;
139     }
140 }
141
Popular Tags