FileDocCategorySizeDatePackage
MissingRecordAwareHSSFListener.javaAPI DocApache Poi 3.0.18258Sun Jun 17 16:44:38 BST 2007org.apache.poi.hssf.eventusermodel

MissingRecordAwareHSSFListener

public class MissingRecordAwareHSSFListener extends Object implements HSSFListener

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.

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.

Fields Summary
private HSSFListener
childListener
private int
lastSeenRow
private int
lastSeenColumn
Constructors Summary
public MissingRecordAwareHSSFListener(HSSFListener listener)
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

	
	                              	 
	   
		childListener = listener;
Methods Summary
public voidprocessRecord(org.apache.poi.hssf.record.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();
                break;
            case BoolErrRecord.sid:
            	BoolErrRecord berec = (BoolErrRecord) record;
                thisRow = berec.getRow();
                thisColumn = berec.getColumn();
                break;
            case FormulaRecord.sid:
            	FormulaRecord frec = (FormulaRecord) record;
            	thisRow = frec.getRow();
            	thisColumn = frec.getColumn();
                break;
            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();
                break;
            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();
                break;
            default:
            	//System.out.println(record.getClass());
            	break;
        }
		
		// 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);