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.aggregates;
57   
58   import org.apache.poi.hssf.record.*;
59   
60   import java.util.Iterator;
61   import java.util.List;
62   import java.util.TreeMap;
63   
64   /**
65    *
66    * Aggregate value records together.  Things are easier to handle that way.
67    *
68    * @author  andy
69    * @author  Glen Stampoultzis (glens at apache.org)
70    * @author Jason Height (jheight at chariot dot net dot au)
71    */
72   
73   public class ValueRecordsAggregate
74       extends Record
75   {
76       public final static short sid       = -1000;
77       int                       firstcell = -1;
78       int                       lastcell  = -1;
79       TreeMap                   records   = null;
80   //    int                       size      = 0;
81   
82       /** Creates a new instance of ValueRecordsAggregate */
83   
84       public ValueRecordsAggregate()
85       {
86           records = new TreeMap();
87       }
88   
89       public void insertCell(CellValueRecordInterface cell)
90       {
91   /*        if (records.get(cell) == null)
92           {
93               size += (( Record ) cell).getRecordSize();
94           }
95           else
96           {
97               size += (( Record ) cell).getRecordSize()
98                       - (( Record ) records.get(cell)).getRecordSize();
99           }*/
100  
101          // XYLocator xy = new XYLocator(cell.getRow(), cell.getColumn());
102          Object o = records.put(cell, cell);
103  
104          if ((cell.getColumn() < firstcell) || (firstcell == -1))
105          {
106              firstcell = cell.getColumn();
107          }
108          if ((cell.getColumn() > lastcell) || (lastcell == -1))
109          {
110              lastcell = cell.getColumn();
111          }
112      }
113  
114      public void removeCell(CellValueRecordInterface cell)
115      {
116    //      size -= (( Record ) cell).getRecordSize();
117  
118          // XYLocator xy = new XYLocator(cell.getRow(), cell.getColumn());
119          records.remove(cell);
120      }
121  
122      public int getPhysicalNumberOfCells()
123      {
124          return records.size();
125      }
126  
127      public int getFirstCellNum()
128      {
129          return firstcell;
130      }
131  
132      public int getLastCellNum()
133      {
134          return lastcell;
135      }
136  
137      public int construct(int offset, List records)
138      {
139          int k = 0;
140  
141          FormulaRecordAggregate lastFormulaAggregate = null;
142  
143          for (k = offset; k < records.size(); k++)
144          {
145              Record rec = ( Record ) records.get(k);
146  
147              if (rec instanceof StringRecord == false && !rec.isInValueSection() && !(rec instanceof UnknownRecord))
148              {
149                  break;
150              }
151              if (rec instanceof FormulaRecord)
152              {
153                  lastFormulaAggregate = new FormulaRecordAggregate((FormulaRecord)rec, null);
154                  insertCell( lastFormulaAggregate );
155              }
156              else if (rec instanceof StringRecord)
157              {
158                  lastFormulaAggregate.setStringRecord((StringRecord)rec);
159              }
160              else if (rec.isValue())
161              {
162                  insertCell(( CellValueRecordInterface ) rec);
163              }
164          }
165          return k;
166      }
167  
168      /**
169       * called by the class that is responsible for writing this sucker.
170       * Subclasses should implement this so that their data is passed back in a
171       * byte array.
172       *
173       * @param offset to begin writing at
174       * @param data byte array containing instance data
175       * @return number of bytes written
176       */
177  
178      public int serialize(int offset, byte [] data)
179      {
180          Iterator itr = records.values().iterator();
181          int      pos = offset;
182  
183          while (itr.hasNext())
184          {
185              pos += (( Record ) itr.next()).serialize(pos, data);
186          }
187          return pos - offset;
188      }
189      /**
190       * called by the constructor, should set class level fields.  Should throw
191       * runtime exception for bad/icomplete data.
192       *
193       * @param data raw data
194       * @param size size of data
195       * @param offset of the record's data (provided a big array of the file)
196       */
197  
198      protected void fillFields(byte [] data, short size, int offset)
199      {
200      }
201  
202      /**
203       * called by constructor, should throw runtime exception in the event of a
204       * record passed with a differing ID.
205       *
206       * @param id alleged id for this record
207       */
208  
209      protected void validateSid(short id)
210      {
211      }
212  
213      /**
214       * return the non static version of the id for this record.
215       */
216  
217      public short getSid()
218      {
219          return sid;
220      }
221  
222      public int getRecordSize() {
223      
224          int size = 0;
225          Iterator irecs = records.values().iterator();
226          
227          while (irecs.hasNext()) {
228                  size += (( Record ) irecs.next()).getRecordSize();
229          }
230  
231          return size;
232  //        return size;
233      }
234  
235      public Iterator getIterator()
236      {
237          return records.values().iterator();
238      }
239  
240      /** Performs a deep clone of the record*/
241      public Object clone() {
242        ValueRecordsAggregate rec = new ValueRecordsAggregate();
243        for (Iterator valIter = getIterator(); valIter.hasNext();) {
244          CellValueRecordInterface val = (CellValueRecordInterface)((CellValueRecordInterface)valIter.next()).clone();
245          rec.insertCell(val);
246        }
247        return rec;
248      }
249  }
250  
251  /*
252   * class XYLocator implements Comparable {
253   *   private int row = 0;
254   *   private int col = 0;
255   *   public XYLocator(int row, int col) {
256   *       this.row = row;
257   *       this.col = col;
258   *   }
259   *
260   *   public int getRow() {
261   *       return row;
262   *   }
263   *
264   *   public int getCol() {
265   *       return col;
266   *   }
267   *
268   *   public int compareTo(Object obj) {
269   *        XYLocator loc = (XYLocator)obj;
270   *
271   *        if (this.getRow() == loc.getRow() &&
272   *            this.getCol() == loc.getCol() )
273   *               return 0;
274   *
275   *        if (this.getRow() < loc.getRow())
276   *               return -1;
277   *
278   *        if (this.getRow() > loc.getRow())
279   *               return 1;
280   *
281   *        if (this.getCol() < loc.getCol())
282   *               return -1;
283   *
284   *        if (this.getCol() > loc.getCol())
285   *               return 1;
286   *
287   *        return -1;
288   *
289   *   }
290   *
291   *   public boolean equals(Object obj) {
292   *       if (!(obj instanceof XYLocator)) return false;
293   *
294   *       XYLocator loc = (XYLocator)obj;
295   *       if (this.getRow() == loc.getRow()
296   *             &&
297   *           this.getCol() == loc.getCol()
298   *           ) return true;
299   *      return false;
300   *   }
301   *
302   *
303   * }
304   */
305