org.spdx.spdxspreadsheet.NonStandardLicensesSheet.java Source code

Introduction

Here is the source code for org.spdx.spdxspreadsheet.NonStandardLicensesSheet.java

Source

/**
 * Copyright (c) 2011 Source Auditor Inc.
 *   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 org.spdx.spdxspreadsheet;

import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;

/**
 * Sheet containing the text of any non-standard licenses found in an SPDX document
 * @author Gary O'Neall
 *
 */
public class NonStandardLicensesSheet extends AbstractSheet {

    static final int NUM_COLS = 2;
    static final int IDENTIFIER_COL = 0;
    static final int EXTRACTED_TEXT_COL = 1;

    static boolean[] REQUIRED = new boolean[] { true, true };
    static final String[] HEADER_TITLES = new String[] { "Identifier", "Extracted Text" };
    static final int[] COLUMN_WIDTHS = new int[] { 15, 120 };
    static final boolean[] LEFT_WRAP = new boolean[] { false, false };
    static final boolean[] CENTER_NOWRAP = new boolean[] { true, false };

    @SuppressWarnings("unused")
    private String version;

    /**
     * @param workbook
     * @param sheetName
     * @param version 
     */
    public NonStandardLicensesSheet(Workbook workbook, String sheetName, String version) {
        super(workbook, sheetName);
        this.version = version;
    }

    /* (non-Javadoc)
     * @see org.spdx.rdfparser.AbstractSheet#verify()
     */
    @Override
    public String verify() {
        try {
            if (sheet == null) {
                return "Worksheet for non-standard Licenses does not exist";
            }
            Row firstRow = sheet.getRow(firstRowNum);
            for (int i = 0; i < NUM_COLS; i++) {
                Cell cell = firstRow.getCell(i + firstCellNum);
                if (cell == null || cell.getStringCellValue() == null
                        || !cell.getStringCellValue().equals(HEADER_TITLES[i])) {
                    return "Column " + HEADER_TITLES[i] + " missing for non-standard Licenses worksheet";
                }
            }
            // validate rows
            boolean done = false;
            int rowNum = firstRowNum + 1;
            while (!done) {
                Row row = sheet.getRow(rowNum);
                if (row == null || row.getCell(firstCellNum) == null) {
                    done = true;
                } else {
                    String error = validateRow(row);
                    if (error != null) {
                        return error;
                    }
                    rowNum++;
                }
            }
            return null;
        } catch (Exception ex) {
            return "Error in verifying non-standard License work sheet: " + ex.getMessage();
        }
    }

    private String validateRow(Row row) {
        for (int i = 0; i < NUM_COLS; i++) {
            Cell cell = row.getCell(i);
            if (cell == null) {
                if (REQUIRED[i]) {
                    return "Required cell " + HEADER_TITLES[i] + " missing for row "
                            + String.valueOf(row.getRowNum());
                }
            } else {
                //            if (cell.getCellType() != Cell.CELL_TYPE_STRING) {
                //               return "Invalid cell format for "+HEADER_TITLES[i]+" for forw "+String.valueOf(row.getRowNum());
                //            }
            }
        }
        return null;
    }

    /*
     * Create a blank worksheet NOTE: Replaces / deletes existing sheet by the same name
     */
    public static void create(Workbook wb, String sheetName) {
        int sheetNum = wb.getSheetIndex(sheetName);
        if (sheetNum >= 0) {
            wb.removeSheetAt(sheetNum);
        }
        Sheet sheet = wb.createSheet(sheetName);
        CellStyle headerStyle = AbstractSheet.createHeaderStyle(wb);
        CellStyle centerStyle = AbstractSheet.createCenterStyle(wb);
        CellStyle wrapStyle = AbstractSheet.createLeftWrapStyle(wb);

        Row row = sheet.createRow(0);
        for (int i = 0; i < HEADER_TITLES.length; i++) {
            sheet.setColumnWidth(i, COLUMN_WIDTHS[i] * 256);
            if (LEFT_WRAP[i]) {
                sheet.setDefaultColumnStyle(i, wrapStyle);
            } else if (CENTER_NOWRAP[i]) {
                sheet.setDefaultColumnStyle(i, centerStyle);
            }
            Cell cell = row.createCell(i);
            cell.setCellStyle(headerStyle);
            cell.setCellValue(HEADER_TITLES[i]);
        }
    }

    public void add(String identifier, String extractedText) {
        Row row = addRow();
        Cell idCell = row.createCell(IDENTIFIER_COL);
        idCell.setCellValue(identifier);
        Cell extractedTextCell = row.createCell(EXTRACTED_TEXT_COL);
        extractedTextCell.setCellValue(extractedText);
    }

    public String getIdentifier(int rowNum) {
        Row row = sheet.getRow(rowNum);
        if (row == null) {
            return null;
        }
        Cell idCell = row.getCell(IDENTIFIER_COL);
        if (idCell == null) {
            return null;
        }
        return idCell.getStringCellValue();
    }

    public String getExtractedText(int rowNum) {
        Row row = sheet.getRow(rowNum);
        if (row == null) {
            return null;
        }
        Cell extractedTextCell = row.getCell(EXTRACTED_TEXT_COL);
        if (extractedTextCell == null) {
            return null;
        }
        return extractedTextCell.getStringCellValue();
    }
}