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