KickJava   Java API By Example, From Geeks To Geeks.

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


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: Interface Header Record<P>
25  * Description: Defines the beginning of Interface records (MMS)<P>
26  * REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
27  * @author Andrew C. Oliver (acoliver at apache dot org)
28  * @version 2.0-pre
29  */
30
31 public class InterfaceHdrRecord
32     extends Record
33 {
34     public final static short sid = 0xe1;
35     private short field_1_codepage; // = 0;
36
37     /**
38      * suggested (and probably correct) default
39      */
40
41     public final static short CODEPAGE = ( short ) 0x4b0;
42
43     public InterfaceHdrRecord()
44     {
45     }
46
47     /**
48      * Constructs an Codepage record and sets its fields appropriately.
49      *
50      * @param id id must be 0xe1 or an exception will be throw upon validation
51      * @param size the size of the data area of the record
52      * @param data data of the record (should not contain sid/len)
53      */
54
55     public InterfaceHdrRecord(short id, short size, byte [] data)
56     {
57         super(id, size, data);
58     }
59
60     /**
61      * Constructs an Codepage record and sets its fields appropriately.
62      *
63      * @param id id must be 0xe1 or an exception will be throw upon validation
64      * @param size the size of the data area of the record
65      * @param data data of the record (should not contain sid/len)
66      * @param offset of the record's data
67      */
68
69     public InterfaceHdrRecord(short id, short size, byte [] data, int offset)
70     {
71         super(id, size, data, offset);
72     }
73
74     protected void validateSid(short id)
75     {
76         if (id != sid)
77         {
78             throw new RecordFormatException("NOT A INTERFACEHDR RECORD");
79         }
80     }
81
82     protected void fillFields(byte [] data, short size, int offset)
83     {
84         field_1_codepage = LittleEndian.getShort(data, 0 + offset);
85     }
86
87     /**
88      * set the codepage for the file
89      *
90      * @param cp - the codepage
91      * @see #CODEPAGE
92      */
93
94     public void setCodepage(short cp)
95     {
96         field_1_codepage = cp;
97     }
98
99     /**
100      * get the codepage for the file
101      *
102      * @return the codepage
103      * @see #CODEPAGE
104      */
105
106     public short getCodepage()
107     {
108         return field_1_codepage;
109     }
110
111     public String JavaDoc toString()
112     {
113         StringBuffer JavaDoc buffer = new StringBuffer JavaDoc();
114
115         buffer.append("[INTERFACEHDR]\n");
116         buffer.append(" .codepage = ")
117             .append(Integer.toHexString(getCodepage())).append("\n");
118         buffer.append("[/INTERFACEHDR]\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, getCodepage());
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