org.spdx.rdfparser.model

Class SpdxPackage

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.model.SpdxElement

org.spdx.rdfparser.model.SpdxItem

org.spdx.rdfparser.model.SpdxPackage

All Implemented Interfaces:

Cloneable, Comparable<SpdxPackage>, IRdfModel, SpdxRdfConstants

public class SpdxPackage
extends SpdxItem
implements SpdxRdfConstants, Comparable<SpdxPackage>

A Package represents a collection of software files that are delivered as a single functional component.

Author:

Gary O'Neall

Field Summary

Fields inherited from class org.spdx.rdfparser.model.SpdxElement

annotations, comment, name, relationships

Fields inherited from class org.spdx.rdfparser.model.RdfModelObject

model, modelContainer, node, refreshOnGet, resource

Fields inherited from interface org.spdx.rdfparser.SpdxRdfConstants

ALGORITHM_SHA1, CLASS_ANNOTATION, CLASS_DOAP_PROJECT, CLASS_EXTERNAL_DOC_REF, CLASS_OR_LATER_OPERATOR, CLASS_RELATIONSHIP, CLASS_SPDX_ANY_LICENSE_INFO, CLASS_SPDX_CHECKSUM, CLASS_SPDX_CONJUNCTIVE_LICENSE_SET, CLASS_SPDX_CREATION_INFO, CLASS_SPDX_DISJUNCTIVE_LICENSE_SET, CLASS_SPDX_DOCUMENT, CLASS_SPDX_ELEMENT, CLASS_SPDX_EXTRACTED_LICENSING_INFO, CLASS_SPDX_FILE, CLASS_SPDX_ITEM, CLASS_SPDX_LICENSE, CLASS_SPDX_LICENSE_EXCEPTION, CLASS_SPDX_PACKAGE, CLASS_SPDX_REVIEW, CLASS_SPDX_SIMPLE_LICENSE_INFO, CLASS_SPDX_VERIFICATIONCODE, CLASS_WITH_EXCEPTION_OPERATOR, CREATOR_PREFIX_ORGANIZATION, CREATOR_PREFIX_PERSON, CREATOR_PREFIX_TOOL, DOAP_NAMESPACE, EXTERNAL_DOC_REF_PATTERN, EXTERNAL_DOC_REF_PRENUM, EXTERNAL_ELEMENT_REF_PATTERN, FILE_TYPE_ARCHIVE, FILE_TYPE_BINARY, FILE_TYPE_OTHER, FILE_TYPE_SOURCE, LICENSE_ID_PATTERN, LICENSE_ID_PATTERN_NUMERIC, NOASSERTION_VALUE, NON_STD_LICENSE_ID_PRENUM, NONE_VALUE, OWL_NAMESPACE, PROP_ANNOTATION, PROP_ANNOTATION_DATE, PROP_ANNOTATION_TYPE, PROP_ANNOTATOR, PROP_CHECKSUM_ALGORITHM, PROP_CHECKSUM_ALGORITHM_SHA1, PROP_CHECKSUM_VALUE, PROP_COPYRIGHT_TEXT, PROP_CREATION_CREATED, PROP_CREATION_CREATOR, PROP_EXAMPLE, PROP_EXCEPTION_TEXT, PROP_EXTERNAL_DOC_CHECKSUM, PROP_EXTERNAL_DOC_ID, PROP_EXTERNAL_SPDX_DOCUMENT, 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_LIC_COMMENTS, PROP_LICENSE_CONCLUDED, PROP_LICENSE_DECLARED, PROP_LICENSE_EXCEPTION, PROP_LICENSE_EXCEPTION_ID, PROP_LICENSE_ID, PROP_LICENSE_LIST_VERSION, PROP_LICENSE_NAME, PROP_LICENSE_SET_MEMEBER, PROP_LICENSE_TEXT, PROP_NAME, 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_RELATED_SPDX_ELEMENT, PROP_RELATIONSHIP, PROP_RELATIONSHIP_TYPE, PROP_REVIEW_DATE, PROP_REVIEW_REVIEWER, PROP_SPDX_CREATION_INFO, PROP_SPDX_DATA_LICENSE, PROP_SPDX_EXTERNAL_DOC_REF, PROP_SPDX_EXTRACTED_LICENSES, PROP_SPDX_FILE_REFERENCE, 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_DOCUMENT_ID, SPDX_ELEMENT_REF_PATTERN, SPDX_ELEMENT_REF_PRENUM, SPDX_NAMESPACE, SPDX_VERSION_PATTERN, STANDARD_LICENSE_URL, TERM_LICENSE_NOASSERTION, TERM_LICENSE_NONE, URI_VALUE_NOASSERTION, URI_VALUE_NONE

Constructor Summary

Constructors

Constructor and Description
SpdxPackage(IModelContainer modelContainer, com.hp.hpl.jena.graph.Node node)
SpdxPackage(String name, AnyLicenseInfo licenseConcluded, AnyLicenseInfo[] licenseInfosFromFiles, String copyrightText, AnyLicenseInfo licenseDeclared, String downloadLocation, SpdxFile[] files, SpdxPackageVerificationCode packageVerificationCode)
SpdxPackage(String name, String comment, Annotation[] annotations, Relationship[] relationships, AnyLicenseInfo licenseConcluded, AnyLicenseInfo[] licenseInfosFromFiles, String copyrightText, String licenseComment, AnyLicenseInfo licenseDeclared, Checksum[] checksums, String description, String downloadLocation, SpdxFile[] files, String homepage, String originator, String packageFileName, SpdxPackageVerificationCode packageVerificationCode, String sourceInfo, String summary, String supplier, String versionInfo)

Method Summary

Methods

Modifier and Type	Method and Description
void	addChecksum(Checksum checksum) Add a checksum to the list of checksums for this package
void	addFile(SpdxFile file) Add a file to the list of files attached to this package
SpdxPackage	clone()
SpdxPackage	clone(Map<String,SpdxElement> clonedElementIds) Clones this element, but prevents infinite recursion by keeping track of all elements which have been cloned
int	compareTo(SpdxPackage pkg)
boolean	equivalent(IRdfModel o) Returns true if the compare object contains properties which would be equal if they were contained in the same RDF Model
boolean	equivalent(IRdfModel o, boolean testRelationships) Test for equivalent
com.hp.hpl.jena.rdf.model.Resource	findDuplicateResource(IModelContainer modelContainer, String uri) Search the model to see if there is a duplicate resource either based on the URI or based on other information.
Checksum[]	getChecksums()
AnyLicenseInfo	getConcludedLicenses() Deprecated.
String	getDeclaredCopyright() Deprecated.
AnyLicenseInfo	getDeclaredLicense() Deprecated.
String	getDeclaredName() Deprecated.
String	getDescription()
String	getDownloadLocation()
String	getDownloadUrl() Deprecated.
String	getFileName() Deprecated.
SpdxFile[]	getFiles()
SpdxFile[]	getFiles(boolean checkRelationships)
String	getHomepage()
AnyLicenseInfo	getLicenseDeclared()
protected String	getNamePropertyName()
String	getOriginator()
String	getPackageFileName()
SpdxPackageVerificationCode	getPackageVerificationCode()
void	getPropertiesFromModel() Fetch all of the properties from the model and populate the local Java properties
String	getSha1()
String	getShortDescription() Deprecated.
String	getSourceInfo()
String	getSummary()
String	getSupplier()
com.hp.hpl.jena.rdf.model.Resource	getType(com.hp.hpl.jena.rdf.model.Model model)
SpdxPackageVerificationCode	getVerificationCode() Deprecated.
String	getVersionInfo()
void	populateModel() Populate the RDF model from the Java properties
void	setChecksums(Checksum[] checksums)
void	setDescription(String description)
void	setDownloadLocation(String downloadLocation)
void	setFiles(SpdxFile[] files)
void	setHomepage(String homepage)
void	setLicenseDeclared(AnyLicenseInfo licenseDeclared)
void	setOriginator(String originator)
void	setPackageFileName(String packageFileName)
void	setPackageVerificationCode(SpdxPackageVerificationCode packageVerificationCode)
void	setSourceInfo(String sourceInfo)
void	setSummary(String summary)
void	setSupplier(String supplier)
void	setVersionInfo(String versionInfo)
List<String>	verify()

Methods inherited from class org.spdx.rdfparser.model.SpdxItem

cloneLicenseConcluded, cloneLicenseInfosFromFiles, getCopyrightText, getLicenseComment, getLicenseComments, getLicenseConcluded, getLicenseInfoFromFiles, getLicenseInfoFromFilesPropertyName, setCopyrightText, setLicenseComment, setLicenseComments, setLicenseConcluded, setLicenseInfosFromFiles

Methods inherited from class org.spdx.rdfparser.model.SpdxElement

addAnnotation, addNameToWarnings, addRelationship, arraysEquivalent, arraysEquivalent, cloneAnnotations, cloneRelationships, equivalentConsideringNull, equivalentConsideringNull, getAnnotations, getComment, getId, getName, getRelationships, getUri, setAnnotations, setComment, setId, setName, setRelationships, toString

Methods inherited from class org.spdx.rdfparser.model.RdfModelObject

addPropertyUriValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, createResource, createResource, equals, findAnnotationPropertyValues, findAnyLicenseInfoPropertyValue, findAnyLicenseInfoPropertyValues, findChecksumPropertyValue, findCreationInfoPropertyValue, findElementPropertyValue, findExternalDocRefPropertyValues, findExternalDocRefPropertyValues, findMultipleChecksumPropertyValues, findMultipleDoapPropertyValues, findMultipleElementPropertyValues, findMultiplePropertyValues, findRelationshipPropertyValues, findReviewPropertyValues, findSinglePropertyValue, findUriPropertyValue, findUriPropertyValues, findVerificationCodePropertyValue, getNode, hashCode, isRefreshOnGet, removePropertyValue, resourcesEqual, setMultipleObjectsForSameNode, setPropertyUriValue, setPropertyUriValues, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValues, setPropertyValues, setPropertyValues, setPropertyValues, setPropertyValues, setPropertyValues, setSingleObjectForSameNode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpdxPackage

public SpdxPackage(String name,
           String comment,
           Annotation[] annotations,
           Relationship[] relationships,
           AnyLicenseInfo licenseConcluded,
           AnyLicenseInfo[] licenseInfosFromFiles,
           String copyrightText,
           String licenseComment,
           AnyLicenseInfo licenseDeclared,
           Checksum[] checksums,
           String description,
           String downloadLocation,
           SpdxFile[] files,
           String homepage,
           String originator,
           String packageFileName,
           SpdxPackageVerificationCode packageVerificationCode,
           String sourceInfo,
           String summary,
           String supplier,
           String versionInfo)

Parameters:

name -

comment -

annotations -

relationships -

licenseConcluded -

licenseDeclared -

copyrightText -

licenseComment -

SpdxPackage

public SpdxPackage(String name,
           AnyLicenseInfo licenseConcluded,
           AnyLicenseInfo[] licenseInfosFromFiles,
           String copyrightText,
           AnyLicenseInfo licenseDeclared,
           String downloadLocation,
           SpdxFile[] files,
           SpdxPackageVerificationCode packageVerificationCode)

SpdxPackage

public SpdxPackage(IModelContainer modelContainer,
           com.hp.hpl.jena.graph.Node node)
            throws InvalidSPDXAnalysisException

Parameters:

modelContainer -

node -

Throws:

InvalidSPDXAnalysisException

Method Detail

getPropertiesFromModel

public void getPropertiesFromModel()
                            throws InvalidSPDXAnalysisException

Description copied from class: RdfModelObject

Fetch all of the properties from the model and populate the local Java properties

Overrides:

getPropertiesFromModel in class SpdxItem

Throws:

InvalidSPDXAnalysisException

findDuplicateResource

public com.hp.hpl.jena.rdf.model.Resource findDuplicateResource(IModelContainer modelContainer,
                                                       String uri)
                                                         throws InvalidSPDXAnalysisException

Description copied from class: RdfModelObject

Search the model to see if there is a duplicate resource either based on the URI or based on other information. Subclasses may choose to override this method to prevent duplicate resource from being created with the same properties.

Overrides:

findDuplicateResource in class RdfModelObject

Returns:

Any duplicate resource found. Null if no duplicate resource was found.

Throws:

InvalidSPDXAnalysisException

populateModel

public void populateModel()
                   throws InvalidSPDXAnalysisException

Description copied from class: RdfModelObject

Populate the RDF model from the Java properties

Overrides:

populateModel in class SpdxItem

Throws:

InvalidSPDXAnalysisException

getNamePropertyName

protected String getNamePropertyName()

Overrides:

getNamePropertyName in class SpdxElement

Returns:

the property name used for the Name property. Override this function if using a subproperty of SPDX Name

getType

public com.hp.hpl.jena.rdf.model.Resource getType(com.hp.hpl.jena.rdf.model.Model model)

Overrides:

getType in class SpdxItem

Returns:

the RDF class name for the object

getLicenseDeclared

public AnyLicenseInfo getLicenseDeclared()
                                  throws InvalidSPDXAnalysisException

Returns:

the licenseDeclared

Throws:

InvalidSPDXAnalysisException

setLicenseDeclared

public void setLicenseDeclared(AnyLicenseInfo licenseDeclared)
                        throws InvalidSPDXAnalysisException

Parameters:

licenseDeclared - the licenseDeclared to set

Throws:

InvalidSPDXAnalysisException

getChecksums

public Checksum[] getChecksums()
                        throws InvalidSPDXAnalysisException

Returns:

the checksums

Throws:

InvalidSPDXAnalysisException

setChecksums

public void setChecksums(Checksum[] checksums)
                  throws InvalidSPDXAnalysisException

Parameters:

checksums - the checksums to set

Throws:

InvalidSPDXAnalysisException

addChecksum

public void addChecksum(Checksum checksum)
                 throws InvalidSPDXAnalysisException

Add a checksum to the list of checksums for this package

Parameters:

checksum -

Throws:

InvalidSPDXAnalysisException

getDescription

public String getDescription()

Returns:

the description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

getDownloadLocation

public String getDownloadLocation()

Returns:

the downloadLocation

setDownloadLocation

public void setDownloadLocation(String downloadLocation)

Parameters:

downloadLocation - the downloadLocation to set

getHomepage

public String getHomepage()

Returns:

the homepage

setHomepage

public void setHomepage(String homepage)

Parameters:

homepage - the homepage to set

getOriginator

public String getOriginator()

Returns:

the originator

setOriginator

public void setOriginator(String originator)

Parameters:

originator - the originator to set

getPackageFileName

public String getPackageFileName()

Returns:

the packageFileName

setPackageFileName

public void setPackageFileName(String packageFileName)

Parameters:

packageFileName - the packageFileName to set

getPackageVerificationCode

public SpdxPackageVerificationCode getPackageVerificationCode()
                                                       throws InvalidSPDXAnalysisException

Returns:

the packageVerificationCode

Throws:

InvalidSPDXAnalysisException

setPackageVerificationCode

public void setPackageVerificationCode(SpdxPackageVerificationCode packageVerificationCode)
                                throws InvalidSPDXAnalysisException

Parameters:

packageVerificationCode - the packageVerificationCode to set

Throws:

InvalidSPDXAnalysisException

getSourceInfo

public String getSourceInfo()

Returns:

the sourceInfo

setSourceInfo

public void setSourceInfo(String sourceInfo)

Parameters:

sourceInfo - the sourceInfo to set

getSummary

public String getSummary()

Returns:

the summary

setSummary

public void setSummary(String summary)

Parameters:

summary - the summary to set

getSupplier

public String getSupplier()

Returns:

the supplier

setSupplier

public void setSupplier(String supplier)

Parameters:

supplier - the supplier to set

getVersionInfo

public String getVersionInfo()

Returns:

the versionInfo

setVersionInfo

public void setVersionInfo(String versionInfo)

Parameters:

versionInfo - the versionInfo to set

getFiles

public SpdxFile[] getFiles()
                    throws InvalidSPDXAnalysisException

Returns:

the files

Throws:

InvalidSPDXAnalysisException

getFiles

public SpdxFile[] getFiles(boolean checkRelationships)
                    throws InvalidSPDXAnalysisException

Parameters:

checkRelationships - - if true, compare relationships when determining if the files need to be loaded

Returns:

the files

Throws:

InvalidSPDXAnalysisException

setFiles

public void setFiles(SpdxFile[] files)
              throws InvalidSPDXAnalysisException

Parameters:

files - the files to set

Throws:

InvalidSPDXAnalysisException

addFile

public void addFile(SpdxFile file)
             throws InvalidSPDXAnalysisException

Add a file to the list of files attached to this package

Parameters:

file -

Throws:

InvalidSPDXAnalysisException

equivalent

public boolean equivalent(IRdfModel o)

Description copied from interface: IRdfModel

Returns true if the compare object contains properties which would be equal if they were contained in the same RDF Model

Specified by:

equivalent in interface IRdfModel

Overrides:

equivalent in class SpdxItem

Returns:

equivalent

public boolean equivalent(IRdfModel o,
                 boolean testRelationships)

Description copied from class: SpdxElement

Test for equivalent

Overrides:

equivalent in class SpdxItem

testRelationships - If true, test relationships

Returns:

clone

public SpdxPackage clone(Map<String,SpdxElement> clonedElementIds)

Description copied from class: SpdxElement

Clones this element, but prevents infinite recursion by keeping track of all elements which have been cloned

Overrides:

clone in class SpdxItem

Parameters:

clonedElementIds - element ID's fo all elements which have been cloned

Returns:

clone

public SpdxPackage clone()

Overrides:

clone in class SpdxItem

verify

public List<String> verify()

Specified by:

verify in interface IRdfModel

Overrides:

verify in class SpdxItem

Returns:

List of validation errors for any non SPDX compliant properties.

getDeclaredName

@Deprecated
public String getDeclaredName()

Deprecated.

This method has been replaced by getName() to be consistent with the spec property name

Returns:

getDownloadUrl

@Deprecated
public String getDownloadUrl()

Deprecated.

This method has been replaced by getDownloadLocation() to be consistent with the spec property name

Returns:

getShortDescription

@Deprecated
public String getShortDescription()

Deprecated.

This method has been replaced by getSummary() to be consistent with the spec property name

Returns:

getFileName

@Deprecated
public String getFileName()

Deprecated.

This method has been replaced by getPackageFileName() to be consistent with the spec property name

Returns:

getVerificationCode

@Deprecated
public SpdxPackageVerificationCode getVerificationCode()
                                                throws InvalidSPDXAnalysisException

Deprecated.

This method has been replaced by getPackageVerificationCode() to be consistent with the spec property name

Returns:

Throws:

InvalidSPDXAnalysisException

getDeclaredCopyright

@Deprecated
public String getDeclaredCopyright()

Deprecated.

This method has been replaced by getDeclaredCopyright() to be consistent with the spec property name

Returns:

getDeclaredLicense

@Deprecated
public AnyLicenseInfo getDeclaredLicense()
                                  throws InvalidSPDXAnalysisException

Deprecated.

This method has been replaced by getLicenseDeclared() to be consistent with the spec property name

Returns:

Throws:

InvalidSPDXAnalysisException

getConcludedLicenses

@Deprecated
public AnyLicenseInfo getConcludedLicenses()

Deprecated.

This method has been replaced by getLicenseConcluded() to be consistent with the spec property name

Returns:

compareTo

public int compareTo(SpdxPackage pkg)

Specified by:

compareTo in interface Comparable<SpdxPackage>

getSha1

public String getSha1()

Returns:

the Sha1 checksum value for this package, or a blank string if no sha1 checksum has been set