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: Function Group Count Record<P> 62 * Description: Number of built in function groups in the current version of the 63 * Spreadsheet (probably only used on Windoze)<P> 64 * REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<P> 65 * @author Andrew C. Oliver (acoliver at apache dot org) 66 * @version 2.0-pre 67 */ 68 69 public class FnGroupCountRecord 70 extends Record 71 { 72 public final static short sid = 0x9c; 73 74 /** 75 * suggested default (14 dec) 76 */ 77 78 public final static short COUNT = 14; 79 private short field_1_count; 80 81 public FnGroupCountRecord() 82 { 83 } 84 85 /** 86 * Constructs a FnGroupCount record and sets its fields appropriately. 87 * 88 * @param id id must be 0x9c or an exception will be throw upon validation 89 * @param size the size of the data area of the record 90 * @param data data of the record (should not contain sid/len) 91 */ 92 93 public FnGroupCountRecord(short id, short size, byte [] data) 94 { 95 super(id, size, data); 96 } 97 98 /** 99 * Constructs a FnGroupCount record and sets its fields appropriately. 100 * 101 * @param id id must be 0x9c or an exception will be throw upon validation 102 * @param size the size of the data area of the record 103 * @param data data of the record (should not contain sid/len) 104 * @param offset of the record's data 105 */ 106 107 public FnGroupCountRecord(short id, short size, byte [] data, int offset) 108 { 109 super(id, size, data, offset); 110 } 111 112 protected void validateSid(short id) 113 { 114 if (id != sid) 115 { 116 throw new RecordFormatException("NOT A FNGROUPCOUNT RECORD"); 117 } 118 } 119 120 protected void fillFields(byte [] data, short size, int offset) 121 { 122 field_1_count = LittleEndian.getShort(data, 0 + offset); 123 } 124 125 /** 126 * set the number of built-in functions 127 * 128 * @param count - number of functions 129 */ 130 131 public void setCount(short count) 132 { 133 field_1_count = count; 134 } 135 136 /** 137 * get the number of built-in functions 138 * 139 * @return number of built-in functions 140 */ 141 142 public short getCount() 143 { 144 return field_1_count; 145 } 146 147 public String toString() 148 { 149 StringBuffer buffer = new StringBuffer(); 150 151 buffer.append("[FNGROUPCOUNT]\n"); 152 buffer.append(" .count = ").append(getCount()) 153 .append("\n"); 154 buffer.append("[/FNGROUPCOUNT]\n"); 155 return buffer.toString(); 156 } 157 158 public int serialize(int offset, byte [] data) 159 { 160 LittleEndian.putShort(data, 0 + offset, sid); 161 LittleEndian.putShort(data, 2 + offset, 162 (( short ) 0x02)); // 2 bytes (6 total) 163 LittleEndian.putShort(data, 4 + offset, getCount()); 164 return getRecordSize(); 165 } 166 167 public int getRecordSize() 168 { 169 return 6; 170 } 171 172 public short getSid() 173 { 174 return this.sid; 175 } 176 } 177