net.croz.nrich.excel.api.request.CreateExcelReportRequest Maven / Gradle / Ivy

Go to download
/*
 *  Copyright 2020-2023 CROZ d.o.o, the original author or authors.
 *
 *  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 net.croz.nrich.excel.api.request;

import lombok.Builder;
import lombok.Getter;
import net.croz.nrich.excel.api.model.ColumnDataFormat;
import net.croz.nrich.excel.api.model.MultiRowDataProvider;
import net.croz.nrich.excel.api.model.TemplateVariable;

import java.io.OutputStream;
import java.util.List;

@Getter
@Builder
public class CreateExcelReportRequest {

    /**
     * OutputStream where report will be written to (keep in mind closing of it is users responsibility).
     */
    private final OutputStream outputStream;

    /**
     * Path to template (template is resolved from this path using Spring's ResourceLoader).
     */
    private final String templatePath;

    /**
     * List of {@link TemplateVariable} instances that will be used to replace variables defined in the template.
     */
    private final List templateVariableList;

    /**
     * List of {@link ColumnDataFormat} instances that allow for overriding of data format for specific columns.
     */
    private final List columnDataFormatList;

    /**
     * Row indexes from which data should be written to report (if for example template holds column headers in first a couple of rows).
     */
    private final int firstRowIndex;

    /**
     * Batch size used for data fetch from {@link MultiRowDataProvider}.
     */
    private final int batchSize;

    /**
     * Interface that is used for fetching data, it should return multiple row data.
     */
    private final MultiRowDataProvider multiRowDataProvider;

    /**
     * Determines if column size should be calculated based on content.
     */
    private final boolean autoSizeColumns;

    /**
     * Creates {@link CreateExcelReportRequest} Builder instance from flat data.
     *
     * @param data Flat data to be written
     * @return A {@link CreateExcelReportRequest} builder instance
     */
    public static CreateExcelReportRequest.CreateExcelReportRequestBuilder fromFlatData(Object[][] data) {
        return CreateExcelReportRequest.builder().multiRowDataProvider((start, limit) -> start == 0 ? data : null);
    }

    /**
     * Creates {@link CreateExcelReportRequest} Builder instance from {@link MultiRowDataProvider} instance.
     *
     * @param multiRowDataProvider Row provider for data to be written
     * @return A {@link CreateExcelReportRequest} builder instance
     */
    public static CreateExcelReportRequest.CreateExcelReportRequestBuilder fromRowDataProvider(MultiRowDataProvider multiRowDataProvider) {
        return CreateExcelReportRequest.builder().multiRowDataProvider(multiRowDataProvider);
    }

    /**
     * CreateExcelReportRequest builder (explicit to avoid errors while publishing javadoc).
     */
    public static class CreateExcelReportRequestBuilder { // NOSONAR
    }

    private static CreateExcelReportRequest.CreateExcelReportRequestBuilder builder() {
        return new CreateExcelReportRequest.CreateExcelReportRequestBuilder();
    }
}