/**
* 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.hssf.util.HSSFColor;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.Font;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
/**
* Sheet containing information about the origins of an SPDX document
* @author Gary O'Neall
*
*/
public class OriginsSheet extends AbstractSheet {
static final String CURRENT_VERSION = "0.8";
static final String[] SUPPORTED_VERSIONS = new String[] {CURRENT_VERSION};
static final int NUM_COLS = 6;
static final int SPREADSHEET_VERSION_COL = 0;
static final int SPDX_VERSION_COL = SPREADSHEET_VERSION_COL + 1;
static final int CREATED_BY_COL = SPDX_VERSION_COL + 1;
static final int CREATED_COL = CREATED_BY_COL + 1;
static final int DATA_LICENSE_COL = CREATED_COL + 1;
static final int AUTHOR_COMMENTS_COL = DATA_LICENSE_COL + 1;
static final int DATA_ROW_NUM = 1;
static final boolean[] REQUIRED = new boolean[] {true, true, true, true,
true, true, false, false};
static final String[] HEADER_TITLES = new String[] {"Spreadsheet Version",
"SPDXVersion", "CreatedBy", "Created", "DataLicense", "AuthorComments"};
static final int[] COLUMN_WIDTHS = new int[] {20, 20, 20, 16, 40, 60};
public OriginsSheet(Workbook workbook, String sheetName) {
super(workbook, sheetName);
}
@Override
public String verify() {
try {
if (sheet == null) {
return "Worksheet for SPDX Origins 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 Origins worksheet";
}
}
// validate version
String version = getDataCellStringValue(SPREADSHEET_VERSION_COL);
if (version == null) {
return "Invalid origins spreadsheet - no spreadsheet version found";
}
boolean supported = false;
version = version.trim();
for (int i = 0; i < SUPPORTED_VERSIONS.length; i++) {
if (SUPPORTED_VERSIONS[i].equals(version)) {
supported = true;
break;
}
}
if (!supported) {
return "Spreadsheet version "+version+" not supported.";
}
// validate rows
boolean done = false;
int rowNum = firstRowNum + 1;
while (!done) {
Row row = sheet.getRow(rowNum);
if (row == null || row.getCell(SPDX_VERSION_COL) == null) {
done = true;
} else {
String error = validateRow(row);
if (error != null) {
return error;
}
rowNum++;
}
}
return null;
} catch (Exception ex) {
return "Error in verifying SPDX Origins 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()+" in Origins Spreadsheet");
}
} else {
if (i == CREATED_COL) {
if (!(cell.getCellType() == Cell.CELL_TYPE_NUMERIC)) {
return "Created column in origin spreadsheet is not of type Date";
}
}
// 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);
}
CellStyle headerStyle = AbstractSheet.createHeaderStyle(wb);
Sheet sheet = wb.createSheet(sheetName);
Row row = sheet.createRow(0);
for (int i = 0; i < HEADER_TITLES.length; i++) {
sheet.setColumnWidth(i, COLUMN_WIDTHS[i]*256);
Cell cell = row.createCell(i);
cell.setCellStyle(headerStyle);
cell.setCellValue(HEADER_TITLES[i]);
}
Row dataRow = sheet.createRow(1);
Cell ssVersionCell = dataRow.createCell(SPREADSHEET_VERSION_COL);
ssVersionCell.setCellValue(CURRENT_VERSION);
}
private Row getDataRow() {
Row dataRow = sheet.getRow(firstRowNum + DATA_ROW_NUM);
if (dataRow == null) {
dataRow = sheet.createRow(firstRowNum + DATA_ROW_NUM);
}
return dataRow;
}
private Cell getOrCreateDataCell(int colNum) {
Cell cell = getDataRow().getCell(colNum);
if (cell == null) {
cell = getDataRow().createCell(colNum);
}
cell.setCellType(Cell.CELL_TYPE_NUMERIC);
//TODO: add date format cell.setCellStyle(dateStyle);
return cell;
}
private void setDataCellStringValue(int colNum, String value) {
getOrCreateDataCell(colNum).setCellValue(value);
}
private void setDataCellDateValue(int colNum, Date value) {
Cell cell = getOrCreateDataCell(colNum);
cell.setCellValue(value);
cell.setCellStyle(dateStyle);
}
private Date getDataCellDateValue(int colNum) {
Cell cell = getDataRow().getCell(colNum);
if (cell == null) {
return null;
} else {
return cell.getDateCellValue();
}
}
private String getDataCellStringValue(int colNum) {
Cell cell = getDataRow().getCell(colNum);
if (cell == null) {
return null;
} else {
return cell.getStringCellValue();
}
}
public void setAuthorComments(String comments) {
setDataCellStringValue(AUTHOR_COMMENTS_COL, comments);
}
public void setCreatedBy(String createdBy) {
setDataCellStringValue(CREATED_BY_COL, createdBy);
}
public void setDataLicense(String dataLicense) {
setDataCellStringValue(DATA_LICENSE_COL, dataLicense);
}
public void setSPDXVersion(String version) {
setDataCellStringValue(SPDX_VERSION_COL, version);
}
public void setSpreadsheetVersion(String version) {
setDataCellStringValue(SPREADSHEET_VERSION_COL, version);
}
public String getAuthorComments() {
return getDataCellStringValue(AUTHOR_COMMENTS_COL);
}
public Date getCreated() {
return getDataCellDateValue(CREATED_COL);
}
public String getDataLicense() {
return getDataCellStringValue(DATA_LICENSE_COL);
}
public String getSPDXVersion() {
return getDataCellStringValue(SPDX_VERSION_COL);
}
public String getSpreadsheetVersion(String version) {
return getDataCellStringValue(SPREADSHEET_VERSION_COL);
}
public void setCreatedBy(String[] createdBy) {
if (createdBy == null || createdBy.length < 1) {
setDataCellStringValue(CREATED_BY_COL, "");
int i = firstRowNum + DATA_ROW_NUM + 1;
Row nextRow = sheet.getRow(i);
while (nextRow != null) {
Cell createdByCell = nextRow.getCell(CREATED_BY_COL);
if (createdByCell != null) {
createdByCell.setCellValue("");
}
i++;
nextRow = sheet.getRow(i);
}
return;
}
setDataCellStringValue(CREATED_BY_COL, createdBy[0]);
for (int i = 1; i < createdBy.length; i++) {
Row row = sheet.getRow(firstRowNum + DATA_ROW_NUM + i);
if (row == null) {
row = sheet.createRow(firstRowNum + DATA_ROW_NUM + i);
}
Cell cell = row.getCell(CREATED_BY_COL);
if (cell == null) {
cell = row.createCell(CREATED_BY_COL);
}
cell.setCellValue(createdBy[i]);
}
}
public String[] getCreatedBy() {
// first count rows
int numRows = 0;
while (sheet.getRow(firstRowNum + DATA_ROW_NUM + numRows) != null &&
sheet.getRow(firstRowNum + DATA_ROW_NUM + numRows).getCell(CREATED_BY_COL) != null &&
!sheet.getRow(firstRowNum + DATA_ROW_NUM + numRows).getCell(CREATED_BY_COL).getStringCellValue().isEmpty()) {
numRows ++;
}
String[] retval = new String[numRows];
for (int i = 0; i < numRows; i++) {
retval[i] = sheet.getRow(firstRowNum + DATA_ROW_NUM + i).getCell(CREATED_BY_COL).getStringCellValue();
}
return retval;
}
public void setCreated(Date created) {
setDataCellDateValue(CREATED_COL, created);
}
}