Author: nick
Date: Fri May 18 06:27:04 2007
New Revision: 539462

URL: http://svn.apache.org/viewvc?view=rev&rev=539462
Log:
Initial version of a Missing Record Aware shim on HSSFListener. Includes 
limited tests, but not yet any documentation

Added:
    jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/
    
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/MissingRecordAwareHSSFListener.java
   (with props)
    
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/
    
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/LastCellOfRowDummyRecord.java
   (with props)
    
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/MissingCellDummyRecord.java
   (with props)
    
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/MissingRowDummyRecord.java
   (with props)
    
jakarta/poi/trunk/src/scratchpad/testcases/org/apache/poi/hssf/data/MissingBits.xls
   (with props)
    
jakarta/poi/trunk/src/scratchpad/testcases/org/apache/poi/hssf/eventusermodel/
    
jakarta/poi/trunk/src/scratchpad/testcases/org/apache/poi/hssf/eventusermodel/TestMissingRecordAwareHSSFListener.java
   (with props)

Added: 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/MissingRecordAwareHSSFListener.java
URL: 
http://svn.apache.org/viewvc/jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/MissingRecordAwareHSSFListener.java?view=auto&rev=539462
==============================================================================
--- 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/MissingRecordAwareHSSFListener.java
 (added)
+++ 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/MissingRecordAwareHSSFListener.java
 Fri May 18 06:27:04 2007
@@ -0,0 +1,199 @@
+/* ====================================================================
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================== */
+
+package org.apache.poi.hssf.eventusermodel;
+
+import org.apache.poi.hssf.eventusermodel.HSSFListener;
+import org.apache.poi.hssf.eventusermodel.dummyrecord.LastCellOfRowDummyRecord;
+import org.apache.poi.hssf.eventusermodel.dummyrecord.MissingCellDummyRecord;
+import org.apache.poi.hssf.eventusermodel.dummyrecord.MissingRowDummyRecord;
+import org.apache.poi.hssf.record.BOFRecord;
+import org.apache.poi.hssf.record.BlankRecord;
+import org.apache.poi.hssf.record.BoolErrRecord;
+import org.apache.poi.hssf.record.BoundSheetRecord;
+import org.apache.poi.hssf.record.FormulaRecord;
+import org.apache.poi.hssf.record.LabelRecord;
+import org.apache.poi.hssf.record.LabelSSTRecord;
+import org.apache.poi.hssf.record.NoteRecord;
+import org.apache.poi.hssf.record.NumberRecord;
+import org.apache.poi.hssf.record.RKRecord;
+import org.apache.poi.hssf.record.Record;
+import org.apache.poi.hssf.record.RowRecord;
+
+/**
+ * <p>A HSSFListener which tracks rows and columns, and will
+ *  trigger your HSSFListener for all rows and cells,
+ *  even the ones that aren't actually stored in the file.</p>
+ * <p>This allows your code to have a more "Excel" like
+ *  view of the data in the file, and not have to worry
+ *  (as much) about if a particular row/cell is in the
+ *  file, or was skipped from being written as it was
+ *  blank.
+ */
+public class MissingRecordAwareHSSFListener implements HSSFListener {
+       private HSSFListener childListener;
+       private int lastSeenRow = -1;
+       private int lastSeenColumn = -1;
+       
+       /**
+        * Constructs a new MissingRecordAwareHSSFListener, which
+        *  will fire processRecord on the supplied child
+        *  HSSFListener for all Records, and missing records.
+        * @param listener The HSSFListener to pass records on to
+        */
+       public MissingRecordAwareHSSFListener(HSSFListener listener) {
+               childListener = listener;
+       }
+
+       public void processRecord(Record record) {
+               int thisRow = -1;
+               int thisColumn = -1;
+               
+               switch (record.getSid())
+        {
+            // the BOFRecord can represent either the beginning of a sheet or 
the workbook
+            case BOFRecord.sid:
+                BOFRecord bof = (BOFRecord) record;
+                if (bof.getType() == bof.TYPE_WORKBOOK)
+                {
+                       // Reset the row and column counts - new workbook
+                       lastSeenRow = -1;
+                       lastSeenColumn = -1;
+                    //System.out.println("Encountered workbook");
+                } else if (bof.getType() == bof.TYPE_WORKSHEET)
+                {
+                       // Reset the row and column counts - new sheet
+                       lastSeenRow = -1;
+                       lastSeenColumn = -1;
+                    //System.out.println("Encountered sheet reference");
+                }
+                break;
+            case BoundSheetRecord.sid:
+                BoundSheetRecord bsr = (BoundSheetRecord) record;
+                System.out.println("New sheet named: " + bsr.getSheetname());
+                break;
+            case RowRecord.sid:
+                RowRecord rowrec = (RowRecord) record;
+                //System.out.println("Row " + rowrec.getRowNumber() + " found, 
first column at "
+                //        + rowrec.getFirstCol() + " last column at " + 
rowrec.getLastCol());
+                
+                // If there's a jump in rows, fire off missing row records
+                if(lastSeenRow+1 < rowrec.getRowNumber()) {
+                       for(int i=(lastSeenRow+1); i<rowrec.getRowNumber(); 
i++) {
+                               MissingRowDummyRecord dr = new 
MissingRowDummyRecord(i);
+                               childListener.processRecord(dr);
+                       }
+                }
+                
+                // Record this as the last row we saw
+                lastSeenRow = rowrec.getRowNumber();
+                break;
+                
+                
+            // These are all the "cell" records
+                
+            case BlankRecord.sid:
+               BlankRecord brec = (BlankRecord) record;
+                thisRow = brec.getRow();
+                thisColumn = brec.getColumn();
+            case BoolErrRecord.sid:
+               BoolErrRecord berec = (BoolErrRecord) record;
+                thisRow = berec.getRow();
+                thisColumn = berec.getColumn();
+            case FormulaRecord.sid:
+               FormulaRecord frec = (FormulaRecord) record;
+               thisRow = frec.getRow();
+               thisColumn = frec.getColumn();
+            case LabelRecord.sid:
+               LabelRecord lrec = (LabelRecord) record;
+                thisRow = lrec.getRow();
+                thisColumn = lrec.getColumn();
+                //System.out.println("Cell found containing String "
+                //        + " at row " + lrec.getRow() + " and column " + 
lrec.getColumn());
+                break;
+            case LabelSSTRecord.sid:
+               LabelSSTRecord lsrec = (LabelSSTRecord) record;
+                thisRow = lsrec.getRow();
+                thisColumn = lsrec.getColumn();
+                //System.out.println("Cell found containing String "
+                //        + " at row " + lsrec.getRow() + " and column " + 
lsrec.getColumn());
+                break;
+            case NoteRecord.sid:
+               NoteRecord nrec = (NoteRecord) record;
+               thisRow = nrec.getRow();
+               thisColumn = nrec.getColumn();
+            case NumberRecord.sid:
+                NumberRecord numrec = (NumberRecord) record;
+                thisRow = numrec.getRow();
+                thisColumn = numrec.getColumn();
+                //System.out.println("Cell found with value " + 
numrec.getValue()
+                //        + " at row " + numrec.getRow() + " and column " + 
numrec.getColumn());
+                break;
+            case RKRecord.sid:
+               RKRecord rkrec = (RKRecord) record;
+               thisRow = rkrec.getRow();
+               thisColumn = rkrec.getColumn();
+            default:
+               //System.out.println(record.getClass());
+               break;
+        }
+       System.out.println(record.getClass());
+               
+               // Do we need to fire dummy end-of-row records?
+               if(thisRow != lastSeenRow) {
+                       for(int i=lastSeenRow; i<thisRow; i++) {
+                               int cols = -1;
+                               if(i == lastSeenRow) {
+                                       cols = lastSeenColumn;
+                               }
+                               LastCellOfRowDummyRecord r = new 
LastCellOfRowDummyRecord(i, cols);
+                               childListener.processRecord(r);
+                       }
+               }
+               // If we've finished with the columns, then fire the final
+               //  dummy end-of-row record
+               if(lastSeenRow != -1 && lastSeenColumn != -1 && thisRow == -1) {
+                       LastCellOfRowDummyRecord r = new 
LastCellOfRowDummyRecord(lastSeenRow, lastSeenColumn);
+                       childListener.processRecord(r);
+                       
+                       lastSeenRow = -1;
+                       lastSeenColumn = -1;
+               }
+               
+               // If we've moved onto a new row, the ensure we re-set
+               //  the column counter
+               if(thisRow != lastSeenRow) {
+                       lastSeenColumn = -1;
+               }
+               
+               // Do we need to fire dummy cell records?
+               if(lastSeenColumn != (thisColumn-1)) {
+                       for(int i=lastSeenColumn+1; i<thisColumn; i++) {
+                               MissingCellDummyRecord r = new 
MissingCellDummyRecord(thisRow, i);
+                               childListener.processRecord(r);
+                       }
+               }
+               
+               // Update cell and row counts if doing cells
+               if(thisColumn != -1) {
+                       lastSeenRow = thisRow;
+                       lastSeenColumn = thisColumn;
+               }
+               
+               childListener.processRecord(record);
+       }
+}

Propchange: 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/MissingRecordAwareHSSFListener.java
------------------------------------------------------------------------------
    svn:eol-style = native

Added: 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/LastCellOfRowDummyRecord.java
URL: 
http://svn.apache.org/viewvc/jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/LastCellOfRowDummyRecord.java?view=auto&rev=539462
==============================================================================
--- 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/LastCellOfRowDummyRecord.java
 (added)
+++ 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/LastCellOfRowDummyRecord.java
 Fri May 18 06:27:04 2007
@@ -0,0 +1,61 @@
+/* ====================================================================
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================== */
+
+package org.apache.poi.hssf.eventusermodel.dummyrecord;
+
+import org.apache.poi.hssf.record.Record;
+import org.apache.poi.hssf.record.RecordInputStream;
+
+/**
+ * A dummy record to indicate that we've now had the last
+ *  cell record for this row.
+ */
+public class LastCellOfRowDummyRecord extends Record {
+       private int row;
+       private int lastColumnNumber;
+       
+       public LastCellOfRowDummyRecord(int row, int lastColumnNumber) {
+               this.row = row;
+               this.lastColumnNumber = lastColumnNumber;
+       }
+       
+       /**
+        * Returns the (0 based) number of the row we are
+        *  currently working on.
+        */
+       public int getRow() { return row; }
+       /**
+        * Returns the (0 based) number of the last column
+        *  seen for this row. You should have already been
+        *  called with that record.
+        * This is -1 in the case of there being no columns
+        *  for the row.
+        */
+       public int getLastColumnNumber() { return lastColumnNumber; }
+       
+       protected void fillFields(RecordInputStream in) {
+       }
+       public short getSid() {
+               return -1;
+       }
+       public int serialize(int offset, byte[] data) {
+               return -1;
+       }
+       protected void validateSid(short id) {
+       }
+
+}

Propchange: 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/LastCellOfRowDummyRecord.java
------------------------------------------------------------------------------
    svn:eol-style = native

Added: 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/MissingCellDummyRecord.java
URL: 
http://svn.apache.org/viewvc/jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/MissingCellDummyRecord.java?view=auto&rev=539462
==============================================================================
--- 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/MissingCellDummyRecord.java
 (added)
+++ 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/MissingCellDummyRecord.java
 Fri May 18 06:27:04 2007
@@ -0,0 +1,49 @@
+/* ====================================================================
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================== */
+
+package org.apache.poi.hssf.eventusermodel.dummyrecord;
+
+import org.apache.poi.hssf.record.Record;
+import org.apache.poi.hssf.record.RecordInputStream;
+
+/**
+ * A dummy record for when we're missing a cell in a row,
+ *  but still want to trigger something
+ */
+public class MissingCellDummyRecord extends Record {
+       private int row;
+       private int column;
+       
+       public MissingCellDummyRecord(int row, int column) {
+               this.row = row;
+               this.column = column;
+       }
+       
+       protected void fillFields(RecordInputStream in) {
+       }
+       public short getSid() {
+               return -1;
+       }
+       public int serialize(int offset, byte[] data) {
+               return -1;
+       }
+       protected void validateSid(short id) {
+       }
+       
+       public int getRow() { return row; }
+       public int getColumn() { return column; }
+}

Propchange: 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/MissingCellDummyRecord.java
------------------------------------------------------------------------------
    svn:eol-style = native

Added: 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/MissingRowDummyRecord.java
URL: 
http://svn.apache.org/viewvc/jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/MissingRowDummyRecord.java?view=auto&rev=539462
==============================================================================
--- 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/MissingRowDummyRecord.java
 (added)
+++ 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/MissingRowDummyRecord.java
 Fri May 18 06:27:04 2007
@@ -0,0 +1,48 @@
+/* ====================================================================
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================== */
+
+package org.apache.poi.hssf.eventusermodel.dummyrecord;
+
+import org.apache.poi.hssf.record.Record;
+import org.apache.poi.hssf.record.RecordInputStream;
+
+/**
+ * A dummy record for when we're missing a row, but still
+ *  want to trigger something
+ */
+public class MissingRowDummyRecord extends Record {
+       private int rowNumber;
+       
+       public MissingRowDummyRecord(int rowNumber) {
+               this.rowNumber = rowNumber;
+       }
+       
+       protected void fillFields(RecordInputStream in) {
+       }
+       public short getSid() {
+               return -1;
+       }
+       public int serialize(int offset, byte[] data) {
+               return -1;
+       }
+       protected void validateSid(short id) {
+       }
+       
+       public int getRowNumber() {
+               return rowNumber;
+       }
+}

Propchange: 
jakarta/poi/trunk/src/scratchpad/src/org/apache/poi/hssf/eventusermodel/dummyrecord/MissingRowDummyRecord.java
------------------------------------------------------------------------------
    svn:eol-style = native

Added: 
jakarta/poi/trunk/src/scratchpad/testcases/org/apache/poi/hssf/data/MissingBits.xls
URL: 
http://svn.apache.org/viewvc/jakarta/poi/trunk/src/scratchpad/testcases/org/apache/poi/hssf/data/MissingBits.xls?view=auto&rev=539462
==============================================================================
Binary file - no diff available.

Propchange: 
jakarta/poi/trunk/src/scratchpad/testcases/org/apache/poi/hssf/data/MissingBits.xls
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: 
jakarta/poi/trunk/src/scratchpad/testcases/org/apache/poi/hssf/eventusermodel/TestMissingRecordAwareHSSFListener.java
URL: 
http://svn.apache.org/viewvc/jakarta/poi/trunk/src/scratchpad/testcases/org/apache/poi/hssf/eventusermodel/TestMissingRecordAwareHSSFListener.java?view=auto&rev=539462
==============================================================================
--- 
jakarta/poi/trunk/src/scratchpad/testcases/org/apache/poi/hssf/eventusermodel/TestMissingRecordAwareHSSFListener.java
 (added)
+++ 
jakarta/poi/trunk/src/scratchpad/testcases/org/apache/poi/hssf/eventusermodel/TestMissingRecordAwareHSSFListener.java
 Fri May 18 06:27:04 2007
@@ -0,0 +1,376 @@
+/* ====================================================================
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================== */
+
+package org.apache.poi.hssf.eventusermodel;
+import org.apache.poi.hssf.eventusermodel.HSSFEventFactory;
+import org.apache.poi.hssf.eventusermodel.HSSFListener;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.util.ArrayList;
+
+import org.apache.poi.hssf.eventusermodel.HSSFRequest;
+import org.apache.poi.hssf.eventusermodel.dummyrecord.LastCellOfRowDummyRecord;
+import org.apache.poi.hssf.eventusermodel.dummyrecord.MissingCellDummyRecord;
+import org.apache.poi.hssf.eventusermodel.dummyrecord.MissingRowDummyRecord;
+import org.apache.poi.hssf.record.LabelSSTRecord;
+import org.apache.poi.hssf.record.Record;
+import org.apache.poi.hssf.record.RowRecord;
+import org.apache.poi.poifs.filesystem.POIFSFileSystem;
+
+import junit.framework.TestCase;
+
+public class TestMissingRecordAwareHSSFListener extends TestCase {
+       private String dirname;
+       
+       public TestMissingRecordAwareHSSFListener() {
+               dirname = System.getProperty("HSSF.testdata.path");
+       }
+       
+       public void testMissingRowRecords() throws Exception {
+               File f = new File(dirname + "/MissingBits.xls");
+               
+               HSSFRequest req = new HSSFRequest();
+               MockHSSFListener mockListen = new MockHSSFListener();
+               MissingRecordAwareHSSFListener listener = new 
MissingRecordAwareHSSFListener(mockListen);
+               req.addListenerForAllRecords(listener);
+               
+               POIFSFileSystem fs = new POIFSFileSystem(new 
FileInputStream(f));
+               HSSFEventFactory factory = new HSSFEventFactory();
+               factory.processWorkbookEvents(req, fs);
+               
+               // Check we got the dummy records
+               Record[] r = (Record[])
+                       mockListen.records.toArray(new 
Record[mockListen.records.size()]);
+               
+               // We have rows 0, 1, 2, 20 and 21
+               int row0 = -1;
+               for(int i=0; i<r.length; i++) {
+                       if(r[i] instanceof RowRecord) {
+                               RowRecord rr = (RowRecord)r[i];
+                               if(rr.getRowNumber() == 0) { row0 = i; }
+                       }
+               }
+               assertTrue(row0 > -1);
+               
+               // Following row 0, we should have 1, 2, then dummy, then 
20+21+22
+               assertTrue(r[row0] instanceof RowRecord);
+               assertTrue(r[row0+1] instanceof RowRecord);
+               assertTrue(r[row0+2] instanceof RowRecord);
+               assertTrue(r[row0+3] instanceof MissingRowDummyRecord);
+               assertTrue(r[row0+4] instanceof MissingRowDummyRecord);
+               assertTrue(r[row0+5] instanceof MissingRowDummyRecord);
+               assertTrue(r[row0+6] instanceof MissingRowDummyRecord);
+               // ...
+               assertTrue(r[row0+18] instanceof MissingRowDummyRecord);
+               assertTrue(r[row0+19] instanceof MissingRowDummyRecord);
+               assertTrue(r[row0+20] instanceof RowRecord);
+               assertTrue(r[row0+21] instanceof RowRecord);
+               assertTrue(r[row0+22] instanceof RowRecord);
+               
+               // Check things had the right row numbers
+               RowRecord rr;
+               rr = (RowRecord)r[row0+2];
+               assertEquals(2, rr.getRowNumber());
+               rr = (RowRecord)r[row0+20];
+               assertEquals(20, rr.getRowNumber());
+               rr = (RowRecord)r[row0+21];
+               assertEquals(21, rr.getRowNumber());
+               
+               MissingRowDummyRecord mr;
+               mr = (MissingRowDummyRecord)r[row0+3];
+               assertEquals(3, mr.getRowNumber());
+               mr = (MissingRowDummyRecord)r[row0+4];
+               assertEquals(4, mr.getRowNumber());
+               mr = (MissingRowDummyRecord)r[row0+5];
+               assertEquals(5, mr.getRowNumber());
+               mr = (MissingRowDummyRecord)r[row0+18];
+               assertEquals(18, mr.getRowNumber());
+               mr = (MissingRowDummyRecord)r[row0+19];
+               assertEquals(19, mr.getRowNumber());
+       }
+       
+       public void testEndOfRowRecords() throws Exception {
+               File f = new File(dirname + "/MissingBits.xls");
+               
+               HSSFRequest req = new HSSFRequest();
+               MockHSSFListener mockListen = new MockHSSFListener();
+               MissingRecordAwareHSSFListener listener = new 
MissingRecordAwareHSSFListener(mockListen);
+               req.addListenerForAllRecords(listener);
+               
+               POIFSFileSystem fs = new POIFSFileSystem(new 
FileInputStream(f));
+               HSSFEventFactory factory = new HSSFEventFactory();
+               factory.processWorkbookEvents(req, fs);
+               
+               // Check we got the dummy records
+               Record[] r = (Record[])
+                       mockListen.records.toArray(new 
Record[mockListen.records.size()]);
+               
+               // Find the cell at 0,0
+               int cell00 = -1;
+               for(int i=0; i<r.length; i++) {
+                       if(r[i] instanceof LabelSSTRecord) {
+                               LabelSSTRecord lr = (LabelSSTRecord)r[i];
+                               if(lr.getRow() == 0 && lr.getColumn() == 0) { 
cell00 = i; }
+                       }
+               }
+               assertTrue(cell00 > -1);
+               
+               // We have rows 0, 1, 2, 20 and 21
+               // Row 0 has 1 entry
+               // Row 1 has 4 entries
+               // Row 2 has 6 entries
+               // Row 20 has 5 entries
+               // Row 21 has 7 entries
+               // Row 22 has 12 entries
+
+               // Row 0
+               assertFalse(r[cell00+0] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+1] instanceof LastCellOfRowDummyRecord);
+               // Row 1
+               assertFalse(r[cell00+2] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+3] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+4] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+5] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+6] instanceof LastCellOfRowDummyRecord);
+               // Row 2
+               assertFalse(r[cell00+7] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+8] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+9] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+10] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+11] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+12] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+13] instanceof LastCellOfRowDummyRecord);
+               // Row 3 -> 19
+               assertTrue(r[cell00+14] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+15] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+16] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+17] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+18] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+19] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+20] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+21] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+22] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+23] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+24] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+25] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+26] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+27] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+28] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+29] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+30] instanceof LastCellOfRowDummyRecord);
+               // Row 20
+               assertFalse(r[cell00+31] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+32] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+33] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+34] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+35] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+36] instanceof LastCellOfRowDummyRecord);
+               // Row 21
+               assertFalse(r[cell00+37] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+38] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+39] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+40] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+41] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+42] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+43] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+44] instanceof LastCellOfRowDummyRecord);
+               // Row 22
+               assertFalse(r[cell00+45] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+46] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+47] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+48] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+49] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+50] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+51] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+52] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+53] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+54] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+55] instanceof LastCellOfRowDummyRecord);
+               assertFalse(r[cell00+56] instanceof LastCellOfRowDummyRecord);
+               assertTrue(r[cell00+57] instanceof LastCellOfRowDummyRecord);
+               
+               // Check the numbers of the last seen columns
+               LastCellOfRowDummyRecord[] lrs = new 
LastCellOfRowDummyRecord[23];
+               int lrscount = 0;
+               for(int i=0; i<r.length; i++) {
+                       if(r[i] instanceof LastCellOfRowDummyRecord) {
+                               lrs[lrscount] = (LastCellOfRowDummyRecord)r[i];
+                               lrscount++;
+                       }
+               }
+               
+               assertEquals(0, lrs[0].getLastColumnNumber());
+               assertEquals(0, lrs[0].getRow());
+               
+               assertEquals(3, lrs[1].getLastColumnNumber());
+               assertEquals(1, lrs[1].getRow());
+               
+               assertEquals(5, lrs[2].getLastColumnNumber());
+               assertEquals(2, lrs[2].getRow());
+               
+               for(int i=3; i<=19; i++) {
+                       assertEquals(-1, lrs[i].getLastColumnNumber());
+                       assertEquals(i, lrs[i].getRow());
+               }
+               
+               assertEquals(4, lrs[20].getLastColumnNumber());
+               assertEquals(20, lrs[20].getRow());
+               
+               assertEquals(6, lrs[21].getLastColumnNumber());
+               assertEquals(21, lrs[21].getRow());
+               
+               assertEquals(11, lrs[22].getLastColumnNumber());
+               assertEquals(22, lrs[22].getRow());
+       }
+       
+       
+       public void testMissingCellRecords() throws Exception {
+               File f = new File(dirname + "/MissingBits.xls");
+               
+               HSSFRequest req = new HSSFRequest();
+               MockHSSFListener mockListen = new MockHSSFListener();
+               MissingRecordAwareHSSFListener listener = new 
MissingRecordAwareHSSFListener(mockListen);
+               req.addListenerForAllRecords(listener);
+               
+               POIFSFileSystem fs = new POIFSFileSystem(new 
FileInputStream(f));
+               HSSFEventFactory factory = new HSSFEventFactory();
+               factory.processWorkbookEvents(req, fs);
+               
+               // Check we got the dummy records
+               Record[] r = (Record[])
+                       mockListen.records.toArray(new 
Record[mockListen.records.size()]);
+               
+               // Find the cell at 0,0
+               int cell00 = -1;
+               for(int i=0; i<r.length; i++) {
+                       if(r[i] instanceof LabelSSTRecord) {
+                               LabelSSTRecord lr = (LabelSSTRecord)r[i];
+                               if(lr.getRow() == 0 && lr.getColumn() == 0) { 
cell00 = i; }
+                       }
+               }
+               assertTrue(cell00 > -1);
+               
+               // We have rows 0, 1, 2, 20 and 21
+               // Row 0 has 1 entry, 0
+               // Row 1 has 4 entries, 0+3
+               // Row 2 has 6 entries, 0+5
+               // Row 20 has 5 entries, 0-5
+               // Row 21 has 7 entries, 0+1+3+5+6
+               // Row 22 has 12 entries, 0+3+4+11
+               
+               // Row 0
+               assertFalse(r[cell00+0] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+1] instanceof MissingCellDummyRecord);
+               
+               // Row 1
+               assertFalse(r[cell00+2] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+3] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+4] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+5] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+6] instanceof MissingCellDummyRecord);
+               
+               // Row 2
+               assertFalse(r[cell00+7] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+8] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+9] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+10] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+11] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+12] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+13] instanceof MissingCellDummyRecord);
+               
+               // Row 3-19
+               assertFalse(r[cell00+14] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+15] instanceof MissingCellDummyRecord);
+               
+               // Row 20
+               assertFalse(r[cell00+31] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+32] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+33] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+34] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+35] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+36] instanceof MissingCellDummyRecord);
+               
+               // Row 21
+               assertFalse(r[cell00+37] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+38] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+39] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+40] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+41] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+42] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+43] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+44] instanceof MissingCellDummyRecord);
+               
+               // Row 22
+               assertFalse(r[cell00+45] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+46] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+47] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+48] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+49] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+50] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+51] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+52] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+53] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+54] instanceof MissingCellDummyRecord);
+               assertTrue(r[cell00+55] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+56] instanceof MissingCellDummyRecord);
+               assertFalse(r[cell00+57] instanceof MissingCellDummyRecord);
+               
+               // Check some numbers
+               MissingCellDummyRecord mc;
+               
+               mc = (MissingCellDummyRecord)r[cell00+3];
+               assertEquals(1, mc.getRow());
+               assertEquals(1, mc.getColumn());
+               mc = (MissingCellDummyRecord)r[cell00+4];
+               assertEquals(1, mc.getRow());
+               assertEquals(2, mc.getColumn());
+               
+               mc = (MissingCellDummyRecord)r[cell00+8];
+               assertEquals(2, mc.getRow());
+               assertEquals(1, mc.getColumn());
+               mc = (MissingCellDummyRecord)r[cell00+9];
+               assertEquals(2, mc.getRow());
+               assertEquals(2, mc.getColumn());
+               
+               mc = (MissingCellDummyRecord)r[cell00+55];
+               assertEquals(22, mc.getRow());
+               assertEquals(10, mc.getColumn());
+       }
+
+       private static class MockHSSFListener implements HSSFListener {
+               private MockHSSFListener() {}
+               private ArrayList records = new ArrayList();
+
+               public void processRecord(Record record) {
+                       records.add(record);
+                       
+                       if(record instanceof MissingRowDummyRecord) {
+                               MissingRowDummyRecord mr = 
(MissingRowDummyRecord)record;
+                               System.out.println("Got dummy row " + 
mr.getRowNumber());
+                       }
+                       if(record instanceof MissingCellDummyRecord) {
+                               MissingCellDummyRecord mc = 
(MissingCellDummyRecord)record;
+                               System.out.println("Got dummy cell " + 
mc.getRow() + " " + mc.getColumn());
+                       }
+                       if(record instanceof LastCellOfRowDummyRecord) {
+                               LastCellOfRowDummyRecord lc = 
(LastCellOfRowDummyRecord)record;
+                               System.out.println("Got end-of row, row was " + 
lc.getRow() + ", last column was " + lc.getLastColumnNumber());
+                       }
+               }
+       }
+}

Propchange: 
jakarta/poi/trunk/src/scratchpad/testcases/org/apache/poi/hssf/eventusermodel/TestMissingRecordAwareHSSFListener.java
------------------------------------------------------------------------------
    svn:eol-style = native



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
Mailing List:    http://jakarta.apache.org/site/mail2.html#poi
The Apache Jakarta POI Project: http://jakarta.apache.org/poi/

Reply via email to