com.dua3.meja.io.CsvWorkbookWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of meja Show documentation
Meja spreadsheet library - core classes
There is a newer version: 6.2.1
/*
 * Copyright 2015 Axel Howind ([email protected]).
 *
 * 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
 *
 * 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 com.dua3.meja.io;

import com.dua3.meja.model.Cell;
import com.dua3.meja.model.Row;
import com.dua3.meja.model.Sheet;
import com.dua3.meja.model.Workbook;
import com.dua3.utility.io.CsvWriter;
import com.dua3.utility.options.Arguments;

import java.io.BufferedWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.util.function.DoubleConsumer;

/**
 * @author Axel Howind ([email protected])
 */
public final class CsvWorkbookWriter implements WorkbookWriter {

    private Arguments options = Arguments.empty();

    private CsvWorkbookWriter() {
    }

    /**
     * Create instance.
     *
     * @return instance of {@code CsvWorkbookWriter}
     */
    public static CsvWorkbookWriter create() {
        return new CsvWorkbookWriter();
    }

    private static void writeSheets(Workbook workbook, final CsvWriter writer, DoubleConsumer updateProgress) throws IOException {
        long processedRows = 0;
        long totalRows = 0;
        for (Sheet sheet : workbook) {
            totalRows += sheet.getRowCount();
        }

        boolean writeSheetNames = workbook.getSheetCount() > 1;

        for (Sheet sheet : workbook) {
            if (writeSheetNames) {
                writer.addField("!" + sheet.getSheetName() + "!");
                writer.nextRow();
            }

            for (Row row : sheet) {
                for (Cell cell : row) {
                    writer.addField(cell.get());
                }
                updateProgress.accept((double) processedRows / totalRows);
                writer.nextRow();
            }
            writer.nextRow();
        }
    }

    @Override
    public void setOptions(Arguments importSettings) {
        this.options = importSettings;
    }

    /**
     * Write to a BufferedWriter. This is implemented because CSV is a character
     * format. The Encoding must be set correctly in the writer.
     *
     * @param workbook the workbook to write
     * @param out      the writer to write the workbook to
     * @throws IOException if an input/output error occurs
     */
    public void write(Workbook workbook, BufferedWriter out) throws IOException {
        // do not close the writer - it is the caller's responsibility
        CsvWriter csvWriter = CsvWriter.create(out, options);
        writeSheets(workbook, csvWriter, p -> {
        });
        csvWriter.flush();
    }

    /**
     * Write to a BufferedWriter. This is implemented because CSV is a character
     * format. The Encoding must be set correctly in the writer.
     *
     * @param workbook       the workbook to write
     * @param out            the writer to write the workbook to
     * @param updateProgress callback for progress updates
     * @throws IOException if an input/output error occurs
     */
    public void write(Workbook workbook, BufferedWriter out, DoubleConsumer updateProgress) throws IOException {
        // do not close the writer - it is the caller's responsibility
        CsvWriter csvWriter = CsvWriter.create(out, options);
        writeSheets(workbook, csvWriter, updateProgress);
        csvWriter.flush();
    }

    @Override
    public void write(Workbook workbook, OutputStream out, DoubleConsumer updateProgress) throws IOException {
        CsvWriter csvWriter = CsvWriter.create(out, options);
        writeSheets(workbook, csvWriter, updateProgress);
        csvWriter.flush();
    }
}