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