1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   package org.apache.poi.hssf.record;
57   
58   import org.apache.poi.util.LittleEndian;
59   
60   import java.util.ArrayList;
61   
62   /**
63    * Title:        DBCell Record (Currently read only.  Not required.)
64    * Description:  Used to find rows in blocks...TODO<P>
65    * REFERENCE:  PG 299/440 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P>
66    * @author Andrew C. Oliver (acoliver at apache dot org)
67    * @version 2.0-pre
68    */
69   
70   public class DBCellRecord
71       extends Record
72   {
73       public final static short sid = 0xd7;
74       private int               field_1_row_offset;
75       private short[]           field_2_cell_offsets;
76   
77       public DBCellRecord()
78       {
79       }
80   
81       /**
82        * Constructs a DBCellRecord and sets its fields appropriately
83        *
84        * @param id     id must be 0xd7 or an exception will be throw upon validation
85        * @param size  the size of the data area of the record
86        * @param data  data of the record (should not contain sid/len)
87        */
88   
89       public DBCellRecord(short id, short size, byte [] data)
90       {
91           super(id, size, data);
92       }
93   
94       /**
95        * Constructs a DBCellRecord and sets its fields appropriately
96        *
97        * @param id     id must be 0xd7 or an exception will be throw upon validation
98        * @param size  the size of the data area of the record
99        * @param data  data of the record (should not contain sid/len)
100       * @param offset of the record's data
101       */
102  
103      public DBCellRecord(short id, short size, byte [] data, int offset)
104      {
105          super(id, size, data, offset);
106      }
107  
108      protected void validateSid(short id)
109      {
110          if (id != sid)
111          {
112              throw new RecordFormatException("NOT A valid DBCell RECORD");
113          }
114      }
115  
116      protected void fillFields(byte [] data, short size, int offset)
117      {
118          field_1_row_offset   = LittleEndian.getUShort(data, 0 + offset);
119          field_2_cell_offsets = new short[ (size - 4) / 2 ];
120          int element = 0;
121  
122          for (int k = 4; k < data.length; k += 2)
123          {
124              field_2_cell_offsets[ element++ ] = LittleEndian.getShort(data,
125                      k + offset);
126          }
127      }
128  
129      /**
130       * sets offset from the start of this DBCellRecord to the start of the first cell in
131       * the next DBCell block.
132       *
133       * @param rowoffset to the start of the first cell in the next DBCell block
134       */
135  
136      public void setRowOffset(int offset)
137      {
138          field_1_row_offset = offset;
139      }
140  
141      // need short list impl.
142      public void addCellOffset(short offset)
143      {
144          if (field_2_cell_offsets == null)
145          {
146              field_2_cell_offsets = new short[ 1 ];
147          }
148          else
149          {
150              short[] temp = new short[ field_2_cell_offsets.length + 1 ];
151  
152              System.arraycopy(field_2_cell_offsets, 0, temp, 0,
153                               field_2_cell_offsets.length);
154              field_2_cell_offsets = temp;
155          }
156          field_2_cell_offsets[ field_2_cell_offsets.length - 1 ] = offset;
157      }
158  
159      /**
160       * gets offset from the start of this DBCellRecord to the start of the first cell in
161       * the next DBCell block.
162       *
163       * @return rowoffset to the start of the first cell in the next DBCell block
164       */
165  
166      public int getRowOffset()
167      {
168          return field_1_row_offset;
169      }
170  
171      /**
172       * return the cell offset in the array
173       *
174       * @param index of the cell offset to retrieve
175       * @return celloffset from the celloffset array
176       */
177  
178      public short getCellOffsetAt(int index)
179      {
180          return field_2_cell_offsets[ index ];
181      }
182  
183      /**
184       * get the number of cell offsets in the celloffset array
185       *
186       * @return number of cell offsets
187       */
188  
189      public int getNumCellOffsets()
190      {
191          return field_2_cell_offsets.length;
192      }
193  
194      public String toString()
195      {
196          StringBuffer buffer = new StringBuffer();
197  
198          buffer.append("[DBCELL]\n");
199          buffer.append("    .rowoffset       = ")
200              .append(Integer.toHexString(getRowOffset())).append("\n");
201          for (int k = 0; k < getNumCellOffsets(); k++)
202          {
203              buffer.append("    .cell_" + k + "          = ")
204                  .append(Integer.toHexString(getCellOffsetAt(k))).append("\n");
205          }
206          buffer.append("[/DBCELL]\n");
207          return buffer.toString();
208      }
209  
210      public int serialize(int offset, byte [] data)
211      {
212          if (field_2_cell_offsets == null)
213          {
214              field_2_cell_offsets = new short[ 0 ];
215          }
216          LittleEndian.putShort(data, 0 + offset, sid);
217          LittleEndian.putShort(data, 2 + offset,
218                                (( short ) (4 + (getNumCellOffsets() * 2))));
219          LittleEndian.putInt(data, 4 + offset, getRowOffset());
220          for (int k = 0; k < getNumCellOffsets(); k++)
221          {
222              LittleEndian.putShort(data, 8 + k + offset, getCellOffsetAt(k));
223          }
224          return getRecordSize();
225      }
226  
227      public int getRecordSize()
228      {
229          return 8 + (getNumCellOffsets() * 2);
230      }
231  
232      public short getSid()
233      {
234          return this.sid;
235      }
236  
237      public boolean isInValueSection()
238      {
239          return true;
240      }
241  }
242