ExcelCompare2.POISpreadSheet.java Source code

Java tutorial

Introduction

Here is the source code for ExcelCompare2.POISpreadSheet.java

Source

/* MIT License
 *
 * Copyright (c) 2016 James MacAdie
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package ExcelCompare2;

import java.io.File;
import java.io.IOException;
import java.util.LinkedList;
import java.util.Iterator;
import java.util.List;
import org.apache.poi.EncryptedDocumentException;
import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellType;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.usermodel.WorkbookFactory;
import org.apache.poi.ss.usermodel.DataFormatter;
import org.apache.poi.ss.usermodel.CellStyle;

/**
 *
 * @author james.macadie
 */
public class POISpreadSheet implements ISpreadSheet {

    private final Workbook _wb;
    private final Iterator<POISheet> _iter;
    private POISheet _sheet;
    final DataFormatter _formatter;

    public POISpreadSheet(String fName) throws Exception {
        try {
            _wb = loadSpreadSheet(fName);
            _iter = getSheetIterator();
            _sheet = _iter.next();
            _formatter = new DataFormatter(); //creating formatter using the default locale
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    private static Workbook loadSpreadSheet(String file) throws Exception {
        // assume file is excel by default
        Exception readException;
        try {
            Workbook workbook = WorkbookFactory.create(new File(file));
            return workbook;
        } catch (IOException | InvalidFormatException | EncryptedDocumentException e) {
            readException = e;
        }
        throw new RuntimeException("Failed to read as excel file: " + file, readException);
    }

    @Override
    public boolean hasNext() {
        return _iter.hasNext();
    }

    @Override
    public void next() {
        if (_iter.hasNext())
            _sheet = _iter.next();
    }

    @Override
    public String getSheetName() {
        return _sheet.getName();
    }

    @Override
    public CondensedFormulae getCondensedFormulae() {
        Iterator<POIRow> iterRow = _sheet.getRowIterator();
        Iterator<POICell> iterCell;
        List<Formula> f = new LinkedList<>();
        // Loop through all rows
        while (iterRow.hasNext()) {
            // Loop through all cells in the row
            iterCell = iterRow.next().getCellIterator();
            while (iterCell.hasNext()) {
                // Add each formula to the array list
                f.add(iterCell.next().getFormula());
            }
        }
        // Construct the Condensed Formulae object from the array of Formulae
        // on the sheet
        return new CondensedFormulae(f, true);
    }

    private Iterator<POISheet> getSheetIterator() {
        return new Iterator<POISheet>() {

            private int currSheetIdx = 0;

            @Override
            public boolean hasNext() {
                return currSheetIdx < _wb.getNumberOfSheets();
            }

            @Override
            public POISheet next() {
                Sheet sheet = _wb.getSheetAt(currSheetIdx);
                POISheet poiSheet = new POISheet(sheet, currSheetIdx);
                currSheetIdx++;
                return poiSheet;
            }

            @Override
            public void remove() {
                throw new UnsupportedOperationException();
            }
        };
    }

    class POISheet {

        private final Sheet sheet;
        private final int sheetIdx;

        public POISheet(Sheet sheet, int sheetIdx) {
            this.sheet = sheet;
            this.sheetIdx = sheetIdx;
        }

        public String getName() {
            return sheet.getSheetName();
        }

        public int getSheetIndex() {
            return sheetIdx;
        }

        public Iterator<POIRow> getRowIterator() {
            final Iterator<Row> rowIterator = sheet.rowIterator();
            return new Iterator<POIRow>() {

                @Override
                public boolean hasNext() {
                    return rowIterator.hasNext();
                }

                @Override
                public POIRow next() {
                    return new POIRow(rowIterator.next());
                }

                @Override
                public void remove() {
                    throw new UnsupportedOperationException();
                }
            };
        }
    }

    class POIRow {

        private final Row _row;

        public POIRow(Row row) {
            this._row = row;
        }

        public int getRowIndex() {
            return _row.getRowNum();
        }

        public Iterator<POICell> getCellIterator() {
            final Iterator<Cell> cellIterator = _row.cellIterator();
            return new Iterator<POICell>() {

                @Override
                public boolean hasNext() {
                    return cellIterator.hasNext();
                }

                @Override
                public POICell next() {
                    return new POICell(cellIterator.next());
                }

                @Override
                public void remove() {
                    throw new UnsupportedOperationException();
                }
            };
        }
    }

    class POICell {

        private final Cell _cell;

        public POICell(Cell cell) {
            this._cell = cell;
        }

        public int getRowIndex() {
            return _cell.getRowIndex();
        }

        public int getColumnIndex() {
            return _cell.getColumnIndex();
        }

        public Formula getFormula() {
            String formula = null;
            String value;

            CellType cellType = _cell.getCellTypeEnum();
            // TODO: drop Enum suffix if upgrade beyond POI 4.0
            if (cellType == CellType.FORMULA) {
                formula = "=" + _cell.getCellFormula();
                cellType = _cell.getCachedFormulaResultTypeEnum();
                // TODO: drop Enum suffix if upgrade beyond POI 4.0
            }
            switch (cellType) {
            case NUMERIC:
                CellStyle style = _cell.getCellStyle();
                value = _formatter.formatRawCellContents(_cell.getNumericCellValue(), style.getDataFormat(),
                        style.getDataFormatString());
                break;
            case BOOLEAN:
                value = String.valueOf(_cell.getBooleanCellValue());
                break;
            case ERROR:
                value = String.valueOf(_cell.getErrorCellValue());
                break;
            default:
                value = _cell.getStringCellValue();
                break;
            }

            // Create the formula and return it
            return new Formula(formula, new CellRef(_cell.getRowIndex() + 1, _cell.getColumnIndex() + 1), value);
        }
    }
}