1    /* ====================================================================
2     * The Apache Software License, Version 1.1
3     *
4     * Copyright (c) 2002 The Apache Software Foundation.  All rights
5     * reserved.
6     *
7     * Redistribution and use in source and binary forms, with or without
8     * modification, are permitted provided that the following conditions
9     * are met:
10    *
11    * 1. Redistributions of source code must retain the above copyright
12    *    notice, this list of conditions and the following disclaimer.
13    *
14    * 2. Redistributions in binary form must reproduce the above copyright
15    *    notice, this list of conditions and the following disclaimer in
16    *    the documentation and/or other materials provided with the
17    *    distribution.
18    *
19    * 3. The end-user documentation included with the redistribution,
20    *    if any, must include the following acknowledgment:
21    *       "This product includes software developed by the
22    *        Apache Software Foundation (http://www.apache.org/)."
23    *    Alternately, this acknowledgment may appear in the software itself,
24    *    if and wherever such third-party acknowledgments normally appear.
25    *
26    * 4. The names "Apache" and "Apache Software Foundation" and
27    *    "Apache POI" must not be used to endorse or promote products
28    *    derived from this software without prior written permission. For
29    *    written permission, please contact apache@apache.org.
30    *
31    * 5. Products derived from this software may not be called "Apache",
32    *    "Apache POI", nor may "Apache" appear in their name, without
33    *    prior written permission of the Apache Software Foundation.
34    *
35    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46    * SUCH DAMAGE.
47    * ====================================================================
48    *
49    * This software consists of voluntary contributions made by many
50    * individuals on behalf of the Apache Software Foundation.  For more
51    * information on the Apache Software Foundation, please see
52    * <http://www.apache.org/>.
53    */
54   
55   package org.apache.poi.hssf.record.aggregates;
56   
57   import org.apache.poi.hssf.record.*;
58   
59   /**
60    * The formula record aggregate is used to join together the formula record and it's
61    * (optional) string record.
62    *
63    * @author Glen Stampoultzis (glens at apache.org)
64    */
65   public class FormulaRecordAggregate
66           extends Record
67           implements CellValueRecordInterface, Comparable
68   {
69       public final static short sid       = -2000;
70   
71       private FormulaRecord formulaRecord;
72       private StringRecord stringRecord;
73   
74       public FormulaRecordAggregate( FormulaRecord formulaRecord, StringRecord stringRecord )
75       {
76           this.formulaRecord = formulaRecord;
77           this.stringRecord = stringRecord;
78       }
79   
80   
81   
82       protected void validateSid( short id )
83       {
84       }
85   
86       protected void fillFields( byte[] data, short size, int offset )
87       {
88       }
89   
90       /**
91        * called by the class that is responsible for writing this sucker.
92        * Subclasses should implement this so that their data is passed back in a
93        * byte array.
94        *
95        * @param offset to begin writing at
96        * @param data byte array containing instance data
97        * @return number of bytes written
98        */
99   
100      public int serialize( int offset, byte[] data )
101      {
102          int pos = offset;
103          pos += formulaRecord.serialize(pos, data);
104          if (stringRecord != null)
105          {
106              pos += stringRecord.serialize(pos, data);
107          }
108          return pos - offset;
109      }
110  
111      /**
112       * gives the current serialized size of the record. Should include the sid and reclength (4 bytes).
113       */
114      public int getRecordSize()
115      {
116          int size = formulaRecord.getRecordSize() + (stringRecord == null ? 0 : stringRecord.getRecordSize());
117          return size;
118      }
119  
120  
121      /**
122       * return the non static version of the id for this record.
123       */
124      public short getSid()
125      {
126          return sid;
127      }
128  
129      public void setStringRecord( StringRecord stringRecord )
130      {
131          this.stringRecord = stringRecord;
132      }
133  
134      public void setFormulaRecord( FormulaRecord formulaRecord )
135      {
136          this.formulaRecord = formulaRecord;
137      }
138  
139      public FormulaRecord getFormulaRecord()
140      {
141          return formulaRecord;
142      }
143  
144      public StringRecord getStringRecord()
145      {
146          return stringRecord;
147      }
148  
149      public boolean isEqual(CellValueRecordInterface i)
150      {
151          return formulaRecord.isEqual( i );
152      }
153  
154      public boolean isAfter(CellValueRecordInterface i)
155      {
156          return formulaRecord.isAfter( i );
157      }
158  
159      public boolean isBefore(CellValueRecordInterface i)
160      {
161          return formulaRecord.isBefore( i );
162      }
163  
164      public short getXFIndex()
165      {
166          return formulaRecord.getXFIndex();
167      }
168  
169      public void setXFIndex(short xf)
170      {
171          formulaRecord.setXFIndex( xf );
172      }
173  
174      public void setColumn(short col)
175      {
176          formulaRecord.setColumn( col );
177      }
178  
179      public void setRow(int row)
180      {
181          formulaRecord.setRow( row );
182      }
183  
184      public short getColumn()
185      {
186          return formulaRecord.getColumn();
187      }
188  
189      public int getRow()
190      {
191          return formulaRecord.getRow();
192      }
193  
194      public int compareTo(Object o)
195      {
196          return formulaRecord.compareTo( o );
197      }
198  
199      public boolean equals(Object obj)
200      {
201          return formulaRecord.equals( obj );
202      }
203  
204      public String toString()
205      {
206          return formulaRecord.toString();
207      }
208  
209  
210  }
211