public class SPDXDocument extends Object implements SpdxRdfConstants
addNonStandardLicense(licenseText) can be called to
create a new unique Non-Standard License.| Modifier and Type | Class and Description |
|---|---|
class |
SPDXDocument.SPDXPackage
Simple class representing an SPDX Package.
|
| Modifier and Type | Field and Description |
|---|---|
static String |
CURRENT_IMPLEMENTATION_VERSION |
static String |
CURRENT_SPDX_VERSION |
protected int |
nextLicenseRef
Keeps tract of the next license reference number when generating the license ID's for
non-standard licenses
|
static String |
ONE_DOT_ONE_SPDX_VERSION |
static String |
ONE_DOT_ZERO_SPDX_VERSION |
static String |
POINT_EIGHT_SPDX_VERSION |
static String |
POINT_NINE_SPDX_VERSION |
ALGORITHM_SHA1, CLASS_DOAP_PROJECT, CLASS_SPDX_ANALYSIS, CLASS_SPDX_ANY_LICENSE_INFO, CLASS_SPDX_CHECKSUM, CLASS_SPDX_CONJUNCTIVE_LICENSE_SET, CLASS_SPDX_CREATION_INFO, CLASS_SPDX_DISJUNCTIVE_LICENSE_SET, CLASS_SPDX_EXTRACTED_LICENSING_INFO, CLASS_SPDX_FILE, CLASS_SPDX_PACKAGE, CLASS_SPDX_REVIEW, CLASS_SPDX_SIMPLE_LICENSE_INFO, CLASS_SPDX_STANDARD_LICENSE, CLASS_SPDX_VERIFICATIONCODE, CREATOR_PREFIX_ORGANIZATION, CREATOR_PREFIX_PERSON, CREATOR_PREFIX_TOOL, DOAP_NAMESPACE, FILE_TYPE_ARCHIVE, FILE_TYPE_BINARY, FILE_TYPE_OTHER, FILE_TYPE_SOURCE, LICENSE_ID_PATTERN, NOASSERTION_VALUE, NON_STD_LICENSE_ID_PRENUM, NONE_VALUE, OWL_NAMESPACE, PROP_CHECKSUM_ALGORITHM, PROP_CHECKSUM_ALGORITHM_SHA1, PROP_CHECKSUM_VALUE, PROP_CREATION_CREATED, PROP_CREATION_CREATOR, PROP_EXTRACTED_TEXT, PROP_FILE_ARTIFACTOF, PROP_FILE_CHECKSUM, PROP_FILE_CONTRIBUTOR, PROP_FILE_COPYRIGHT, PROP_FILE_FILE_DEPENDENCY, PROP_FILE_LIC_COMMENTS, PROP_FILE_LICENSE, PROP_FILE_NAME, PROP_FILE_NOTICE, PROP_FILE_SEEN_LICENSE, PROP_FILE_TYPE, PROP_FILE_TYPE_ARCHIVE, PROP_FILE_TYPE_BINARY, PROP_FILE_TYPE_OTHER, PROP_FILE_TYPE_SOURCE, PROP_LICENSE_ID, PROP_LICENSE_LIST_VERSION, PROP_LICENSE_NAME, PROP_LICENSE_SET_MEMEBER, PROP_LICENSE_TEXT, PROP_OWL_SAME_AS, PROP_PACKAGE_CHECKSUM, PROP_PACKAGE_CONCLUDED_LICENSE, PROP_PACKAGE_DECLARED_COPYRIGHT, PROP_PACKAGE_DECLARED_LICENSE, PROP_PACKAGE_DECLARED_NAME, PROP_PACKAGE_DESCRIPTION, PROP_PACKAGE_DOWNLOAD_URL, PROP_PACKAGE_FILE, PROP_PACKAGE_FILE_NAME, PROP_PACKAGE_LICENSE_COMMENT, PROP_PACKAGE_LICENSE_INFO_FROM_FILES, PROP_PACKAGE_ORIGINATOR, PROP_PACKAGE_SHORT_DESC, PROP_PACKAGE_SOURCE_INFO, PROP_PACKAGE_SUPPLIER, PROP_PACKAGE_VERIFICATION_CODE, PROP_PACKAGE_VERSION_INFO, PROP_PROJECT_HOMEPAGE, PROP_PROJECT_NAME, PROP_REVIEW_DATE, PROP_REVIEW_REVIEWER, PROP_SPDX_CREATION_INFO, PROP_SPDX_DATA_LICENSE, PROP_SPDX_FILE, PROP_SPDX_NONSTANDARD_LICENSES, PROP_SPDX_PACKAGE, PROP_SPDX_REVIEWED_BY, PROP_SPDX_VERSION, PROP_STD_LICENSE_HEADER_VERSION_1, PROP_STD_LICENSE_NAME, PROP_STD_LICENSE_NAME_VERSION_1, PROP_STD_LICENSE_NOTES_VERSION_1, PROP_STD_LICENSE_NOTICE, PROP_STD_LICENSE_OSI_APPROVED, PROP_STD_LICENSE_OSI_APPROVED_VERSION_1, PROP_STD_LICENSE_TEMPLATE, PROP_STD_LICENSE_TEMPLATE_VERSION_1, PROP_STD_LICENSE_URL_VERSION_1, PROP_VALUE_NOASSERTION, PROP_VALUE_NONE, PROP_VERIFICATIONCODE_IGNORED_FILES, PROP_VERIFICATIONCODE_VALUE, RDF_NAMESPACE, RDF_PROP_RESOURCE, RDF_PROP_TYPE, RDFS_NAMESPACE, RDFS_PROP_COMMENT, RDFS_PROP_LABEL, RDFS_PROP_SEE_ALSO, SPDX_DATA_LICENSE_ID, SPDX_DATA_LICENSE_ID_VERSION_1_0, SPDX_DATE_FORMAT, SPDX_NAMESPACE, SPDX_VERSION_PATTERN, STANDARD_LICENSE_URL, TERM_LICENSE_NOASSERTION, TERM_LICENSE_NONE, URI_VALUE_NOASSERTION, URI_VALUE_NONE| Constructor and Description |
|---|
SPDXDocument(com.hp.hpl.jena.rdf.model.Model model) |
| Modifier and Type | Method and Description |
|---|---|
void |
addNewExtractedLicenseInfo(SPDXNonStandardLicense license)
Adds the license as a new ExtractedLicenseInfo
|
SPDXNonStandardLicense |
addNewExtractedLicenseInfo(String licenseText)
Adds a new non-standard license containing the text provided.
|
void |
createSpdxAnalysis(String uri)
Creates a new empty SPDX Document with the current SPDX document version.
|
void |
createSpdxAnalysis(String uri,
String spdxVersion)
Creates a new empty SPDX Document.
|
void |
createSpdxPackage() |
void |
createSpdxPackage(String uri)
Creates an empty SPDX package
|
protected boolean |
extractedLicenseExists(String id) |
static String |
formNonStandardLicenseID(int idNum) |
String |
getCreated()
Deprecated.
|
String |
getCreatorComment()
Deprecated.
|
SPDXCreatorInformation |
getCreatorInfo() |
String[] |
getCreators()
Deprecated.
|
SPDXStandardLicense |
getDataLicense() |
String |
getDocumentComment() |
SPDXNonStandardLicense[] |
getExtractedLicenseInfos() |
SPDXFile[] |
getFileReferences() |
int |
getLicenseRefNum(String licenseID)
Parses a license ID and return the integer representing the ID number (e.g.
|
com.hp.hpl.jena.rdf.model.Model |
getModel() |
String |
getNextLicenseRef() |
SPDXReview[] |
getReviewers() |
String |
getSpdxDocUri() |
SPDXDocument.SPDXPackage |
getSpdxPackage() |
String |
getSpdxVersion() |
void |
setCreationInfo(SPDXCreatorInformation creator) |
void |
setDataLicense(SPDXStandardLicense dataLicense) |
void |
setDocumentComment(String comment) |
void |
setExtractedLicenseInfos(SPDXNonStandardLicense[] nonStandardLicenses)
Resets all ExtractedLicenseInfos to nonStandardLicenses.
|
void |
setModel(com.hp.hpl.jena.rdf.model.Model model) |
void |
setReviewers(SPDXReview[] reviewers) |
void |
setSpdxVersion(String spdxVersion) |
ArrayList<String> |
verify()
Verifies the spdx document
|
String |
verifySpdxVersion(String spdxVersion) |
public static final String POINT_EIGHT_SPDX_VERSION
public static final String POINT_NINE_SPDX_VERSION
public static final String ONE_DOT_ZERO_SPDX_VERSION
public static final String ONE_DOT_ONE_SPDX_VERSION
public static final String CURRENT_SPDX_VERSION
public static final String CURRENT_IMPLEMENTATION_VERSION
protected int nextLicenseRef
public SPDXDocument(com.hp.hpl.jena.rdf.model.Model model)
throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisExceptionpublic int getLicenseRefNum(String licenseID) throws InvalidSPDXAnalysisException
licenseID - InvalidSPDXAnalysisExceptionpublic static String formNonStandardLicenseID(int idNum)
public ArrayList<String> verify()
public String getSpdxVersion() throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisExceptionpublic void setDocumentComment(String comment) throws InvalidSPDXAnalysisException
comment - the documentComment to setInvalidSPDXAnalysisExceptionpublic String getDocumentComment() throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisExceptionpublic void setSpdxVersion(String spdxVersion) throws InvalidSPDXAnalysisException
spdxVersion - the spdxVersion to setInvalidSPDXAnalysisExceptionpublic SPDXStandardLicense getDataLicense() throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisExceptionpublic void setDataLicense(SPDXStandardLicense dataLicense) throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisExceptionpublic SPDXFile[] getFileReferences() throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisException@Deprecated public String[] getCreators() throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisExceptionpublic SPDXCreatorInformation getCreatorInfo() throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisExceptionpublic void setCreationInfo(SPDXCreatorInformation creator) throws InvalidSPDXAnalysisException
creators - the creators of the analysisInvalidSPDXDocExceptionInvalidSPDXAnalysisException@Deprecated public String getCreatorComment() throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisExceptionpublic SPDXReview[] getReviewers() throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisExceptionpublic void setReviewers(SPDXReview[] reviewers) throws InvalidSPDXAnalysisException
reviewers - the reviewers to setInvalidSPDXAnalysisException@Deprecated public String getCreated() throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisExceptionpublic SPDXDocument.SPDXPackage getSpdxPackage() throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisExceptionpublic void createSpdxPackage(String uri) throws InvalidSPDXAnalysisException
uri - Unique URI representing the SPDX packageInvalidSPDXAnalysisExceptionpublic void createSpdxPackage()
throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisExceptionpublic SPDXNonStandardLicense[] getExtractedLicenseInfos() throws InvalidSPDXAnalysisException
InvalidSPDXAnalysisExceptionpublic void setExtractedLicenseInfos(SPDXNonStandardLicense[] nonStandardLicenses) throws InvalidSPDXAnalysisException
nonStandardLicenses - the nonStandardLicenses to setInvalidSPDXAnalysisExceptionpublic SPDXNonStandardLicense addNewExtractedLicenseInfo(String licenseText) throws InvalidSPDXAnalysisException
licenseText - InvalidSPDXAnalysisExceptionpublic void addNewExtractedLicenseInfo(SPDXNonStandardLicense license) throws InvalidSPDXAnalysisException
license - InvalidSPDXAnalysisExceptionprotected boolean extractedLicenseExists(String id) throws InvalidSPDXAnalysisException
id - InvalidSPDXAnalysisExceptionpublic String getNextLicenseRef()
public String getSpdxDocUri()
public com.hp.hpl.jena.rdf.model.Model getModel()
public void setModel(com.hp.hpl.jena.rdf.model.Model model)
model - the model to setpublic void createSpdxAnalysis(String uri) throws InvalidSPDXAnalysisException
uri - URI for the SPDX DocumentInvalidSPDXAnalysisExceptionpublic void createSpdxAnalysis(String uri, String spdxVersion) throws InvalidSPDXAnalysisException
uri - URI for the SPDX DocumentspdxVersion - The version of SPDX analysis to create (impacts the data license for some versions)InvalidSPDXAnalysisExceptionCopyright © 2014 Linux Foundation. All Rights Reserved.