org.spdx.spdxspreadsheet.ReviewersSheet.java Source code

Introduction

Here is the source code for org.spdx.spdxspreadsheet.ReviewersSheet.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 java.util.Date;

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 describing any reviewers for an SPDX Document
 * @author Gary O'Neall
 *
 */
public class ReviewersSheet extends AbstractSheet {

    static final int NUM_COLS = 3;
    static final int REVIEWER_COL = 0;
    static final int TIMESTAMP_COL = REVIEWER_COL + 1;
    static final int COMMENT_COL = TIMESTAMP_COL + 1;
    static final String[] HEADER_TITLES = new String[] { "Reviewer", "Review Date", "Reviewer Comment" };
    static final int[] COLUMN_WIDTHS = new int[] { 60, 20, 120 };
    static final boolean[] LEFT_WRAP = new boolean[] { true, false, true };
    static final boolean[] CENTER_NOWRAP = new boolean[] { false, true, false };

    static final boolean[] REQUIRED = new boolean[] { true, true, false };

    @SuppressWarnings("unused")
    private String version;

    public ReviewersSheet(Workbook workbook, String sheetName, String version) {
        super(workbook, sheetName);
        this.version = version;
    }

    @Override
    public String verify() {
        try {
            if (sheet == null) {
                return "Worksheet for SPDX Reviewers 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 SPDX Reviewers 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 SPDX Reviewers worksheet: " + ex.getMessage();
        }
    }

    private String validateRow(Row row) {
        for (int i = 0; i < NUM_COLS; i++) {
            Cell cell = row.getCell(i);
            if (REQUIRED[i] && cell == null) {
                return "Required cell " + HEADER_TITLES[i] + " missing for row " + String.valueOf(row.getRowNum())
                        + " in reviewer sheet";
            } else {
                if (i == TIMESTAMP_COL) {
                    if (!(cell.getCellType() == Cell.CELL_TYPE_NUMERIC)) {
                        return "Timestamp cell is not a numeric type for row " + String.valueOf(row.getRowNum())
                                + " in Reviewer sheet";
                    }
                }
                //            if (cell.getCellType() != Cell.CELL_TYPE_STRING) {
                //               return "Invalid cell format for "+HEADER_TITLES[i]+" for forw "+String.valueOf(row.getRowNum());
                //            }
            }
        }
        return null;
    }

    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 addReviewer(String reviewer, Date timeStamp, String reviewerComment) {
        Row row = addRow();
        row.createCell(REVIEWER_COL).setCellValue(reviewer);
        Cell dateCell = row.createCell(TIMESTAMP_COL);
        if (timeStamp != null) {
            dateCell.setCellValue(timeStamp);
            dateCell.setCellStyle(dateStyle);
        }
        if (reviewerComment != null && !reviewerComment.isEmpty()) {
            row.createCell(COMMENT_COL).setCellValue(reviewerComment);
        }
    }

    public String getReviewer(int rowNum) {
        Row row = sheet.getRow(rowNum);
        if (row == null) {
            return null;
        }
        Cell reviewer = row.getCell(REVIEWER_COL);
        if (reviewer == null) {
            return null;
        }
        return reviewer.getStringCellValue();
    }

    public Date getReviewerTimestamp(int rowNum) {
        Row row = sheet.getRow(rowNum);
        if (row == null) {
            return null;
        }
        Cell tsCell = row.getCell(TIMESTAMP_COL);
        if (tsCell == null) {
            return null;
        }
        return tsCell.getDateCellValue();
    }

    public String getReviewerComment(int rowNum) {
        Row row = sheet.getRow(rowNum);
        if (row == null) {
            return null;
        }
        Cell commentCell = row.getCell(COMMENT_COL);
        if (commentCell == null) {
            return null;
        }
        return commentCell.getStringCellValue();
    }
}