builders.dsl.spreadsheet.query.poi.PoiSheet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spreadsheet-builder-poi Show documentation
DSL for Writing Spreadsheets on the JVM
There is a newer version: 3.1.1.1
Show newest version
/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright 2020 Vladimir Orany.
 *
 * Licensed 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
 *
 *     https://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 builders.dsl.spreadsheet.query.poi;

import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.SheetVisibility;
import org.apache.poi.xssf.usermodel.XSSFSheet;
import builders.dsl.spreadsheet.api.Page;
import builders.dsl.spreadsheet.api.Sheet;

import java.util.*;

class PoiSheet implements Sheet {

    private final XSSFSheet xssfSheet;
    private final PoiWorkbook workbook;

    private Map rows;

    PoiSheet(PoiWorkbook workbook, XSSFSheet xssfSheet) {
        this.workbook = workbook;
        this.xssfSheet = xssfSheet;
    }

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

    @Override
    public PoiWorkbook getWorkbook() {
        return workbook;
    }

    public List getRows() {
        if (rows == null) {
            rows = new LinkedHashMap(xssfSheet.getLastRowNum());
            for (Row it : xssfSheet) {
                int oneBasedIndex = it.getRowNum() + 1;
                rows.put(oneBasedIndex, createRowWrapper(oneBasedIndex));
            }
        }

        return Collections.unmodifiableList(new ArrayList(rows.values()));
    }

    PoiRow getRowByNumber(int rowNumberStartingOne) {
        if (this.rows == null) {
            this.getRows();
        }
        return this.rows.get(rowNumberStartingOne);
    }

    @Override
    public Sheet getNext() {
        int current = getWorkbook().getWorkbook().getSheetIndex(xssfSheet.getSheetName());

        if (current == getWorkbook().getWorkbook().getNumberOfSheets() - 1) {
            return null;
        }
        XSSFSheet next = getWorkbook().getWorkbook().getSheetAt(current + 1);

        for (Sheet sheet : getWorkbook().getSheets()) {
            if (sheet.getName().equals(next.getSheetName())) {
                return sheet;
            }
        }


        return new PoiSheet(getWorkbook(), next);
    }

    @Override
    public Sheet getPrevious() {
        int current = getWorkbook().getWorkbook().getSheetIndex(xssfSheet.getSheetName());

        if (current == 0) {
            return null;
        }
        XSSFSheet next = getWorkbook().getWorkbook().getSheetAt(current - 1);
        for (Sheet sheet : getWorkbook().getSheets()) {
            if (sheet.getName().equals(next.getSheetName())) {
                return sheet;
            }
        }
        return new PoiSheet(getWorkbook(), next);
    }

    @Override
    public Page getPage() {
        return new PoiPage(this);
    }

    protected XSSFSheet getSheet() {
        return xssfSheet;
    }

    PoiRow createRowWrapper(int oneBasedRowNumber) {
        return new PoiRow(this, xssfSheet.getRow(oneBasedRowNumber - 1));
    }

    @Override
    public boolean isLocked() {
        return xssfSheet.isSheetLocked();
    }

    public boolean isHidden() {
        return xssfSheet.getWorkbook().getSheetVisibility(xssfSheet.getWorkbook().getSheetIndex(xssfSheet)) == SheetVisibility.HIDDEN;
    }

    public boolean isVisible() {
        return xssfSheet.getWorkbook().getSheetVisibility(xssfSheet.getWorkbook().getSheetIndex(xssfSheet)) == SheetVisibility.VISIBLE;
    }

    public boolean isVeryHidden() {
        return xssfSheet.getWorkbook().getSheetVisibility(xssfSheet.getWorkbook().getSheetIndex(xssfSheet)) == SheetVisibility.VERY_HIDDEN;
    }

}