Package org.spdx.tools

Class Summary

Class	Description
CompareMultpleSpdxDocs	Compares multiple SPDX documents and stores the results in a spreadsheet Usage: CompareSpdxDoc output.xls doc1 doc2 doc3 ...
CompareSpdxDocs	Command line application to compare two SPDX documents Usage: CompareSpdxDoc doc1 doc2 [output] where doc1 and doc2 are two SPDX documents in either RDF/XML or tag/value format and [output] is an optional SPDX document
ConvertLicenseListXml	Convert the license list XML from the schema used prior to June 2017 to the standard terms documented at https://docs.google.com/document/d/1z9n44xLH2MxT576KS_AbTOBtecyl5cw6RsrrQHibQtg/edit
GenerateVerificationCode	Generates a verification code for a specific directory
LicenseContainer	Container class for license information used by the LicenseRDFaGenerator
LicenseListPublisher	Publishes a new version of the license list.
LicenseRDFAGenerator	Converts a spreadsheet containing SPDX License information into RDFA HTML pages describing the licenses (root of output folder), license text files (text folder), license template files (template folder), and files containing only the HTML fragments for the license text (html folder).
Main	Dispatch to the individual tools
MatchingStandardLicenses	Tool to compare a license text to standard licenses.
MergeSpdxDocs	Commend line application to merge multiple SPDX documents into one single documents Usage: MergeSpdxDocs doc1 doc2 doc3 ...
RdfToHtml	Takes an input SPDX Document and produces the following HTML files in the specified directory: [spdxdocumentname]-document.html - Document level information [spdxpackagename]-package.html - Package level information (one per package found) [spdxpackagename]-packagefiles.html - File level information for all files found in the given package [spdxdocumentname]-packagefiles.html - File level information for all files described directly by the document [spdxdocumentname]-extractedlicenses.html - Extracted license information from the document The HTML pretty printer is based on a set of HTML templates found in the resources directory: SpdxDocHTMLTemplate.html - Document level HTML file template PackageHTMLTemplate.html - Package level HTML file template FilesHTMLTemplate.html - File level information HTML file template LicensesHTMLTemplate.html - Extracted license information HTML file template The template uses Mustache - see http://mustache.github.com/mustache.5.html
RdfToSpreadsheet	Translates an RDF XML file to a SPDX Spreadsheet format Usage: RdfToSpreadsheet rdfxmlfile.rdf spreadsheetfile.xls where rdfxmlfile.rdf is a valid SPDX RDF XML file and spreadsheetfile.xls is the output SPDX spreadsheeet file.
RdfToTag	Translates an RDF XML file to a tag-value format Usage: RdfToTag rdfxmlfile.rdf spdxfile.spdx where rdfxmlfile.rdf is a valid SPDX RDF XML file and spdxfile.spdx is the output SPDX tag-value file.
SpdxViewer	Simple pretty printer for SPDX RDF XML files.
SpreadsheetToRDF	Converts a spreadsheet to an SPDX RDF Analysis file Usage: SpreadsheetToRDF spreadsheetfile.xls rdfxmlfile.rdf where spreadsheetfile.xls is a valid SPDX Spreadsheet and rdfxmlfile.rdf is the output SPDX RDF Analysis file.
SpreadsheetToTag	Converts a spreadsheet to a tag-value format Usage: SpreadsheetToTag spreadsheetfile.xls spdxfile.spdx where spreadsheetfile.xls is a valid SPDX Spreadsheet and spdxfile.spdx is the output SPDX tag-value file.
TagToRDF	Translates a tag-value file to an RDF XML format Usage: TagToRDF spdxfile.spdx rdfxmlfile.rdf where spdxfile.spdx is a valid SPDX tag-value file and rdfxmlfile.rdf is the output SPDX RDF file.
TagToSpreadsheet	Translates an tag-value file to a SPDX Spreadsheet format Usage: TagToSpreadsheet spdxfile.spdx spreadsheetfile.xls where spdxfile.spdx is a valid SPDX tag-value file and spreadsheetfile.xls is the output SPDX spreadsheeet file.
Verify	Verifies an SPDX document and lists any verification errors

Exception Summary

Exception	Description
LicenseGeneratorException	Exceptions related to the license generator tool (a.k.a.
LicensePublisherException	Exceptions related to license publishing tools
LicenseXmlConverterException	Exceptions generated from the license XML conversion utility