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 /** 61 * Title: DBCell Record (Currently read only. Not required.) 62 * Description: Used to find rows in blocks...TODO<P> 63 * REFERENCE: PG 299/440 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 64 * @author Andrew C. Oliver (acoliver at apache dot org) 65 * @version 2.0-pre 66 */ 67 68 public class DBCellRecord 69 extends Record 70 { 71 public final static short sid = 0xd7; 72 private int field_1_row_offset; 73 private short[] field_2_cell_offsets; 74 75 public DBCellRecord() 76 { 77 } 78 79 /** 80 * Constructs a DBCellRecord and sets its fields appropriately 81 * 82 * @param id id must be 0xd7 or an exception will be throw upon validation 83 * @param size the size of the data area of the record 84 * @param data data of the record (should not contain sid/len) 85 */ 86 87 public DBCellRecord(short id, short size, byte [] data) 88 { 89 super(id, size, data); 90 } 91 92 /** 93 * Constructs a DBCellRecord and sets its fields appropriately 94 * 95 * @param id id must be 0xd7 or an exception will be throw upon validation 96 * @param size the size of the data area of the record 97 * @param data data of the record (should not contain sid/len) 98 * @param offset of the record's data 99 */ 100 101 public DBCellRecord(short id, short size, byte [] data, int offset) 102 { 103 super(id, size, data, offset); 104 } 105 106 protected void validateSid(short id) 107 { 108 if (id != sid) 109 { 110 throw new RecordFormatException("NOT A valid DBCell RECORD"); 111 } 112 } 113 114 protected void fillFields(byte [] data, short size, int offset) 115 { 116 field_1_row_offset = LittleEndian.getUShort(data, 0 + offset); 117 field_2_cell_offsets = new short[ (size - 4) / 2 ]; 118 int element = 0; 119 120 for (int k = 4; k < data.length; k += 2) 121 { 122 field_2_cell_offsets[ element++ ] = LittleEndian.getShort(data, 123 k + offset); 124 } 125 } 126 127 /** 128 * sets offset from the start of this DBCellRecord to the start of the first cell in 129 * the next DBCell block. 130 * 131 * @param offset offset to the start of the first cell in the next DBCell block 132 */ 133 134 public void setRowOffset(int offset) 135 { 136 field_1_row_offset = offset; 137 } 138 139 // need short list impl. 140 public void addCellOffset(short offset) 141 { 142 if (field_2_cell_offsets == null) 143 { 144 field_2_cell_offsets = new short[ 1 ]; 145 } 146 else 147 { 148 short[] temp = new short[ field_2_cell_offsets.length + 1 ]; 149 150 System.arraycopy(field_2_cell_offsets, 0, temp, 0, 151 field_2_cell_offsets.length); 152 field_2_cell_offsets = temp; 153 } 154 field_2_cell_offsets[ field_2_cell_offsets.length - 1 ] = offset; 155 } 156 157 /** 158 * gets offset from the start of this DBCellRecord to the start of the first cell in 159 * the next DBCell block. 160 * 161 * @return rowoffset to the start of the first cell in the next DBCell block 162 */ 163 164 public int getRowOffset() 165 { 166 return field_1_row_offset; 167 } 168 169 /** 170 * return the cell offset in the array 171 * 172 * @param index of the cell offset to retrieve 173 * @return celloffset from the celloffset array 174 */ 175 176 public short getCellOffsetAt(int index) 177 { 178 return field_2_cell_offsets[ index ]; 179 } 180 181 /** 182 * get the number of cell offsets in the celloffset array 183 * 184 * @return number of cell offsets 185 */ 186 187 public int getNumCellOffsets() 188 { 189 return field_2_cell_offsets.length; 190 } 191 192 public String toString() 193 { 194 StringBuffer buffer = new StringBuffer(); 195 196 buffer.append("[DBCELL]\n"); 197 buffer.append(" .rowoffset = ") 198 .append(Integer.toHexString(getRowOffset())).append("\n"); 199 for (int k = 0; k < getNumCellOffsets(); k++) 200 { 201 buffer.append(" .cell_" + k + " = ") 202 .append(Integer.toHexString(getCellOffsetAt(k))).append("\n"); 203 } 204 buffer.append("[/DBCELL]\n"); 205 return buffer.toString(); 206 } 207 208 public int serialize(int offset, byte [] data) 209 { 210 if (field_2_cell_offsets == null) 211 { 212 field_2_cell_offsets = new short[ 0 ]; 213 } 214 LittleEndian.putShort(data, 0 + offset, sid); 215 LittleEndian.putShort(data, 2 + offset, 216 (( short ) (4 + (getNumCellOffsets() * 2)))); 217 LittleEndian.putInt(data, 4 + offset, getRowOffset()); 218 for (int k = 0; k < getNumCellOffsets(); k++) 219 { 220 LittleEndian.putShort(data, 8 + k + offset, getCellOffsetAt(k)); 221 } 222 return getRecordSize(); 223 } 224 225 public int getRecordSize() 226 { 227 return 8 + (getNumCellOffsets() * 2); 228 } 229 230 public short getSid() 231 { 232 return this.sid; 233 } 234 235 public boolean isInValueSection() 236 { 237 return true; 238 } 239 } 240