org.spdx.spdxspreadsheet.PackageInfoSheet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spdx-tools Show documentation
SPDX tools
There is a newer version: 2.2.8
/**
 * 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.Workbook;
import org.spdx.rdfparser.InvalidSPDXAnalysisException;
import org.spdx.rdfparser.SpdxDocumentContainer;
import org.spdx.rdfparser.license.AnyLicenseInfo;
import org.spdx.rdfparser.model.SpdxPackage;

/**
 * Abstract PackageInfoSheet to manage cross-version implementations
 * @author Gary O'Neall
 *
 */
public abstract class PackageInfoSheet extends AbstractSheet {
	
	protected String version;

	public PackageInfoSheet(Workbook workbook, String sheetName, String version) {
		super(workbook, sheetName);
		this.version = version;
	}
	
	public abstract void add(SpdxPackage pkgInfo) throws InvalidSPDXAnalysisException;
		
	public static String licensesToString(AnyLicenseInfo[] licenses) {
		if (licenses == null || licenses.length == 0) {
			return "";
		} else if (licenses.length == 1) {
			return licenses[0].toString();
		} else {
			StringBuilder sb = new StringBuilder(licenses[0].toString());
			for (int i = 1; i < licenses.length; i++) {
				sb.append(", ");
				sb.append(licenses[i].toString());
			}
			return sb.toString();
		}
	}
	
	public static void create(Workbook wb, String sheetName) {
		PackageInfoSheetV2d2.create(wb, sheetName);
	}

	/**
	 * Opens an existing PackageInfoSheet
	 * @param workbook
	 * @param packageInfoSheetName
	 * @param version Spreadsheet version
	 * @return
	 */
	public static PackageInfoSheet openVersion(Workbook workbook,
			String packageInfoSheetName, String version) {
		
		if (version.compareTo(SPDXSpreadsheet.VERSION_0_9_1) <= 0) {
			return new PackageInfoSheetV9d1(workbook, packageInfoSheetName, version);
		} else if (version.compareTo(SPDXSpreadsheet.VERSION_0_9_2) <= 0) {
			return new PackageInfoSheetV09d2(workbook, packageInfoSheetName, version);
		} else if (version.compareTo(SPDXSpreadsheet.VERSION_1_1_0) <= 0) {
			return new PackageInfoSheetV09d3(workbook, packageInfoSheetName, version);
		} else if (version.compareTo(SPDXSpreadsheet.VERSION_1_2_0) <= 0) {
			return new PackageInfoSheetV1d2(workbook, packageInfoSheetName, version);
		} else if (version.compareTo(SPDXSpreadsheet.VERSION_2_0_0) <= 0) {
			return new PackageInfoSheetV2d0(workbook, packageInfoSheetName, version);
		} else if (version.compareTo(SPDXSpreadsheet.VERSION_2_1_0) <= 0) {
			return new PackageInfoSheetV2d1(workbook, packageInfoSheetName, version);
		} else {
			return new PackageInfoSheetV2d2(workbook, packageInfoSheetName, version);
		}
	}

	/**
	 * @param rowNum row number of the package
	 * @return
	 * @throws SpreadsheetException 
	 */
	public abstract SpdxPackage[] getPackages(SpdxDocumentContainer container) throws SpreadsheetException;
}