com.yqboots.initializer.core.builder.excel.MenuItemSheetBuilder.java Source code

Introduction

Here is the source code for com.yqboots.initializer.core.builder.excel.MenuItemSheetBuilder.java

Source

/*
 *
 *  * Copyright 2015-2016 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
 *  *
 *  *      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.yqboots.initializer.core.builder.excel;

import com.yqboots.fss.core.support.FileType;
import com.yqboots.initializer.core.ProjectMetadata;
import com.yqboots.menu.core.MenuItem;
import com.yqboots.menu.core.MenuItems;
import org.apache.commons.lang3.StringUtils;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.springframework.oxm.Marshaller;
import org.springframework.util.Assert;

import javax.xml.transform.stream.StreamResult;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;

/**
 * It builds the Excel sheet to retrieve MenuItem.
 *
 * @author Eric H B Zhan
 * @since 1.0.0
 */
public class MenuItemSheetBuilder extends AbstractSheetBuilder {
    private final Marshaller marshaller;

    private final MenuItemProperties properties;

    /**
     * Constructs the MenuItemSheetBuilder.
     *
     * @param marshaller marshal the generated MenuItem to XML
     * @param properties properties for MenuItem
     */
    public MenuItemSheetBuilder(final Marshaller marshaller, MenuItemProperties properties) {
        super(properties.getSheetName());
        this.marshaller = marshaller;
        this.properties = properties;
    }

    @Override
    protected void formatChecking(final Sheet sheet) {
        // get the title row
        Row row = sheet.getRow(0);

        Cell nameCell = row.getCell(0);
        Cell urlCell = row.getCell(1);
        Cell menuGroupCell = row.getCell(2);
        Cell menuItemGroupCell = row.getCell(3);

        Assert.isTrue(StringUtils.equalsIgnoreCase(nameCell.getStringCellValue(), "name"),
                "Column 'name' is required");
        Assert.isTrue(StringUtils.equalsIgnoreCase(urlCell.getStringCellValue(), "url"),
                "Column 'URL' is required");
        Assert.isTrue(StringUtils.equalsIgnoreCase(menuGroupCell.getStringCellValue(), "Menu Group"),
                "Column 'Menu Group' is required");
        Assert.isTrue(StringUtils.equalsIgnoreCase(menuItemGroupCell.getStringCellValue(), "Menu Item Group"),
                "Column 'Menu Item Group' is required");
    }

    @Override
    protected void doBuild(final Path root, final ProjectMetadata metadata, final Sheet sheet) throws IOException {
        final List<MenuItem> items = new ArrayList<>();

        for (Row row : sheet) {
            // ignore the header
            if (row.getRowNum() < 1) {
                continue;
            }

            items.add(getMenuItem(row));
        }

        // generate an XML for the application importing into Database
        Path targetPath = Paths.get(root + File.separator + properties.getExportRelativePath());
        if (!Files.exists(targetPath)) {
            Files.createDirectories(targetPath);
        }

        Path file = Paths.get(targetPath + File.separator + properties.getExportName() + FileType.DOT_XML);
        try (FileWriter writer = new FileWriter(file.toFile())) {
            marshaller.marshal(new MenuItems(items), new StreamResult(writer));
        }
    }

    /**
     * Gets MenuItem from row.
     *
     * @param row row of a sheet on Excel
     * @return MenuItem
     */
    private MenuItem getMenuItem(final Row row) {
        MenuItem result = new MenuItem();
        result.setName(row.getCell(0).getStringCellValue());
        result.setUrl(row.getCell(1).getStringCellValue());
        result.setMenuGroup(row.getCell(2).getStringCellValue());
        result.setMenuItemGroup(row.getCell(3).getStringCellValue());
        return result;
    }
}