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.Record;
59   import org.apache.poi.hssf.record.RowRecord;
60   import org.apache.poi.hssf.record.UnknownRecord;
61   
62   import java.util.Map;
63   import java.util.TreeMap;
64   import java.util.Iterator;
65   import java.util.List;
66   
67   /**
68    *
69    * @author  andy
70    * @author Jason Height (jheight at chariot dot net dot au)
71    */
72   
73   public class RowRecordsAggregate
74       extends Record
75   {
76       int     firstrow = -1;
77       int     lastrow  = -1;
78       Map records  = null;
79       int     size     = 0;
80   
81       /** Creates a new instance of ValueRecordsAggregate */
82   
83       public RowRecordsAggregate()
84       {
85           records = new TreeMap();
86   
87       }
88   
89       public void insertRow(RowRecord row)
90       {
91           size += row.getRecordSize();
92   
93           // Integer integer = new Integer(row.getRowNumber());
94           records.put(row, row);
95           if ((row.getRowNumber() < firstrow) || (firstrow == -1))
96           {
97               firstrow = row.getRowNumber();
98           }
99           if ((row.getRowNumber() > lastrow) || (lastrow == -1))
100          {
101              lastrow = row.getRowNumber();
102          }
103      }
104  
105      public void removeRow(RowRecord row)
106      {
107          size -= row.getRecordSize();
108  
109          // Integer integer = new Integer(row.getRowNumber());
110          records.remove(row);
111      }
112  
113      public RowRecord getRow(int rownum)
114      {
115  
116          // Integer integer = new Integer(rownum);
117          RowRecord row = new RowRecord();
118  
119          row.setRowNumber(( short ) rownum);
120          return ( RowRecord ) records.get(row);
121      }
122  
123      public int getPhysicalNumberOfRows()
124      {
125          return records.size();
126      }
127  
128      public int getFirstRowNum()
129      {
130          return firstrow;
131      }
132  
133      public int getLastRowNum()
134      {
135          return lastrow;
136      }
137  
138      public int construct(int offset, List records)
139      {
140          int k = 0;
141  
142          for (k = offset; k < records.size(); k++)
143          {
144              Record rec = ( Record ) records.get(k);
145  
146              if (!rec.isInValueSection() && !(rec instanceof UnknownRecord))
147              {
148                  break;
149              }
150              if (rec.getSid() == RowRecord.sid)
151              {
152                  insertRow(( RowRecord ) rec);
153              }
154          }
155          return k;
156      }
157  
158      /**
159       * called by the class that is responsible for writing this sucker.
160       * Subclasses should implement this so that their data is passed back in a
161       * byte array.
162       *
163       * @param offset    offset to begin writing at
164       * @param data      byte array containing instance data
165       * @return number of bytes written
166       */
167  
168      public int serialize(int offset, byte [] data)
169      {
170          Iterator itr = records.values().iterator();
171          int      pos = offset;
172  
173          while (itr.hasNext())
174          {
175              pos += (( Record ) itr.next()).serialize(pos, data);
176          }
177          return pos - offset;
178      }
179  
180      /**
181       * called by the constructor, should set class level fields.  Should throw
182       * runtime exception for bad/icomplete data.
183       *
184       * @param data raw data
185       * @param size size of data
186       * @param offset of the record's data (provided a big array of the file)
187       */
188  
189      protected void fillFields(byte [] data, short size, int offset)
190      {
191      }
192  
193      /**
194       * called by constructor, should throw runtime exception in the event of a
195       * record passed with a differing ID.
196       *
197       * @param id alleged id for this record
198       */
199  
200      protected void validateSid(short id)
201      {
202      }
203  
204      /**
205       * return the non static version of the id for this record.
206       */
207  
208      public short getSid()
209      {
210          return -1000;
211      }
212  
213      public int getRecordSize()
214      {
215          return size;
216      }
217  
218      public Iterator getIterator()
219      {
220          return records.values().iterator();
221      }
222      
223      /** Performs a deep clone of the record*/
224      public Object clone() {
225        RowRecordsAggregate rec = new RowRecordsAggregate();
226        for (Iterator rowIter = getIterator(); rowIter.hasNext();) {
227          //return the cloned Row Record & insert
228          RowRecord row = (RowRecord)((RowRecord)rowIter.next()).clone();
229          rec.insertRow(row);
230        }
231        return rec;
232      }
233  
234  }
235  
236