Attachment #34757 for bug #60707

View | Details | Raw Unified | Return to bug 60707
Collapse All | Expand All




/* ====================================================================
   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.xssf.streaming.reader;

import java.util.Calendar;
import java.util.Date;

import org.apache.poi.ss.formula.FormulaParseException;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.CellType;
import org.apache.poi.ss.usermodel.Comment;
import org.apache.poi.ss.usermodel.Hyperlink;
import org.apache.poi.ss.usermodel.RichTextString;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.util.CellAddress;
import org.apache.poi.ss.util.CellRangeAddress;

/**
 * Represents cell in a row
 * Value of cell is represented as a string.
 *
 */
public class StreamedCell  implements Cell{
	private String value;
	private int cellNumber;
	
	public StreamedCell(){
		
	}

	/**
	 * <pre>
	 * Return cell value
	 * </pre>
	 * Return the value of a cell in String format.
	 * Value will be same as how it is represented in excel.
	 * @return String
	 */
	public String getValue() {
		return value;
	}

	public void setValue(String value) {
		this.value = value;
	}
	
	public String toString(){
		return value;
	}

	/**
	 * <pre>
	 * Returns the cell number
	 * </pre>
	 *
	 * @return
	 */
    public int getCellNumber() {
        return cellNumber;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * @param cellNumber
     */
    public void setCellNumber(int cellNumber) {
        this.cellNumber = cellNumber;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public int getColumnIndex() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public int getRowIndex() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public Sheet getSheet() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public Row getRow() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * @param cellNumber
     */    
    public void setCellType(int cellType) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * @param cellNumber
     */
    public void setCellType(CellType cellType) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public int getCellType() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public CellType getCellTypeEnum() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public int getCachedFormulaResultType() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public CellType getCachedFormulaResultTypeEnum() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * @param cellNumber
     */
    public void setCellValue(double value) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * @param cellNumber
     */
    public void setCellValue(Date value) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * @param cellNumber
     */
    public void setCellValue(Calendar value) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * @param cellNumber
     */
    public void setCellValue(RichTextString value) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * @param cellNumber
     */
    public void setCellValue(String value) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * @param cellNumber
     */
    public void setCellFormula(String formula) throws FormulaParseException {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public String getCellFormula() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public double getNumericCellValue() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public Date getDateCellValue() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public RichTextString getRichStringCellValue() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     *  Returns the String value of cell content
     *  </pre>
     */
    public String getStringCellValue() {
        return value;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * 
     */
    public void setCellValue(boolean value) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * 
     */
    public void setCellErrorValue(byte value) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean getBooleanCellValue() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public byte getErrorCellValue() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * 
     */
    public void setCellStyle(CellStyle style) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public CellStyle getCellStyle() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * 
     */
    public void setAsActiveCell() {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public CellAddress getAddress() {
        // TODO Auto-generated method stub
        return null;
    }
    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * 
     */
    public void setCellComment(Comment comment) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public Comment getCellComment() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * 
     */
    public void removeCellComment() {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public Hyperlink getHyperlink() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * 
     */
    public void setHyperlink(Hyperlink link) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     *</pre>
     * 
     */
    public void removeHyperlink() {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public CellRangeAddress getArrayFormulaRange() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean isPartOfArrayFormulaGroup() {
        // TODO Auto-generated method stub
        return false;
    }

	/*@Override
	protected void finalize() throws Throwable {
		super.finalize();
		value = null;
	}*/
	
	
	
}




/* ====================================================================
   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.xssf.streaming.reader;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.CellType;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;


/**
 * Represents an excel row
 *
 */
public class StreamedRow implements Row{
	private List<StreamedCell> cells;
	private int rowNumber;

	public StreamedRow(int rowNumber) {
		this.rowNumber = rowNumber;
	}

	/**
	 * <pre>
	 * Used to get cells of a Row
	 * </pre>
	 * @return Iterator<Cell>
	 */
	public Iterator<StreamedCell> getCellIterator() {
		if (cells == null) {
			cells = new ArrayList<StreamedCell>();
		}
		return cells.iterator();
	}
	
	/**
	 * <pre>
	 * 	Returns the row number
	 * </pre>
	 * @return int
	 */
	public int getRowNum() {
		return rowNumber;
	}

	public void setRowNum(int rowNumber) {
		this.rowNumber = rowNumber;
	}

	public String toString() {
		StringBuffer sb = new StringBuffer(250);
		sb.append("Row Number:").append(rowNumber);
		sb.append(" --> ");
		if (cells != null) {
			for (StreamedCell cell : cells) {
				sb.append(cell.toString());
				sb.append(" | ");
			}
		}

		return sb.toString();
	}

/*	@Override
	protected void finalize() throws Throwable {
		super.finalize();
		if (cells != null) {
			cells.clear();
			cells = null;
		}
	}*/

	public List<StreamedCell> getCells() {
		if (cells == null) {
			cells = new ArrayList<StreamedCell>();
		}
		return cells;
	}

/**
 * <pre>
 * Will not be supported. User getCellIterator() instead
 * </pre>	
 */
public Iterator<Cell> iterator() {
    // TODO Auto-generated method stub
    return null;
}

/**
 * <pre>
 * Not supported right now, as StreamedWorkbook
 * supports only reading.
 * </pre>
 * 
 */
public Cell createCell(int column) {
    // TODO Auto-generated method stub
    return null;
}

/**
 * <pre>
 * Not supported right now, as StreamedWorkbook
 * supports only reading.
 * </pre>
 * 
 */
public Cell createCell(int column, int type) {
    // TODO Auto-generated method stub
    return null;
}

/**
 * <pre>
 * Not supported right now, as StreamedWorkbook
 * supports only reading.
 * </pre>
 * 
 */
public Cell createCell(int column, CellType type) {
    // TODO Auto-generated method stub
    return null;
}

/**
 * <pre>
 * Not supported right now, as StreamedWorkbook
 * supports only reading.
 * </pre>
 * 
 */
public void removeCell(Cell cell) {
    // TODO Auto-generated method stub
    
}

/**
 * <pre>
 *  Returns the cell on specified cell number
 * </pre>
 */
public Cell getCell(int cellnum) {
    StreamedCell cell = null;
    
    if(cells != null){
        cell = cells.get(cellnum);
    }
    
    return cell;
}

/**
 *  <pre>
 * Will be supported in future.
 *  </pre>
 */
public Cell getCell(int cellnum, MissingCellPolicy policy) {
    // TODO Auto-generated method stub
    return null;
}

public short getFirstCellNum() {
    short firstCellNumber = -1;
    
    if(cells != null && cells.size() > 0){
       firstCellNumber = (short)cells.get(0).getCellNumber();
    }
    
    return firstCellNumber;
}

public short getLastCellNum() {
    short lastCellNumber = -1;
    
    if(cells != null && cells.size() > 0){
        lastCellNumber = (short)cells.get((cells.size()-1)).getCellNumber();
    }
    
    return lastCellNumber;
}

/**
 *  <pre>
 * Will be supported in future.
 *  </pre>
 */
public int getPhysicalNumberOfCells() {
    // TODO Auto-generated method stub
    return 0;
}

/**
 * <pre>
 * Not supported right now, as StreamedWorkbook
 * supports only reading.
 * </pre>
 * 
 */
public void setHeight(short height) {
    // TODO Auto-generated method stub
    
}

/**
 * <pre>
 * Not supported right now, as StreamedWorkbook
 * supports only reading.
 * </pre>
 * 
 */
public void setZeroHeight(boolean zHeight) {
    // TODO Auto-generated method stub
    
}

/**
 *  <pre>
 * Will be supported in future.
 *  </pre>
 */
public boolean getZeroHeight() {
    // TODO Auto-generated method stub
    return false;
}

/**
 * <pre>
 * Not supported right now, as StreamedWorkbook
 * supports only reading.
 * </pre>
 * 
 */
public void setHeightInPoints(float height) {
    // TODO Auto-generated method stub
    
}

/**
 *  <pre>
 * Will be supported in future.
 *  </pre>
 */
public short getHeight() {
    // TODO Auto-generated method stub
    return 0;
}

/**
 *  <pre>
 * Will be supported in future.
 *  </pre>
 */
public float getHeightInPoints() {
    // TODO Auto-generated method stub
    return 0;
}

/**
 *  <pre>
 * Will be supported in future.
 *  </pre>
 */
public boolean isFormatted() {
    // TODO Auto-generated method stub
    return false;
}

/**
 *  <pre>
 * Will be supported in future.
 *  </pre>
 */
public CellStyle getRowStyle() {
    // TODO Auto-generated method stub
    return null;
}

/**
 * <pre>
 * Not supported right now, as StreamedWorkbook
 * supports only reading.
 * </pre>
 * 
 */
public void setRowStyle(CellStyle style) {
    // TODO Auto-generated method stub
    
}

/**
 * <pre>
 * Not supported right now. Use getCellIterator instead
 * </pre>
 */
public Iterator<Cell> cellIterator() {
    // TODO Auto-generated method stub
    return null;
}

/**
 *  <pre>
 * Will be supported in future.
 *  </pre>
 */
public Sheet getSheet() {
    // TODO Auto-generated method stub
    return null;
}

/**
 *  <pre>
 * Will be supported in future.
 *  </pre>
 */
public int getOutlineLevel() {
    // TODO Auto-generated method stub
    return 0;
}


}




/* ====================================================================
   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.xssf.streaming.reader;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import javax.xml.stream.XMLEventReader;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.events.XMLEvent;

import org.apache.poi.ss.usermodel.AutoFilter;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellRange;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.Comment;
import org.apache.poi.ss.usermodel.DataValidation;
import org.apache.poi.ss.usermodel.DataValidationHelper;
import org.apache.poi.ss.usermodel.Drawing;
import org.apache.poi.ss.usermodel.Footer;
import org.apache.poi.ss.usermodel.Header;
import org.apache.poi.ss.usermodel.Hyperlink;
import org.apache.poi.ss.usermodel.PrintSetup;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.SheetConditionalFormatting;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.util.CellAddress;
import org.apache.poi.ss.util.CellRangeAddress;
import org.apache.poi.ss.util.PaneInformation;
import org.apache.poi.xssf.model.SharedStringsTable;
import org.apache.poi.xssf.model.StylesTable;

/**
 * Represents an excel sheet.
 *
 */
public class StreamedSheet implements Sheet{
	private XMLEventReader xmlParser;
	private SharedStringsTable sharedStringsTable;
	private StylesTable stylesTable;
	private int numberOfColumns;
	private int sheetNumber;
	private StreamedSheetEventHandler eventHandler = null;
	
	/**
	 * <pre>
	 * Fetch all rows from the excel.
	 * </pre>
	 * 
	 * This method consumes only less memory, but it is 
	 * advisable to use it only for small excel files, since 
	 * it will fetch all rows in a single call.
	 * 
	 * @return Iterator<Row>
	 * @throws XMLStreamException
	 */
	public Iterator<StreamedRow> getAllRows() throws XMLStreamException{
		return getAllRows(this, sharedStringsTable, stylesTable);
	}
	
	/**
	 * <pre>
	 * Used to fetch N number of rows.
	 * </pre>
	 * 
	 * Recommended method to reduce memory utilization.
	 * It allows to read big excel files in batch.
	 * This gives control to the user to process the records already fetched, 
	 * before fetching next set of records.
	 * After reading N records, invoke the same method with number of rows to be
	 * fetched to get the next set of rows.
	 * <br>
	 * 
	 * *********************Usage****************************
	 * Iterator<StreamedRow> rows = sheet.getNRows(1);
	 * <br>
	 * while(rows.hasNext()){ //read the first 1 row
	 * <br>
	 *     StreamedRow row = rows.next();
	 * <br>
	 * }
	 *  <br>
	 * rows = sheet.getNRows(10);
	 *  <br>
     * while(rows.hasNext()){ //read the next 10 rows
     *  <br>
     *     StreamedRow row = rows.next();
     *  <br>
     * }
	 * 
	 * @param numberOfRows
	 * @return Iterator<Row>
	 * @throws XMLStreamException
	 */
	public Iterator<StreamedRow> getNRows(int numberOfRows) throws XMLStreamException{
		return getNRows(this, eventHandler, numberOfRows);
	}

	public boolean hasMoreRows(){
		return xmlParser.hasNext();
	}
	
	
	public XMLEventReader getXmlParser() {
		return xmlParser;
	}

	public void setXmlParser(XMLEventReader xmlParser) {
		this.xmlParser = xmlParser;
	}

	public void setSharedStringsTable(SharedStringsTable sharedStringsTable) {
		this.sharedStringsTable = sharedStringsTable;
	}

	public void setStylesTable(StylesTable stylesTable) {
		this.stylesTable = stylesTable;
	}
	
	public void createEventHandler(){
		eventHandler = new StreamedSheetEventHandler(sharedStringsTable, stylesTable);
	}


	public int getNumberOfColumns() {
		return numberOfColumns;
	}


	public void setNumberOfColumns(int numberOfColumns) {
		this.numberOfColumns = numberOfColumns;
	}


	public int getSheetNumber() {
		return sheetNumber;
	}


	public void setSheetNumber(int sheetNumber) {
		this.sheetNumber = sheetNumber;
	}

/*	@Override
	protected void finalize() throws Throwable {
		super.finalize();
		
		xmlParser = null;
		sharedStringsTable = null;
		stylesTable = null;
		eventHandler = null;
		
	}*/
	
	 /**
     * reads all data from sheet
     * @param xmlParser
     * @param sharedStringsTable
     * @param stylesTable
     * @return
     * @throws XMLStreamException 
     */
    private Iterator<StreamedRow> getAllRows(StreamedSheet sheet,
            SharedStringsTable sharedStringsTable, StylesTable stylesTable) throws XMLStreamException {
        List<StreamedRow> dataList = new ArrayList<StreamedRow>();
        StreamedSheetEventHandler eventHandler = new StreamedSheetEventHandler(sharedStringsTable, stylesTable);
        while(sheet.getXmlParser().hasNext()){
            XMLEvent event = sheet.getXmlParser().nextEvent();  
            eventHandler.handleEvent(event);
            if(eventHandler.isEndOfRow()){
                dataList.add(eventHandler.getRow());
                eventHandler.setEndOfRow(false);
            }
            sheet.setNumberOfColumns(eventHandler.getNumberOfColumns());
        }
        
        return dataList.iterator();
    }
    
    /**
     * Reads N Rows from excel
     * @param sheet
     * @param sharedStringsTable
     * @param stylesTable
     * @param numberOFRows
     * @return
     * @throws XMLStreamException
     */
    private Iterator<StreamedRow> getNRows(StreamedSheet sheet, StreamedSheetEventHandler eventHandler, int numberOfRows) throws XMLStreamException {
        List<StreamedRow> dataList = new ArrayList<StreamedRow>();      
        while(sheet.getXmlParser().hasNext()){
            XMLEvent event = sheet.getXmlParser().nextEvent();  
            eventHandler.handleEvent(event);
            if(eventHandler.isEndOfRow()){
                dataList.add(eventHandler.getRow());
                eventHandler.setEndOfRow(false);
            }
            sheet.setNumberOfColumns(eventHandler.getNumberOfColumns());
            if(dataList.size() == numberOfRows){
                break;
            }
        }
        
        return dataList.iterator();
    }

    /**
     * Not supported. Refer getAllRows or getNRows
     */
    public Iterator<Row> iterator() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public Row createRow(int rownum) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void removeRow(Row row) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     *  Not supported due to memory footprint.
     * </pre>
     */
    public Row getRow(int rownum) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     *  Not supported due to memory footprint.
     * </pre>
     */
    public int getPhysicalNumberOfRows() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public int getFirstRowNum() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     *  Not supported due to memory footprint.
     * </pre>
     */
    public int getLastRowNum() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setColumnHidden(int columnIndex, boolean hidden) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     *  Not supported due to memory footprint.
     * </pre>
     */
    public boolean isColumnHidden(int columnIndex) {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setRightToLeft(boolean value) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public boolean isRightToLeft() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setColumnWidth(int columnIndex, int width) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public int getColumnWidth(int columnIndex) {
        // TODO Auto-generated method stub
        return 0;
    }


    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public float getColumnWidthInPixels(int columnIndex) {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */    
    public void setDefaultColumnWidth(int width) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public int getDefaultColumnWidth() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public short getDefaultRowHeight() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public float getDefaultRowHeightInPoints() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */   
    public void setDefaultRowHeight(short height) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */   
    public void setDefaultRowHeightInPoints(float height) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public CellStyle getColumnStyle(int column) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */   
    public int addMergedRegion(CellRangeAddress region) {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */   
    public int addMergedRegionUnsafe(CellRangeAddress region) {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public void validateMergedRegions() {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setVerticallyCenter(boolean value) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setHorizontallyCenter(boolean value) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean getHorizontallyCenter() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean getVerticallyCenter() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void removeMergedRegion(int index) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void removeMergedRegions(Collection<Integer> indices) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Not supported due to memory footprint.
     *  </pre>
     */
    public int getNumMergedRegions() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     *  <pre>
     * Not supported due to memory footprint.
     *  </pre>
     */
    public CellRangeAddress getMergedRegion(int index) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Not supported due to memory footprint.
     *  </pre>
     */
    public List<CellRangeAddress> getMergedRegions() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported. Use getAllRows or getNRows
     * </pre>
     */
    public Iterator<Row> rowIterator() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setForceFormulaRecalculation(boolean value) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean getForceFormulaRecalculation() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setAutobreaks(boolean value) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setDisplayGuts(boolean value) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public void setDisplayZeros(boolean value) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean isDisplayZeros() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setFitToPage(boolean value) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setRowSumsBelow(boolean value) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setRowSumsRight(boolean value) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean getAutobreaks() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean getDisplayGuts() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean getFitToPage() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean getRowSumsBelow() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean getRowSumsRight() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean isPrintGridlines() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setPrintGridlines(boolean show) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean isPrintRowAndColumnHeadings() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setPrintRowAndColumnHeadings(boolean show) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public PrintSetup getPrintSetup() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public Header getHeader() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public Footer getFooter() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setSelected(boolean value) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public double getMargin(short margin) {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setMargin(short margin, double size) {
        // TODO Auto-generated method stub
        
    }
    
    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean getProtect() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void protectSheet(String password) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean getScenarioProtect() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setZoom(int numerator, int denominator) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setZoom(int scale) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public short getTopRow() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public short getLeftCol() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public void showInPane(int toprow, int leftcol) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void shiftRows(int startRow, int endRow, int n) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void shiftRows(int startRow, int endRow, int n,
            boolean copyRowHeight, boolean resetOriginalRowHeight) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void createFreezePane(int colSplit, int rowSplit,
            int leftmostColumn, int topRow) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void createFreezePane(int colSplit, int rowSplit) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void createSplitPane(int xSplitPos, int ySplitPos,
            int leftmostColumn, int topRow, int activePane) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public PaneInformation getPaneInformation() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setDisplayGridlines(boolean show) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean isDisplayGridlines() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setDisplayFormulas(boolean show) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean isDisplayFormulas() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setDisplayRowColHeadings(boolean show) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean isDisplayRowColHeadings() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setRowBreak(int row) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean isRowBroken(int row) {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void removeRowBreak(int row) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public int[] getRowBreaks() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public int[] getColumnBreaks() {
        // TODO Auto-generated method stub
        return null;
    }

    public void setColumnBreak(int column) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean isColumnBroken(int column) {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void removeColumnBreak(int column) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setColumnGroupCollapsed(int columnNumber, boolean collapsed) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void groupColumn(int fromColumn, int toColumn) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void ungroupColumn(int fromColumn, int toColumn) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void groupRow(int fromRow, int toRow) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void ungroupRow(int fromRow, int toRow) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setRowGroupCollapsed(int row, boolean collapse) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setDefaultColumnStyle(int column, CellStyle style) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void autoSizeColumn(int column) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void autoSizeColumn(int column, boolean useMergedCells) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public Comment getCellComment(int row, int column) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public Comment getCellComment(CellAddress ref) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public Map<CellAddress, ? extends Comment> getCellComments() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public Drawing getDrawingPatriarch() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public Drawing createDrawingPatriarch() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Will not be supported due to memory constraints
     * </pre>
     */
    public Workbook getWorkbook() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public String getSheetName() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public boolean isSelected() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public CellRange<? extends Cell> setArrayFormula(String formula,
            CellRangeAddress range) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public CellRange<? extends Cell> removeArrayFormula(Cell cell) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public DataValidationHelper getDataValidationHelper() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public List<? extends DataValidation> getDataValidations() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void addValidationData(DataValidation dataValidation) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public AutoFilter setAutoFilter(CellRangeAddress range) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public SheetConditionalFormatting getSheetConditionalFormatting() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public CellRangeAddress getRepeatingRows() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public CellRangeAddress getRepeatingColumns() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setRepeatingRows(CellRangeAddress rowRangeRef) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setRepeatingColumns(CellRangeAddress columnRangeRef) {
        // TODO Auto-generated method stub
        
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public int getColumnOutlineLevel(int columnIndex) {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public Hyperlink getHyperlink(int row, int column) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public Hyperlink getHyperlink(CellAddress addr) {
        // TODO Auto-generated method stub
        return null;
    }


    /**
     * <pre>
     * Will not be supported due to memory constraints
     * </pre>
     */
    public List<? extends Hyperlink> getHyperlinkList() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     *  <pre>
     * Will be supported in future.
     *  </pre>
     */
    public CellAddress getActiveCell() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setActiveCell(CellAddress address) {
        // TODO Auto-generated method stub
        
    }



	
	
	
}




/* ====================================================================
   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.xssf.streaming.reader;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Properties;

import javax.xml.namespace.QName;
import javax.xml.stream.events.Attribute;
import javax.xml.stream.events.Characters;
import javax.xml.stream.events.EndElement;
import javax.xml.stream.events.StartElement;
import javax.xml.stream.events.XMLEvent;

import org.apache.poi.ss.usermodel.DataFormatter;
import org.apache.poi.xssf.model.SharedStringsTable;
import org.apache.poi.xssf.model.StylesTable;
import org.apache.poi.xssf.usermodel.XSSFCellStyle;
import org.apache.poi.xssf.usermodel.XSSFRichTextString;

/**
 * Handler class that handles the event generated by StAX parser
 *
 */
public class StreamedSheetEventHandler {
	
	private boolean isEndOfRow = false;
	private boolean isRow = false;
	//private boolean mergeCell = false;
	
	private String formatString = null;
	private int formatIndex = 0;
	private String cellContentType;
	private int rowNumber = 0;
	private int numberOfColumns = 0;
	private List<String> cellPositions = null;
	private String currentCellPosition = null;
	private int previousCellIndex = -1;
	//private List<String> mergeList = null;  //merge cell not supported right now. Complexity involved if multiple rows are merged.
	
	private SharedStringsTable sharedStringsTable;
	private StylesTable stylesTable;
	
	private DataFormatter formatter = new DataFormatter();
	private Properties properties = new Properties();
	private Map<String, String> attributes = new HashMap<String, String>();
	private StringBuffer sb = new StringBuffer(250); 
	private List<String> dateFormatsAry =  new ArrayList<String>();
	
	private StreamedRow row;
	private StreamedCell cell;
	
	private final String dateFormat = "m/d/yy|DD/MM/YY|[$-F800]dddd\\,\\ mmmm\\ dd\\,\\ yyyy|m/d;@|m/d/yy;@|mm/dd/yy;@|"
	        + "[$-409]d\\-mmm;@|[$-409]d\\-mmm\\-yy;@|[$-409]dd\\-mmm\\-yy;@|[$-409]mmm\\-yy;@|[$-409]mmmm\\-yy;@|"
	        + "[$-409]mmmm\\ d\\,\\ yyyy;@|[$-409]m/d/yy\\ h:mm\\ AM/PM;@|m/d/yy\\ h:mm;@|[$-409]mmmmm;@|"
	        + "[$-409]mmmmm\\-yy;@|m/d/yyyy;@|[$-409]d\\-mmm\\-yyyy;@|[$-F400]h:mm:ss\\ AM/PM|"
	        + "h:mm;@|[$-409]h:mm\\ AM/PM;@|h:mm:ss;@|[$-409]h:mm:ss\\ AM/PM;@|mm:ss.0;@|[h]:mm:ss;@|"
	        + "[$-409]m/d/yy\\ h:mm\\ AM/PM;@|DD/MM/YYYY";
	
	public static final String DEFAULT_CELL_TYPE = "DEFAULT";
	public static final String STRING_CELL_TYPE = "STRING";
	public static final String BOOLEAN_CELL_TYPE = "BOOLEAN";
	public static final String DATE_CELL_TYPE = "DATE";
	public static final String FORMULA_CELL_TYPE = "FORMULA";
	public static final String NUMERIC_CELL_TYPE = "NUMERIC";
		
	
	/**
	 * Constructor
	 * @param sharedStringsTable
	 * @param stylesTable
	 */
	public StreamedSheetEventHandler(SharedStringsTable sharedStringsTable, StylesTable stylesTable){
		this.sharedStringsTable = sharedStringsTable;
		this.stylesTable = stylesTable;
		/*try{
			properties.load(getClass().getClassLoader().getResourceAsStream("excelreader.properties"));
		}catch(Exception e){
			e.printStackTrace();
		}*/
		
		/*if(properties.get("date.formatStrings") != null){
			dateFormat = properties.get("date.formatStrings").toString();			
		}*/
		
		dateFormatsAry.addAll(Arrays.asList(dateFormat.split("\\|")));
		
	}
	
	/**
	 * Handler method for handling the event generated for StAX parser.
	 * For each XML event(Start Tag, End Tag & Characters), StAX parser will 
	 * generate event. This event will be handled by this method.
	 * Attributes of each element are put in a map with key as attribute 
	 * and value as attribute value.
	 * @param event
	 */
	public void handleEvent(XMLEvent event){
		switch(event.getEventType()){
		case XMLEvent.START_ELEMENT:
			StartElement startElemet = event.asStartElement();
			QName startName = startElemet.getName();
			String name = startName.getLocalPart();					
			Iterator<Attribute> iterator = startElemet.getAttributes();
			while(iterator.hasNext()){
				Attribute attribute = iterator.next();					
				attributes.put(attribute.getName().getLocalPart(), attribute.getValue());
			}
			if((name.trim().equals("row")) && (attributes.size() > 0)){
				isRow = true;
			}
			
			/*else if(name.trim().equals("mergeCell")){
			    mergeCell = true;
			}
			
			if(isRow || mergeCell){
				startElement(name);
			}*/
			
			if(isRow){
                startElement(name);
            }
			break;
		case XMLEvent.CHARACTERS:
			Characters chars = event.asCharacters();
			if(isRow){
				characters(chars.getData());
			}
			break;
		case XMLEvent.END_ELEMENT:
			EndElement endElement = event.asEndElement();
			QName endName = endElement.getName();
			String endTageName = endName.getLocalPart();
			endElement(endTageName);
			attributes.clear();
			break;
		}
	}
	
	/**
	 * All the start element events are handled here.
	 * It identifies the things like rowNumber, cell content type etc
	 * @param name
	 */
	private void startElement(String name) {
		if(name.equals("row")) {
			previousCellIndex = -1;
			isEndOfRow = false;
			rowNumber = (Integer.parseInt(attributes.get("r")) - 1);
			row = new StreamedRow(rowNumber);
			if(rowNumber == 0){
				cellPositions = new ArrayList<String>();
			}
		}else if(name.equals("c")){
			String cellPosition =  attributes.get("r").toUpperCase();
			cellPosition = cellPosition.replaceAll(String.valueOf(rowNumber+1), "").trim();
			currentCellPosition = cellPosition;
			if(rowNumber == 0){
				numberOfColumns ++;								
				cellPositions.add(cellPosition);
			}

			cellContentType = getCellContentType();
		}else if(name.equals("f")){
			cellContentType = FORMULA_CELL_TYPE;
		}
		
		/*else if(name.equals("mergeCell")){
		    if(mergeList == null){
		        mergeList = 
		    }
		}*/
	}
	
	
	/**
	 * This method is invoked on end element event.
	 * Mostly used for setting the default values before handling 
	 * next start element.
	 * All data captured in characters event are stored here.
	 * Data will be stored only on reaching the end element.
	 * @param name
	 */
	private void endElement(String name) {
		if(name.equals("c")){
			if(isRow){
				storeData(sb.toString());
			}
			cellContentType = DEFAULT_CELL_TYPE;
			formatString = null;
			formatIndex = 0;			
			currentCellPosition = null;
			previousCellIndex++;
			sb.delete(0, sb.length());
		}else if(name.equals("row")){
			isEndOfRow = true;
			isRow = false;
		}else if(name.equals("f")){
			cellContentType = DEFAULT_CELL_TYPE;
		}
		
		/*else if(name.equals("mergeCell")){
		    mergeCell = false;
		}*/
	}
	
	/**
	 * Captures the data 
	 * @param data
	 */
	private void characters(String data) {
		if(!(cellContentType.equals(FORMULA_CELL_TYPE))){			
			sb.append(data);
		}
	}
	
	/**
	 * Creates cells and store data
	 * @param data
	 */
	private void storeData(String data){			
		if (!(cellContentType.equals(FORMULA_CELL_TYPE))) {
			if(cellContentType.equals(STRING_CELL_TYPE)){
				data = getStringData(data);
			}else if(cellContentType.equals(DATE_CELL_TYPE)){
				data = getDateAsString(data);
			}else if(cellContentType.equals(BOOLEAN_CELL_TYPE)){
				if(data.trim().equals("1")){
					data = "TRUE";
				}else if(data.trim().equals("0")){
					data = "FALSE";
				}else if(data.trim().equals("")){
					data = null;
				}else{
				    try{
				        int value = Integer.parseInt(data);
				        if(value > 0){
				            data = "TRUE";
				        }
				    }catch(Exception e){
				        data = null;
				    }
				}
			}
			
			if(cellPositions != null){
				fillEmptyCells();
			}
			
			cell = new StreamedCell();
			cell.setValue(data);
			cell.setCellNumber(previousCellIndex+1);
			row.getCells().add(cell);
					
		}
	}
	
	
	/**
	 * Identifies the cell content type
	 * @return
	 */
	private String getCellContentType(){
		String cellConentType = DEFAULT_CELL_TYPE;
		String cellType = attributes.get("t");
		if((null != cellType) && (cellType.equals("s"))){
			cellConentType = STRING_CELL_TYPE;
		}else if((null != cellType) && (equals("b"))){
			cellConentType = BOOLEAN_CELL_TYPE;
		}else{
			
			if(checkForDate()){
				cellConentType = DATE_CELL_TYPE;
			}else if(checkForBoolean()){
				cellConentType = BOOLEAN_CELL_TYPE;
			}
		}
		return cellConentType;
	}
	
	
	
	/**
	 * Identifies if the given cell is a boolean or not
	 * @return
	 */
	private boolean checkForBoolean(){
		String cellStyleType = attributes.get("s");
		if(cellStyleType != null){
			int styleIndex = Integer.parseInt(cellStyleType);
			XSSFCellStyle style = stylesTable.getStyleAt(styleIndex);
			formatIndex = style.getDataFormat();
			formatString = style.getDataFormatString();
			if(formatString.contains("TRUE")){
				return true;
			}else{
				return false;
			}
		}else{
			return false;
		}
	}

	/**
	 * identifies if the given cell is a Date cell or not
	 * @return
	 */
	private boolean checkForDate(){
		boolean isDate = false;
		String cellStyleType = attributes.get("s");
		if(cellStyleType != null){
			int styleIndex = Integer.parseInt(cellStyleType);
			XSSFCellStyle style = stylesTable.getStyleAt(styleIndex);
			formatIndex = style.getDataFormat();
			formatString = style.getDataFormatString();
			if(dateFormatsAry.contains(formatString.trim())){				
				isDate = true;
			}
		}
		
		return isDate;
	}
	

	/**
	 * fetches the String data from SharedStringsTable.xml
	 * @param data
	 * @return
	 */
	private String getStringData(String data){
		int index = Integer.parseInt(data);
		return new XSSFRichTextString(sharedStringsTable.getEntryAt(index)).toString().trim();
	}
	
	/**
	 * check the styles applied to the cell and fetches the exact content of date cell
	 * @param data
	 * @return
	 */
	private String getDateAsString(String data) {
		if ((data != null) && (!(data.trim().equals("")))) {
			/*return formatter.formatRawCellContents(Double.parseDouble(data),
					formatIndex, formatString);*/
		    
		    /*
		     * All dates are formatted with 'DD/MM/YYYY', this is to avoid confusion between
		     * 10/12/2017 & 10/12/1917. Otherwise both will be read as 10/12/17 if the format 
		     * is DD/MM/YY
		     */
		    return formatter.formatRawCellContents(Double.parseDouble(data),
                    formatIndex, "DD/MM/YYYY");
		} else {
			return null;
		}
	}

	
	/**
	 * Used to fill empty cells as null
	 */
	private void fillEmptyCells() {
		int currentCellIndex = cellPositions.indexOf(currentCellPosition);
		if ((currentCellIndex - previousCellIndex) > 1) {
			for (int i = (previousCellIndex + 1); i < currentCellIndex; i++) {
				cell = new StreamedCell();
				cell.setValue(null);
				row.getCells().add(cell);
			}
			
			previousCellIndex = currentCellIndex;
		}
	}

	public boolean isEndOfRow() {
		return isEndOfRow;
	}

	public void setEndOfRow(boolean isEndOfRow) {
		this.isEndOfRow = isEndOfRow;
	}

	public int getRowNumber() {
		return rowNumber;
	}

	public int getNumberOfColumns() {
		return numberOfColumns;
	}

	public List<String> getCellPositions() {
		return cellPositions;
	}

	public StreamedRow getRow() {
		return row;
	}
	
	
}




/* ====================================================================
   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.xssf.streaming.reader;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import javax.xml.stream.XMLEventReader;
import javax.xml.stream.XMLInputFactory;

import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.ss.SpreadsheetVersion;
import org.apache.poi.ss.formula.udf.UDFFinder;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.CreationHelper;
import org.apache.poi.ss.usermodel.DataFormat;
import org.apache.poi.ss.usermodel.Font;
import org.apache.poi.ss.usermodel.Name;
import org.apache.poi.ss.usermodel.PictureData;
import org.apache.poi.ss.usermodel.Row.MissingCellPolicy;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger;
import org.apache.poi.xssf.eventusermodel.XSSFReader;
import org.apache.poi.xssf.model.SharedStringsTable;
import org.apache.poi.xssf.model.StylesTable;

/**
 * Represents the excel workbook
 *
 */
public class StreamedWorkbook implements Workbook{
    
    private static final POILogger logger = POILogFactory.getLogger(StreamedWorkbook.class);
	
	private File inputFile;
	
	private Iterator<InputStream> sheetIterator;
    private SharedStringsTable sharedStringsTable;
    private StylesTable stylesTable;
	
	/**
	 * <pre>
	 * Accepts the file path and return an instance of StreamedWorkBook
	 *</pre>
	 * @param filePath
	 * @throws Exception 
	 */
	public StreamedWorkbook(String filePath) throws Exception{
		if((filePath != null) && !(filePath.trim().isEmpty())){
			inputFile = new File(filePath);
			
			if(inputFile != null){
			    XSSFReader reader = getExcelReader(inputFile);
	            if(reader != null){
	                sheetIterator = reader.getSheetsData();
	                sharedStringsTable = reader.getSharedStringsTable();
	                stylesTable = reader.getStylesTable();
	            }
	        }
			
		}else{
            throw new Exception("No sheets found");
        }
	}
	
	/**
	 * <pre>
	 * Fetch all sheets from given excel file
	 * </pre>
	 * @return
	 * @throws Exception
	 */
	public Iterator<StreamedSheet> getSheetIterator() throws Exception{
	    
	    return getAllSheets();
	}
	
	
	 /**
     * Returns the list of sheets for the given excel file
     * @param file
     * @return
     * @throws Exception 
     */
    private Iterator<StreamedSheet>  getAllSheets() throws Exception{
        
        return getStreamedSheetIterator();
    }
    
    private Iterator<StreamedSheet> getStreamedSheetIterator() throws Exception{
        List<StreamedSheet> sheetList = null;
        XMLInputFactory factory = null; 
        
        if(sheetIterator != null){
            factory = XMLInputFactory.newInstance();
            sheetList =  new ArrayList<StreamedSheet>();
            int sheetNumber = 0;
            while(sheetIterator.hasNext()){
                InputStream sheetInputStream = sheetIterator.next();
                StreamedSheet sheet = createStreamedSheet(factory.createXMLEventReader(sheetInputStream), sheetNumber);
                sheetList.add(sheet);
                sheetNumber++;
            }
        }else{
            throw new Exception("Workbook already closed");
        }
        
        return sheetList.iterator();
        
    }
    
    /**
     * Creates and returns the instance of StreamedSheet
     *
     * @param parser
     * @param sheetNumber
     * @return
     */
    private StreamedSheet createStreamedSheet(XMLEventReader parser,int sheetNumber){
        StreamedSheet sheet = new StreamedSheet();
        sheet.setXmlParser(parser);
        sheet.setSharedStringsTable(sharedStringsTable);
        sheet.setStylesTable(stylesTable);
        sheet.setSheetNumber(sheetNumber);
        sheet.createEventHandler();
        
        return sheet;
    }
    
    
    
    /**
     * Receives the excel file and returns the file excel file reader
     * @param inputStream
     * @return
     * @throws Exception
     */
    private XSSFReader getExcelReader(File file) throws Exception{
        XSSFReader reader = null;
        OPCPackage pkg = null;
        pkg = OPCPackage.open(file);
        reader = new XSSFReader(pkg);
        return reader;
    }
    
    
    
    /*
     *  TO DO 
     */

    
    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public int getActiveSheetIndex() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setActiveSheet(int sheetIndex) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public int getFirstVisibleTab() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public void setFirstVisibleTab(int sheetIndex) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public void setSheetOrder(String sheetname, int pos) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public void setSelectedTab(int index) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void setSheetName(int sheet, String name) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */    
    public String getSheetName(int sheet) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public int getSheetIndex(String name) {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public int getSheetIndex(Sheet sheet) {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */    
    public Sheet createSheet() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public Sheet createSheet(String sheetname) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public Sheet cloneSheet(int sheetNum) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Use Iterator<StreamedSheet> getSheetIterator() instead.
     * </pre>
     * 
     */
    public Iterator<Sheet> sheetIterator() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     *  Returns the number of sheets,
     * </pre>
     */
    public int getNumberOfSheets() {
        int sheetCount = 0;
        
        if(this.sheetIterator != null){
            while(sheetIterator.hasNext()){
                sheetIterator.next();
                sheetCount++;
            }
        }else{
            logger.log(POILogger.ERROR, "Workbook already closed");
        }
        
        
        return sheetCount;
    }

    /**
     * <pre>
     *  Currently not supported due to memory footprint.
     *  Will be supported in future.
     * </pre>
     */
    public Sheet getSheetAt(int index) {
        
/*        StreamedSheet sheet = null;
        int sheetCount = 0;
        XMLInputFactory factory = XMLInputFactory.newInstance();
        
        if(inputFile != null && inputFile.exists()){
            try {
                XSSFReader reader = getExcelReader(inputFile);
                
                
                
                while(reader.getSheetsData().hasNext()){
                    
                    if(index == sheetCount){
                        sheet = createStreamedSheet(factory.createXMLEventReader(reader.getSheetsData().next()), sheetCount);
                    }else{
                        reader.getSheetsData().next();
                    }
                    
                    sheetCount++;
                }
                
            } catch (Exception e) {
                logger.log(POILogger.ERROR, "No sheets found !!");
            }
        }
        return sheet;*/
        return null;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public Sheet getSheet(String name) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public void removeSheetAt(int index) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public Font createFont() {
        // TODO Auto-generated method stub
        return null;
    }


    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public Font findFont(short boldWeight, short color, short fontHeight,
            String name, boolean italic, boolean strikeout, short typeOffset,
            byte underline) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public Font findFont(boolean bold, short color, short fontHeight,
            String name, boolean italic, boolean strikeout, short typeOffset,
            byte underline) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public short getNumberOfFonts() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public Font getFontAt(short idx) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */
    public CellStyle createCellStyle() {
        // TODO Auto-generated method stub
        return null;
    }


    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public int getNumCellStyles() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public CellStyle getCellStyleAt(int idx) {
        // TODO Auto-generated method stub
        return null;
    }

    
    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */    
    public void write(OutputStream stream) throws IOException {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Close the workbook
     * </pre>
     * 
     */    
    public void close() throws IOException {
        if(sheetIterator != null){
            while(sheetIterator.hasNext()){
                sheetIterator.next().close();
            }
            sheetIterator = null;
        }
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */    
    public int getNumberOfNames() {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public Name getName(String name) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public List<? extends Name> getNames(String name) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public List<? extends Name> getAllNames() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */
    public Name getNameAt(int nameIndex) {
        // TODO Auto-generated method stub
        return null;
    }

    
    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */       
    public Name createName() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */    
    public int getNameIndex(String name) {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */   
    public void removeName(int index) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */   
    public void removeName(String name) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */   
    public void removeName(Name name) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */      
    public int linkExternalWorkbook(String name, Workbook workbook) {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */   
    public void setPrintArea(int sheetIndex, String reference) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */   
    public void setPrintArea(int sheetIndex, int startColumn, int endColumn,
            int startRow, int endRow) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */ 
    public String getPrintArea(int sheetIndex) {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */      
    public void removePrintArea(int sheetIndex) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */ 
    public MissingCellPolicy getMissingCellPolicy() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */  
    public void setMissingCellPolicy(MissingCellPolicy missingCellPolicy) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */  
    public DataFormat createDataFormat() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */  
    public int addPicture(byte[] pictureData, int format) {
        // TODO Auto-generated method stub
        return 0;
    }

    /**
     * <pre>
     * Not supported due to memory footprint.
     * </pre>
     * 
     */ 
    public List<? extends PictureData> getAllPictures() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */ 
    public CreationHelper getCreationHelper() {
        // TODO Auto-generated method stub
        return null;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */ 
    public boolean isHidden() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */  
    public void setHidden(boolean hiddenFlag) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */ 
    public boolean isSheetHidden(int sheetIx) {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */ 
    public boolean isSheetVeryHidden(int sheetIx) {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setSheetHidden(int sheetIx, boolean hidden) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setSheetHidden(int sheetIx, int hidden) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void addToolPack(UDFFinder toopack) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Not supported right now, as StreamedWorkbook
     * supports only reading.
     * </pre>
     * 
     */ 
    public void setForceFormulaRecalculation(boolean value) {
        // TODO Auto-generated method stub
        
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */     
    public boolean getForceFormulaRecalculation() {
        // TODO Auto-generated method stub
        return false;
    }

    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */ 
    public SpreadsheetVersion getSpreadsheetVersion() {
        // TODO Auto-generated method stub
        return null;
    }


    /**
     * <pre>
     * Will be supported in the future.
     * </pre>
     * 
     */ 
    public Iterator<Sheet> iterator() {
        return null;
    }
}




/*
 *  ====================================================================
 *    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.xssf.streaming.reader;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;

import java.io.File;
import java.util.Iterator;

import org.apache.poi.POIDataSamples;
import org.junit.Test;


public class TestStreamedWorkbook{

   @Test
    public void testInvalidFilePath() throws Exception{
       StreamedWorkbook workbook = null;
       try {
            workbook = new StreamedWorkbook(null);
            fail("expected exception");
        } catch (Exception e) {
            assertEquals("No sheets found", e.getMessage());
        }
        
        if(workbook != null)workbook.close();
        
    }
    
    @Test
    public void testInvalidFile() throws Exception{ 
        POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
        File f= files.getFile("InvalidFile.txt");
        StreamedWorkbook workbook = null;
        try {
        
            workbook = new StreamedWorkbook(f.getAbsolutePath());
            workbook.getSheetIterator();
        } catch (Exception e) {
            assertEquals("No valid entries or contents found, this is not a valid OOXML (Office Open XML) file", e.getMessage());
        }
        
        if(workbook != null)workbook.close();
    }
    
   
    @Test
    public void testSheetCount() throws Exception{
        POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
        File f= files.getFile("SpreadSheetSample04022017.xlsx");
        StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
        int count = 0;
        
        try {
            Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
            
            while(sheetIterator.hasNext()){
                sheetIterator.next();
                count++;
            }
            
            assertEquals(2, count);
        } catch (Exception e) {
            
        }
        
        workbook.close();
       
    }
    
    @Test
    public void testTotalNumberOfSheets() throws Exception{
        POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
        File f= files.getFile("SpreadSheetSample04022017.xlsx");
        StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
        
        try {
            int sheetCount = workbook.getNumberOfSheets();
            
            assertEquals(2, sheetCount);
        } catch (Exception e) {
        }
       
        workbook.close();
    }
    
/*    @Test
    public void testSheetAt() throws Exception{         //Not supported <TO DO>
        POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
        File f= files.getFile("SpreadSheetSample04022017.xlsx");
        StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
        int sheetIndex = 0;
        
        StreamedSheet sheet = (StreamedSheet)workbook.getSheetAt(sheetIndex);
        
        assertEquals(sheetIndex, sheet.getSheetNumber());
        
        sheetIndex = 1;
        
        sheet = (StreamedSheet)workbook.getSheetAt(sheetIndex);
        System.out.println(sheet.getSheetNumber());
        
        assertEquals(sheetIndex, sheet.getSheetNumber());
        
        workbook.close();
        
    }*/
    
    @Test
    public void testTotalRowCount() throws Exception{
        POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
        File f= files.getFile("SpreadSheetSample04022017.xlsx");
        StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
        int sheetCount = 0;
        
        long count = 0;
        
        Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
        
        while((sheetIterator.hasNext()) && (sheetCount == 0)){
            StreamedSheet sheet = sheetIterator.next();
            
            Iterator<StreamedRow> rows = sheet.getAllRows();
            
            while(rows.hasNext()){
                rows.next();
                count++;
            }
            
            assertEquals(6, count);
            sheetCount++;
        }
        
        workbook.close();
    }
    
    @Test
    public void testNRowCount() throws Exception{
        POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
        File f= files.getFile("SpreadSheetSample04022017.xlsx");
        StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
        
        long count = 0;
        int sheetCount = 0;
        
        Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
        
        while((sheetIterator.hasNext()) && (sheetCount == 0)){
            StreamedSheet sheet = sheetIterator.next();
            
            Iterator<StreamedRow> rows = sheet.getNRows(4);
            
            while(rows.hasNext()){
                rows.next();
                count++;
            }
            
            assertEquals(4, count);
            sheetCount++;
        }
        
        workbook.close();
    }
    
    @Test
    public void testCellCount() throws Exception{
        POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
        File f= files.getFile("SpreadSheetSample04022017.xlsx");
        StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
        int sheetCount = 0;
        
        Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
        
        while((sheetIterator.hasNext()) && (sheetCount == 0)){
            StreamedSheet sheet = sheetIterator.next();
            
            Iterator<StreamedRow> rows = sheet.getAllRows();
            
            while(rows.hasNext()){
                long count = 0;
                StreamedRow row = rows.next();
                
                Iterator<StreamedCell> cellIterator = row.getCellIterator();
                
                while(cellIterator.hasNext()){
                    cellIterator.next();
                    count++;
                }
                
                assertEquals(7, count);
            }
            
            sheetCount++;
        }
        
        workbook.close();
    }
    
    
    @Test
    public void testStartingRowAndCellNumber() throws Exception{
        POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
        File f= files.getFile("SpreadSheetSample04022017.xlsx");
        StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
        int sheetCount = 0;
        
        
        Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
        
        while((sheetIterator.hasNext()) && (sheetCount == 0)){
            int rowCount = 0;
            int cellCount = 0;
            StreamedSheet sheet = sheetIterator.next();
            
            Iterator<StreamedRow> rows = sheet.getAllRows();
            
            while(rows.hasNext()){
                StreamedRow row = rows.next();
                if(rowCount == 0){
                    assertEquals(rowCount, row.getRowNum());
                }
                rowCount++;
                
                
                Iterator<StreamedCell> cellIterator = row.getCellIterator();
                
                while(cellIterator.hasNext()){
                    StreamedCell cell = cellIterator.next();
                    if(cellCount == 0){
                        assertEquals(cellCount, cell.getCellNumber());
                    }
                    cellCount++;
                    
                }
                
            }
            
            sheetCount++;
        }
        
        workbook.close();
    }
    
    @Test
    public void testSheetData() throws Exception{
        POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
        File f= files.getFile("SpreadSheetSample04022017.xlsx");
        StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
        int sheetCount = 0;
        
        
        Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
        
        while((sheetIterator.hasNext()) && (sheetCount == 0)){
            int rowCount = 0;
            
            StreamedSheet sheet = sheetIterator.next();
            
            Iterator<StreamedRow> rows = sheet.getAllRows();
            
            while(rows.hasNext()){
                
                StreamedRow row = rows.next();
                
                int cellCount = 0;
                
                Iterator<StreamedCell> cellIterator = row.getCellIterator();
                
                while(cellIterator.hasNext()){
                    StreamedCell cell = cellIterator.next();
                    if(rowCount == 1){
                        
                        if(cellCount == 0){
                            assertEquals("1", cell.getValue());
                        }else if(cellCount == 1){
                            assertEquals("Item1", cell.getValue());
                        }else if(cellCount == 2){
                            assertEquals("201", cell.getValue());
                        }else if(cellCount == 3){
                            assertEquals("100.11", cell.getValue());
                        }else if(cellCount == 4){
                            assertEquals("TRUE", cell.getValue());
                        }else if(cellCount == 5){
                            assertEquals("04/02/1917", cell.getValue());
                        }else if(cellCount == 6){
                            assertEquals("90.11", cell.getValue());
                        }
                    }else if(rowCount == 3){
                        if(cellCount == 4){
                            assertEquals(null, cell.getValue());
                        }
                    }
                    
                    cellCount++;
                    
                }
                
                
                rowCount++;
                
            }
            
            sheetCount++;
        }
        
        workbook.close();
    }
    
    @Test
    public void testBatchData() throws Exception{
        
        POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
        File f= files.getFile("SpreadSheetSample04022017.xlsx");
        StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
        int sheetCount = 0;
        
        
        Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
        
        while(sheetIterator.hasNext()){
            
            StreamedSheet sheet = sheetIterator.next();
            
            if(sheetCount == 1){
                Iterator<StreamedRow> rows = sheet.getNRows(1);
                
                while(rows.hasNext()){
                    StreamedRow row = rows.next();
                    assertEquals("Row Number:0 --> Item | item description | Strore | Price | Promotion applied | MFD | Discount rate |", row.toString().trim());
                }
                
                
                rows = sheet.getNRows(4);
                
                while(rows.hasNext()){
                    StreamedRow row = rows.next();
                    assertEquals("Row Number:1 --> 1 | Item1 | 201 | 100.11 | TRUE | 04/02/1917 | 90.11 |", row.toString().trim());
                    row = rows.next();
                    assertEquals("Row Number:2 --> 2 | Item2 | 202 | 101.11 | TRUE | 05/02/1917 | 91.11 |", row.toString().trim());
                    row = rows.next();
                    assertEquals("Row Number:3 --> 3 | Item3 | 203 | 102.11 | TRUE | 06/02/1917 | 92.11 |", row.toString().trim());
                    row = rows.next();
                    assertEquals("Row Number:4 --> 4 | Item4 | 204 | 103.11 | TRUE | 07/02/1917 | 93.11 |", row.toString().trim());
                }
                
                
                
                rows = sheet.getNRows(4);
                
                while(rows.hasNext()){
                    StreamedRow row = rows.next();
                    assertEquals("Row Number:5 --> 5 | Item5 | 205 | 104.11 | TRUE | 08/02/1917 | 94.11 |", row.toString().trim());
                    row = rows.next();
                    assertEquals("Row Number:6 --> 6 | Item6 | 206 | 105.11 | TRUE | 09/02/1917 | 95.11 |", row.toString().trim());
                    row = rows.next();
                    assertEquals("Row Number:7 --> 7 | Item7 | 207 | 106.11 | TRUE | 10/02/1917 | 96.11 |", row.toString().trim());
                    row = rows.next();
                    assertEquals("Row Number:8 --> 8 | Item8 | 208 | 107.11 | FALSE | 11/02/1917 | 97.11 |", row.toString().trim());
                }
                
            }
            

            sheetCount++;
            
        }
        
        workbook.close();
        
    }
    
    
    @Test
    public void testGetCell() throws Exception{
        POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
        File f= files.getFile("SpreadSheetSample04022017.xlsx");
        StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
        int sheetCount = 0;
        
        
        Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
        
        while((sheetIterator.hasNext()) && (sheetCount == 0)){
            
            StreamedSheet sheet = sheetIterator.next();
            
            Iterator<StreamedRow> rows = sheet.getAllRows();
            
            while(rows.hasNext()){
                
                StreamedRow row = rows.next();
                
                if(row.getRowNum() == 3){
                    StreamedCell cell = (StreamedCell)row.getCell(5);
                    assertEquals("06/02/1917", cell.getValue());
                    
                    try{
                        cell = (StreamedCell)row.getCell(10);
                    }catch(Exception exception){
                        assertEquals(true, exception instanceof IndexOutOfBoundsException);
                    }
                }
                

            }
            
            sheetCount++;
        }
    }
    
    
    @Test
    public void testGetFirstAndLastCellNum() throws Exception{
        POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
        File f= files.getFile("SpreadSheetSample04022017.xlsx");
        StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
        int sheetCount = 0;
        
        
        Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
        
        while((sheetIterator.hasNext()) && (sheetCount == 0)){
            
            StreamedSheet sheet = sheetIterator.next();
            
            Iterator<StreamedRow> rows = sheet.getAllRows();
            
            while(rows.hasNext()){
                
                StreamedRow row = rows.next();
                
                if(row.getRowNum() == 3){
                    StreamedCell cell = (StreamedCell)row.getCell(row.getFirstCellNum());
                    assertEquals("3", cell.getValue());
                    assertEquals("3", cell.getStringCellValue());
                    
                    cell = (StreamedCell)row.getCell(row.getLastCellNum());
                    assertEquals("92.11", cell.getValue());
                    assertEquals("92.11", cell.getStringCellValue());
                }
            }
            
            sheetCount++;
        }
    }
    
    @Test
    public void testReopenClosedWorkbook(){
        
        try{
            POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
            File f= files.getFile("SpreadSheetSample04022017.xlsx");
            StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
            
            workbook.close();
            
            Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
        }catch(Exception e){
            assertEquals("Workbook already closed", e.getMessage());
        }
            

    }
    
    
    
    
}

Return to bug 60707

Line 0 Link Here

(-)a/src/ooxml/java/org/apache/poi/xssf/streaming/reader/StreamedCell.java (+497 lines)
		1	/* ====================================================================
		2	Licensed to the Apache Software Foundation (ASF) under one or more
		3	contributor license agreements. See the NOTICE file distributed with
		4	this work for additional information regarding copyright ownership.
		5	The ASF licenses this file to You under the Apache License, Version 2.0
		6	(the "License"); you may not use this file except in compliance with
		7	the License. You may obtain a copy of the License at
		8
		9	http://www.apache.org/licenses/LICENSE-2.0
		10
		11	Unless required by applicable law or agreed to in writing, software
		12	distributed under the License is distributed on an "AS IS" BASIS,
		13	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		14	See the License for the specific language governing permissions and
		15	limitations under the License.
		16	==================================================================== */
		17	package org.apache.poi.xssf.streaming.reader;
		18
		19	import java.util.Calendar;
		20	import java.util.Date;
		21
		22	import org.apache.poi.ss.formula.FormulaParseException;
		23	import org.apache.poi.ss.usermodel.Cell;
		24	import org.apache.poi.ss.usermodel.CellStyle;
		25	import org.apache.poi.ss.usermodel.CellType;
		26	import org.apache.poi.ss.usermodel.Comment;
		27	import org.apache.poi.ss.usermodel.Hyperlink;
		28	import org.apache.poi.ss.usermodel.RichTextString;
		29	import org.apache.poi.ss.usermodel.Row;
		30	import org.apache.poi.ss.usermodel.Sheet;
		31	import org.apache.poi.ss.util.CellAddress;
		32	import org.apache.poi.ss.util.CellRangeAddress;
		33
		34	/**
		35	* Represents cell in a row
		36	* Value of cell is represented as a string.
		37	*
		38	*/
		39	public class StreamedCell implements Cell{
		40	private String value;
		41	private int cellNumber;
		42
		43	public StreamedCell(){
		44
		45	}
		46
		47	/**
		48	* <pre>
		49	* Return cell value
		50	* </pre>
		51	* Return the value of a cell in String format.
		52	* Value will be same as how it is represented in excel.
		53	* @return String
		54	*/
		55	public String getValue() {
		56	return value;
		57	}
		58
		59	public void setValue(String value) {
		60	this.value = value;
		61	}
		62
		63	public String toString(){
		64	return value;
65	}
66
67	/**
68	* <pre>
69	* Returns the cell number
70	* </pre>
71	*
72	* @return
73	*/
74	public int getCellNumber() {
75	return cellNumber;
76	}
77
78	/**
79	* <pre>
80	* Not supported right now, as StreamedWorkbook
81	* supports only reading.
82	*</pre>
83	* @param cellNumber
84	*/
85	public void setCellNumber(int cellNumber) {
86	this.cellNumber = cellNumber;
87	}
88
89	/**
90	* <pre>
91	* Will be supported in future.
92	* </pre>
93	*/
94	public int getColumnIndex() {
95	// TODO Auto-generated method stub
96	return 0;
97	}
98
99	/**
100	* <pre>
101	* Will be supported in future.
102	* </pre>
103	*/
104	public int getRowIndex() {
105	// TODO Auto-generated method stub
106	return 0;
107	}
108
109	/**
110	* <pre>
111	* Will be supported in future.
112	* </pre>
113	*/
114	public Sheet getSheet() {
115	// TODO Auto-generated method stub
116	return null;
117	}
118
119	/**
120	* <pre>
121	* Will be supported in future.
122	* </pre>
123	*/
124	public Row getRow() {
125	// TODO Auto-generated method stub
126	return null;
127	}
128
129	/**
130	* <pre>
131	* Not supported right now, as StreamedWorkbook
132	* supports only reading.
133	*</pre>
134	* @param cellNumber
135	*/
136	public void setCellType(int cellType) {
137	// TODO Auto-generated method stub
138
139	}
140
141	/**
142	* <pre>
143	* Not supported right now, as StreamedWorkbook
144	* supports only reading.
145	*</pre>
146	* @param cellNumber
147	*/
148	public void setCellType(CellType cellType) {
149	// TODO Auto-generated method stub
150
151	}
152
153	/**
154	* <pre>
155	* Will be supported in future.
156	* </pre>
157	*/
158	public int getCellType() {
159	// TODO Auto-generated method stub
160	return 0;
161	}
162
163	/**
164	* <pre>
165	* Will be supported in future.
166	* </pre>
167	*/
168	public CellType getCellTypeEnum() {
169	// TODO Auto-generated method stub
170	return null;
171	}
172
173	/**
174	* <pre>
175	* Will be supported in future.
176	* </pre>
177	*/
178	public int getCachedFormulaResultType() {
179	// TODO Auto-generated method stub
180	return 0;
181	}
182
183	/**
184	* <pre>
185	* Will be supported in future.
186	* </pre>
187	*/
188	public CellType getCachedFormulaResultTypeEnum() {
189	// TODO Auto-generated method stub
190	return null;
191	}
192
193	/**
194	* <pre>
195	* Not supported right now, as StreamedWorkbook
196	* supports only reading.
197	*</pre>
198	* @param cellNumber
199	*/
200	public void setCellValue(double value) {
201	// TODO Auto-generated method stub
202
203	}
204
205	/**
206	* <pre>
207	* Not supported right now, as StreamedWorkbook
208	* supports only reading.
209	*</pre>
210	* @param cellNumber
211	*/
212	public void setCellValue(Date value) {
213	// TODO Auto-generated method stub
214
215	}
216
217	/**
218	* <pre>
219	* Not supported right now, as StreamedWorkbook
220	* supports only reading.
221	*</pre>
222	* @param cellNumber
223	*/
224	public void setCellValue(Calendar value) {
225	// TODO Auto-generated method stub
226
227	}
228
229	/**
230	* <pre>
231	* Not supported right now, as StreamedWorkbook
232	* supports only reading.
233	*</pre>
234	* @param cellNumber
235	*/
236	public void setCellValue(RichTextString value) {
237	// TODO Auto-generated method stub
238
239	}
240
241	/**
242	* <pre>
243	* Not supported right now, as StreamedWorkbook
244	* supports only reading.
245	*</pre>
246	* @param cellNumber
247	*/
248	public void setCellValue(String value) {
249	// TODO Auto-generated method stub
250
251	}
252
253	/**
254	* <pre>
255	* Not supported right now, as StreamedWorkbook
256	* supports only reading.
257	*</pre>
258	* @param cellNumber
259	*/
260	public void setCellFormula(String formula) throws FormulaParseException {
261	// TODO Auto-generated method stub
262
263	}
264
265	/**
266	* <pre>
267	* Will be supported in future.
268	* </pre>
269	*/
270	public String getCellFormula() {
271	// TODO Auto-generated method stub
272	return null;
273	}
274
275	/**
276	* <pre>
277	* Will be supported in future.
278	* </pre>
279	*/
280	public double getNumericCellValue() {
281	// TODO Auto-generated method stub
282	return 0;
283	}
284
285	/**
286	* <pre>
287	* Will be supported in future.
288	* </pre>
289	*/
290	public Date getDateCellValue() {
291	// TODO Auto-generated method stub
292	return null;
293	}
294
295	/**
296	* <pre>
297	* Will be supported in future.
298	* </pre>
299	*/
300	public RichTextString getRichStringCellValue() {
301	// TODO Auto-generated method stub
302	return null;
303	}
304
305	/**
306	* <pre>
307	* Returns the String value of cell content
308	* </pre>
309	*/
310	public String getStringCellValue() {
311	return value;
312	}
313
314	/**
315	* <pre>
316	* Not supported right now, as StreamedWorkbook
317	* supports only reading.
318	*</pre>
319	*
320	*/
321	public void setCellValue(boolean value) {
322	// TODO Auto-generated method stub
323
324	}
325
326	/**
327	* <pre>
328	* Not supported right now, as StreamedWorkbook
329	* supports only reading.
330	*</pre>
331	*
332	*/
333	public void setCellErrorValue(byte value) {
334	// TODO Auto-generated method stub
335
336	}
337
338	/**
339	* <pre>
340	* Will be supported in future.
341	* </pre>
342	*/
343	public boolean getBooleanCellValue() {
344	// TODO Auto-generated method stub
345	return false;
346	}
347
348	/**
349	* <pre>
350	* Will be supported in future.
351	* </pre>
352	*/
353	public byte getErrorCellValue() {
354	// TODO Auto-generated method stub
355	return 0;
356	}
357
358	/**
359	* <pre>
360	* Not supported right now, as StreamedWorkbook
361	* supports only reading.
362	*</pre>
363	*
364	*/
365	public void setCellStyle(CellStyle style) {
366	// TODO Auto-generated method stub
367
368	}
369
370	/**
371	* <pre>
372	* Will be supported in future.
373	* </pre>
374	*/
375	public CellStyle getCellStyle() {
376	// TODO Auto-generated method stub
377	return null;
378	}
379
380	/**
381	* <pre>
382	* Not supported right now, as StreamedWorkbook
383	* supports only reading.
384	*</pre>
385	*
386	*/
387	public void setAsActiveCell() {
388	// TODO Auto-generated method stub
389
390	}
391
392	/**
393	* <pre>
394	* Will be supported in future.
395	* </pre>
396	*/
397	public CellAddress getAddress() {
398	// TODO Auto-generated method stub
399	return null;
400	}
401	/**
402	* <pre>
403	* Not supported right now, as StreamedWorkbook
404	* supports only reading.
405	*</pre>
406	*
407	*/
408	public void setCellComment(Comment comment) {
409	// TODO Auto-generated method stub
410
411	}
412
413	/**
414	* <pre>
415	* Will be supported in future.
416	* </pre>
417	*/
418	public Comment getCellComment() {
419	// TODO Auto-generated method stub
420	return null;
421	}
422
423	/**
424	* <pre>
425	* Not supported right now, as StreamedWorkbook
426	* supports only reading.
427	*</pre>
428	*
429	*/
430	public void removeCellComment() {
431	// TODO Auto-generated method stub
432
433	}
434
435	/**
436	* <pre>
437	* Will be supported in future.
438	* </pre>
439	*/
440	public Hyperlink getHyperlink() {
441	// TODO Auto-generated method stub
442	return null;
443	}
444
445	/**
446	* <pre>
447	* Not supported right now, as StreamedWorkbook
448	* supports only reading.
449	*</pre>
450	*
451	*/
452	public void setHyperlink(Hyperlink link) {
453	// TODO Auto-generated method stub
454
455	}
456
457	/**
458	* <pre>
459	* Not supported right now, as StreamedWorkbook
460	* supports only reading.
461	*</pre>
462	*
463	*/
464	public void removeHyperlink() {
465	// TODO Auto-generated method stub
466
467	}
468
469	/**
470	* <pre>
471	* Will be supported in future.
472	* </pre>
473	*/
474	public CellRangeAddress getArrayFormulaRange() {
475	// TODO Auto-generated method stub
476	return null;
477	}
478
479	/**
480	* <pre>
481	* Will be supported in future.
482	* </pre>
483	*/
484	public boolean isPartOfArrayFormulaGroup() {
485	// TODO Auto-generated method stub
486	return false;
487	}
488
489	/*@Override
490	protected void finalize() throws Throwable {
491	super.finalize();
492	value = null;
493	}*/
494
495
496
497	}

Line 0 Link Here

(-)a/src/ooxml/testcases/org/apache/poi/xssf/streaming/reader/TestStreamedWorkbook.java (+485 lines)
		1	/*
		2	* ====================================================================
		3	* Licensed to the Apache Software Foundation (ASF) under one or more
		4	* contributor license agreements. See the NOTICE file distributed with
		5	* this work for additional information regarding copyright ownership.
		6	* The ASF licenses this file to You under the Apache License, Version 2.0
		7	* (the "License"); you may not use this file except in compliance with
		8	* the License. You may obtain a copy of the License at
		9	*
		10	* http://www.apache.org/licenses/LICENSE-2.0
		11	*
		12	* Unless required by applicable law or agreed to in writing, software
		13	* distributed under the License is distributed on an "AS IS" BASIS,
		14	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		15	* See the License for the specific language governing permissions and
		16	* limitations under the License.
		17	* ====================================================================
		18	*/
		19	package org.apache.poi.xssf.streaming.reader;
		20
		21	import static org.junit.Assert.assertEquals;
		22	import static org.junit.Assert.fail;
		23
		24	import java.io.File;
		25	import java.util.Iterator;
		26
		27	import org.apache.poi.POIDataSamples;
		28	import org.junit.Test;
		29
		30
		31	public class TestStreamedWorkbook{
		32
		33	@Test
		34	public void testInvalidFilePath() throws Exception{
		35	StreamedWorkbook workbook = null;
		36	try {
		37	workbook = new StreamedWorkbook(null);
		38	fail("expected exception");
		39	} catch (Exception e) {
		40	assertEquals("No sheets found", e.getMessage());
		41	}
		42
		43	if(workbook != null)workbook.close();
		44
		45	}
		46
		47	@Test
		48	public void testInvalidFile() throws Exception{
		49	POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
		50	File f= files.getFile("InvalidFile.txt");
		51	StreamedWorkbook workbook = null;
		52	try {
		53
		54	workbook = new StreamedWorkbook(f.getAbsolutePath());
		55	workbook.getSheetIterator();
		56	} catch (Exception e) {
		57	assertEquals("No valid entries or contents found, this is not a valid OOXML (Office Open XML) file", e.getMessage());
		58	}
		59
		60	if(workbook != null)workbook.close();
		61	}
		62
		63
		64	@Test
65	public void testSheetCount() throws Exception{
66	POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
67	File f= files.getFile("SpreadSheetSample04022017.xlsx");
68	StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
69	int count = 0;
70
71	try {
72	Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
73
74	while(sheetIterator.hasNext()){
75	sheetIterator.next();
76	count++;
77	}
78
79	assertEquals(2, count);
80	} catch (Exception e) {
81
82	}
83
84	workbook.close();
85
86	}
87
88	@Test
89	public void testTotalNumberOfSheets() throws Exception{
90	POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
91	File f= files.getFile("SpreadSheetSample04022017.xlsx");
92	StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
93
94	try {
95	int sheetCount = workbook.getNumberOfSheets();
96
97	assertEquals(2, sheetCount);
98	} catch (Exception e) {
99	}
100
101	workbook.close();
102	}
103
104	/* @Test
105	public void testSheetAt() throws Exception{ //Not supported <TO DO>
106	POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
107	File f= files.getFile("SpreadSheetSample04022017.xlsx");
108	StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
109	int sheetIndex = 0;
110
111	StreamedSheet sheet = (StreamedSheet)workbook.getSheetAt(sheetIndex);
112
113	assertEquals(sheetIndex, sheet.getSheetNumber());
114
115	sheetIndex = 1;
116
117	sheet = (StreamedSheet)workbook.getSheetAt(sheetIndex);
118	System.out.println(sheet.getSheetNumber());
119
120	assertEquals(sheetIndex, sheet.getSheetNumber());
121
122	workbook.close();
123
124	}*/
125
126	@Test
127	public void testTotalRowCount() throws Exception{
128	POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
129	File f= files.getFile("SpreadSheetSample04022017.xlsx");
130	StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
131	int sheetCount = 0;
132
133	long count = 0;
134
135	Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
136
137	while((sheetIterator.hasNext()) && (sheetCount == 0)){
138	StreamedSheet sheet = sheetIterator.next();
139
140	Iterator<StreamedRow> rows = sheet.getAllRows();
141
142	while(rows.hasNext()){
143	rows.next();
144	count++;
145	}
146
147	assertEquals(6, count);
148	sheetCount++;
149	}
150
151	workbook.close();
152	}
153
154	@Test
155	public void testNRowCount() throws Exception{
156	POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
157	File f= files.getFile("SpreadSheetSample04022017.xlsx");
158	StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
159
160	long count = 0;
161	int sheetCount = 0;
162
163	Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
164
165	while((sheetIterator.hasNext()) && (sheetCount == 0)){
166	StreamedSheet sheet = sheetIterator.next();
167
168	Iterator<StreamedRow> rows = sheet.getNRows(4);
169
170	while(rows.hasNext()){
171	rows.next();
172	count++;
173	}
174
175	assertEquals(4, count);
176	sheetCount++;
177	}
178
179	workbook.close();
180	}
181
182	@Test
183	public void testCellCount() throws Exception{
184	POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
185	File f= files.getFile("SpreadSheetSample04022017.xlsx");
186	StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
187	int sheetCount = 0;
188
189	Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
190
191	while((sheetIterator.hasNext()) && (sheetCount == 0)){
192	StreamedSheet sheet = sheetIterator.next();
193
194	Iterator<StreamedRow> rows = sheet.getAllRows();
195
196	while(rows.hasNext()){
197	long count = 0;
198	StreamedRow row = rows.next();
199
200	Iterator<StreamedCell> cellIterator = row.getCellIterator();
201
202	while(cellIterator.hasNext()){
203	cellIterator.next();
204	count++;
205	}
206
207	assertEquals(7, count);
208	}
209
210	sheetCount++;
211	}
212
213	workbook.close();
214	}
215
216
217	@Test
218	public void testStartingRowAndCellNumber() throws Exception{
219	POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
220	File f= files.getFile("SpreadSheetSample04022017.xlsx");
221	StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
222	int sheetCount = 0;
223
224
225	Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
226
227	while((sheetIterator.hasNext()) && (sheetCount == 0)){
228	int rowCount = 0;
229	int cellCount = 0;
230	StreamedSheet sheet = sheetIterator.next();
231
232	Iterator<StreamedRow> rows = sheet.getAllRows();
233
234	while(rows.hasNext()){
235	StreamedRow row = rows.next();
236	if(rowCount == 0){
237	assertEquals(rowCount, row.getRowNum());
238	}
239	rowCount++;
240
241
242	Iterator<StreamedCell> cellIterator = row.getCellIterator();
243
244	while(cellIterator.hasNext()){
245	StreamedCell cell = cellIterator.next();
246	if(cellCount == 0){
247	assertEquals(cellCount, cell.getCellNumber());
248	}
249	cellCount++;
250
251	}
252
253	}
254
255	sheetCount++;
256	}
257
258	workbook.close();
259	}
260
261	@Test
262	public void testSheetData() throws Exception{
263	POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
264	File f= files.getFile("SpreadSheetSample04022017.xlsx");
265	StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
266	int sheetCount = 0;
267
268
269	Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
270
271	while((sheetIterator.hasNext()) && (sheetCount == 0)){
272	int rowCount = 0;
273
274	StreamedSheet sheet = sheetIterator.next();
275
276	Iterator<StreamedRow> rows = sheet.getAllRows();
277
278	while(rows.hasNext()){
279
280	StreamedRow row = rows.next();
281
282	int cellCount = 0;
283
284	Iterator<StreamedCell> cellIterator = row.getCellIterator();
285
286	while(cellIterator.hasNext()){
287	StreamedCell cell = cellIterator.next();
288	if(rowCount == 1){
289
290	if(cellCount == 0){
291	assertEquals("1", cell.getValue());
292	}else if(cellCount == 1){
293	assertEquals("Item1", cell.getValue());
294	}else if(cellCount == 2){
295	assertEquals("201", cell.getValue());
296	}else if(cellCount == 3){
297	assertEquals("100.11", cell.getValue());
298	}else if(cellCount == 4){
299	assertEquals("TRUE", cell.getValue());
300	}else if(cellCount == 5){
301	assertEquals("04/02/1917", cell.getValue());
302	}else if(cellCount == 6){
303	assertEquals("90.11", cell.getValue());
304	}
305	}else if(rowCount == 3){
306	if(cellCount == 4){
307	assertEquals(null, cell.getValue());
308	}
309	}
310
311	cellCount++;
312
313	}
314
315
316	rowCount++;
317
318	}
319
320	sheetCount++;
321	}
322
323	workbook.close();
324	}
325
326	@Test
327	public void testBatchData() throws Exception{
328
329	POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
330	File f= files.getFile("SpreadSheetSample04022017.xlsx");
331	StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
332	int sheetCount = 0;
333
334
335	Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
336
337	while(sheetIterator.hasNext()){
338
339	StreamedSheet sheet = sheetIterator.next();
340
341	if(sheetCount == 1){
342	Iterator<StreamedRow> rows = sheet.getNRows(1);
343
344	while(rows.hasNext()){
345	StreamedRow row = rows.next();
346	assertEquals("Row Number:0 --> Item \| item description \| Strore \| Price \| Promotion applied \| MFD \| Discount rate \|", row.toString().trim());
347	}
348
349
350	rows = sheet.getNRows(4);
351
352	while(rows.hasNext()){
353	StreamedRow row = rows.next();
354	assertEquals("Row Number:1 --> 1 \| Item1 \| 201 \| 100.11 \| TRUE \| 04/02/1917 \| 90.11 \|", row.toString().trim());
355	row = rows.next();
356	assertEquals("Row Number:2 --> 2 \| Item2 \| 202 \| 101.11 \| TRUE \| 05/02/1917 \| 91.11 \|", row.toString().trim());
357	row = rows.next();
358	assertEquals("Row Number:3 --> 3 \| Item3 \| 203 \| 102.11 \| TRUE \| 06/02/1917 \| 92.11 \|", row.toString().trim());
359	row = rows.next();
360	assertEquals("Row Number:4 --> 4 \| Item4 \| 204 \| 103.11 \| TRUE \| 07/02/1917 \| 93.11 \|", row.toString().trim());
361	}
362
363
364
365	rows = sheet.getNRows(4);
366
367	while(rows.hasNext()){
368	StreamedRow row = rows.next();
369	assertEquals("Row Number:5 --> 5 \| Item5 \| 205 \| 104.11 \| TRUE \| 08/02/1917 \| 94.11 \|", row.toString().trim());
370	row = rows.next();
371	assertEquals("Row Number:6 --> 6 \| Item6 \| 206 \| 105.11 \| TRUE \| 09/02/1917 \| 95.11 \|", row.toString().trim());
372	row = rows.next();
373	assertEquals("Row Number:7 --> 7 \| Item7 \| 207 \| 106.11 \| TRUE \| 10/02/1917 \| 96.11 \|", row.toString().trim());
374	row = rows.next();
375	assertEquals("Row Number:8 --> 8 \| Item8 \| 208 \| 107.11 \| FALSE \| 11/02/1917 \| 97.11 \|", row.toString().trim());
376	}
377
378	}
379
380
381	sheetCount++;
382
383	}
384
385	workbook.close();
386
387	}
388
389
390	@Test
391	public void testGetCell() throws Exception{
392	POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
393	File f= files.getFile("SpreadSheetSample04022017.xlsx");
394	StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
395	int sheetCount = 0;
396
397
398	Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
399
400	while((sheetIterator.hasNext()) && (sheetCount == 0)){
401
402	StreamedSheet sheet = sheetIterator.next();
403
404	Iterator<StreamedRow> rows = sheet.getAllRows();
405
406	while(rows.hasNext()){
407
408	StreamedRow row = rows.next();
409
410	if(row.getRowNum() == 3){
411	StreamedCell cell = (StreamedCell)row.getCell(5);
412	assertEquals("06/02/1917", cell.getValue());
413
414	try{
415	cell = (StreamedCell)row.getCell(10);
416	}catch(Exception exception){
417	assertEquals(true, exception instanceof IndexOutOfBoundsException);
418	}
419	}
420
421
422	}
423
424	sheetCount++;
425	}
426	}
427
428
429	@Test
430	public void testGetFirstAndLastCellNum() throws Exception{
431	POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
432	File f= files.getFile("SpreadSheetSample04022017.xlsx");
433	StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
434	int sheetCount = 0;
435
436
437	Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
438
439	while((sheetIterator.hasNext()) && (sheetCount == 0)){
440
441	StreamedSheet sheet = sheetIterator.next();
442
443	Iterator<StreamedRow> rows = sheet.getAllRows();
444
445	while(rows.hasNext()){
446
447	StreamedRow row = rows.next();
448
449	if(row.getRowNum() == 3){
450	StreamedCell cell = (StreamedCell)row.getCell(row.getFirstCellNum());
451	assertEquals("3", cell.getValue());
452	assertEquals("3", cell.getStringCellValue());
453
454	cell = (StreamedCell)row.getCell(row.getLastCellNum());
455	assertEquals("92.11", cell.getValue());
456	assertEquals("92.11", cell.getStringCellValue());
457	}
458	}
459
460	sheetCount++;
461	}
462	}
463
464	@Test
465	public void testReopenClosedWorkbook(){
466
467	try{
468	POIDataSamples files = POIDataSamples.getSpreadSheetInstance();
469	File f= files.getFile("SpreadSheetSample04022017.xlsx");
470	StreamedWorkbook workbook = new StreamedWorkbook(f.getAbsolutePath());
471
472	workbook.close();
473
474	Iterator<StreamedSheet> sheetIterator = workbook.getSheetIterator();
475	}catch(Exception e){
476	assertEquals("Workbook already closed", e.getMessage());
477	}
478
479
480	}
481
482
483
484
485	}