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   /*
57    * AttrPtg.java
58    *
59    * Created on November 21, 2001, 1:20 PM
60    */
61   package org.apache.poi.hssf.record.formula;
62   
63   import org.apache.poi.util.LittleEndian;
64   import org.apache.poi.util.BitField;
65   
66   import java.util.List;
67   
68   /**
69    * "Special Attributes"
70    * This seems to be a Misc Stuff and Junk record.  One function it serves is
71    * in SUM functions (i.e. SUM(A1:A3) causes an area PTG then an ATTR with the SUM option set)
72    * @author  andy
73    */
74   
75   public class AttrPtg
76       extends OperationPtg
77   {
78       public final static short sid  = 0x19;
79       private final static int  SIZE = 4;
80       private byte              field_1_options;
81       private short             field_2_data;
82       private BitField          semiVolatile = new BitField(0x01);
83       private BitField          optiIf       = new BitField(0x02);
84       private BitField          optiChoose   = new BitField(0x04);
85       private BitField          optGoto      = new BitField(0x08);
86       private BitField          sum          = new BitField(0x10);
87       private BitField          baxcel       = new BitField(0x20);
88       private BitField          space        = new BitField(0x40);
89   
90       public AttrPtg() {
91       }
92       
93       public AttrPtg(byte [] data, int offset)
94       {
95           offset++;   // adjust past id
96           field_1_options = data[ offset + 0 ];
97           field_2_data    = LittleEndian.getShort(data, offset + 1);
98           System.out.println("OPTIONS = " + Integer.toHexString(getOptions()));
99           System.out.println("OPTIONS & 0x10 = " + (getOptions() & 0x10));
100          System.out.println(toString());
101      }
102  
103      public void setOptions(byte options)
104      {
105          field_1_options = options;
106      }
107  
108      public byte getOptions()
109      {
110          return field_1_options;
111      }
112  
113      public boolean isSemiVolatile()
114      {
115          return semiVolatile.isSet(getOptions());
116      }
117  
118      public boolean isOptimizedIf()
119      {
120          return optiIf.isSet(getOptions());
121      }
122  
123      public boolean isOptimizedChoose()
124      {
125          return optiChoose.isSet(getOptions());
126      }
127  
128      // lets hope no one uses this anymore
129      public boolean isGoto()
130      {
131          return optGoto.isSet(getOptions());
132      }
133  
134      public boolean isSum()
135      {
136          return sum.isSet(getOptions());
137      }
138      
139      public void setSum(boolean bsum) {
140          field_1_options=sum.setByteBoolean(field_1_options,bsum);
141      }
142  
143      // lets hope no one uses this anymore
144      public boolean isBaxcel()
145      {
146          return baxcel.isSet(getOptions());
147      }
148  
149      // biff3&4 only  shouldn't happen anymore
150      public boolean isSpace()
151      {
152          return space.isSet(getOptions());
153      }
154  
155      public void setData(short data)
156      {
157          field_2_data = data;
158      }
159  
160      public short getData()
161      {
162          return field_2_data;
163      }
164  
165      public String toString()
166      {
167          StringBuffer buffer = new StringBuffer();
168  
169          buffer.append("AttrPtg\n");
170          buffer.append("options=").append(field_1_options).append("\n");
171          buffer.append("data   =").append(field_2_data).append("\n");
172          buffer.append("semi   =").append(isSemiVolatile()).append("\n");
173          buffer.append("optimif=").append(isOptimizedIf()).append("\n");
174          buffer.append("optchos=").append(isOptimizedChoose()).append("\n");
175          buffer.append("isGoto =").append(isGoto()).append("\n");
176          buffer.append("isSum  =").append(isSum()).append("\n");
177          buffer.append("isBaxce=").append(isBaxcel()).append("\n");
178          buffer.append("isSpace=").append(isSpace()).append("\n");
179          return buffer.toString();
180      }
181  
182      public void writeBytes(byte [] array, int offset)
183      {
184          array[offset]=sid;
185          array[offset+1]=field_1_options;
186          LittleEndian.putShort(array,offset+2,field_2_data);                
187      }
188  
189      public int getSize()
190      {
191          return SIZE;
192      }
193  
194      public String toFormulaString()
195      {
196          return "SUM()";
197      }
198  
199      public int getNumberOfOperands()
200      {
201          return 1;
202      }
203  
204      public int getType()
205      {
206          return -1;
207      }
208          
209      public String toFormulaString(String[] operands) {
210          return "SUM(" + operands[ 0 ] + ")";
211      }    
212      
213   
214      
215  }
216