org.spdx.rdfparser.model

Class SpdxItem

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.model.SpdxElement

org.spdx.rdfparser.model.SpdxItem

All Implemented Interfaces:

Cloneable, IRdfModel

Direct Known Subclasses:

SpdxFile, SpdxPackage, SpdxSnippet

public class SpdxItem
extends SpdxElement

An SpdxItem is a potentially copyrightable work.

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

Constructor Summary

Constructors

Constructor and Description
SpdxItem(IModelContainer modelContainer, com.hp.hpl.jena.graph.Node node) Create an SPDX item from a Jena model
SpdxItem(String name, String comment, Annotation[] annotations, Relationship[] relationships, AnyLicenseInfo licenseConcluded, AnyLicenseInfo[] licenseInfoFromFiles, String copyrightText, String licenseComment)

Method Summary

Modifier and Type	Method and Description
SpdxItem	clone()
SpdxItem	clone(Map<String,SpdxElement> clonedElementIds) Clones this element, but prevents infinite recursion by keeping track of all elements which have been cloned
protected AnyLicenseInfo	cloneLicenseConcluded()
protected AnyLicenseInfo[]	cloneLicenseInfosFromFiles()
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
String	getCopyrightText()
String	getLicenseComment() Deprecated.
String	getLicenseComments()
AnyLicenseInfo	getLicenseConcluded()
AnyLicenseInfo[]	getLicenseInfoFromFiles()
protected String	getLicenseInfoFromFilesPropertyName()
void	getPropertiesFromModel() Fetch all of the properties from the model and populate the local Java properties
com.hp.hpl.jena.rdf.model.Resource	getType(com.hp.hpl.jena.rdf.model.Model model)
void	populateModel() Populate the RDF model from the Java properties
void	setCopyrightText(String copyrightText)
void	setLicenseComment(String licenseComment) Deprecated.
void	setLicenseComments(String licenseComments)
void	setLicenseConcluded(AnyLicenseInfo licenseConcluded)
void	setLicenseInfosFromFiles(AnyLicenseInfo[] licenseInfoFromFiles)
List<String>	verify()

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

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

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

addPropertyUriValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, createResource, createResource, equals, findAnnotationPropertyValues, findAnyLicenseInfoPropertyValue, findAnyLicenseInfoPropertyValues, findChecksumPropertyValue, findCreationInfoPropertyValue, findDuplicateResource, findElementPropertyValue, findExternalDocRefPropertyValues, findExternalDocRefPropertyValues, findExternalRefPropertyValues, findIntPropertyValue, findMultipleChecksumPropertyValues, findMultipleDoapPropertyValues, findMultipleElementPropertyValues, findMultiplePropertyValues, findReferenceTypePropertyValue, findRelationshipPropertyValues, findReviewPropertyValues, findSinglePointerPropertyValue, findSinglePropertyValue, findStartEndPointerPropertyValues, findUriPropertyValue, findUriPropertyValues, findVerificationCodePropertyValue, getNode, hashCode, isRefreshOnGet, removePropertyValue, resourcesEqual, setMultipleObjectsForSameNode, setPropertyUriValue, setPropertyUriValues, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, 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

SpdxItem

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

Create an SPDX item from a Jena model

Parameters:

modelContainer - Container containing the model

node -

Throws:

InvalidSPDXAnalysisException

SpdxItem

public SpdxItem(String name,
                String comment,
                Annotation[] annotations,
                Relationship[] relationships,
                AnyLicenseInfo licenseConcluded,
                AnyLicenseInfo[] licenseInfoFromFiles,
                String copyrightText,
                String licenseComment)

Parameters:

name - Name of the item

comment - Optional comment about the item

annotations - Optional annotations on the items

relationships - Optional relationships with other SPDX elements

licenseConcluded - Concluded license for this item

licenseInfoFromFiles - License infos from files for this item

copyrightText - Copyright text for this item

licenseComment - Optional comment on the license

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 SpdxElement

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 SpdxElement

Throws:

InvalidSPDXAnalysisException

getLicenseInfoFromFilesPropertyName

protected String getLicenseInfoFromFilesPropertyName()

Returns:

Property name for licenseInfoFromFiles. Override if using a subproperty of "licenseDeclared".

getLicenseConcluded

public AnyLicenseInfo getLicenseConcluded()

Returns:

the licenseConcluded

setLicenseConcluded

public void setLicenseConcluded(AnyLicenseInfo licenseConcluded)
                         throws InvalidSPDXAnalysisException

Parameters:

licenseConcluded - the licenseConcluded to set

Throws:

InvalidSPDXAnalysisException

getLicenseInfoFromFiles

public AnyLicenseInfo[] getLicenseInfoFromFiles()

Returns:

the licenseInfoFromFiles

setLicenseInfosFromFiles

public void setLicenseInfosFromFiles(AnyLicenseInfo[] licenseInfoFromFiles)
                              throws InvalidSPDXAnalysisException

Parameters:

licenseInfoFromFiles - the licenseInfoFromFiles to set

Throws:

InvalidSPDXAnalysisException

getCopyrightText

public String getCopyrightText()

Returns:

the copyrightText

setCopyrightText

public void setCopyrightText(String copyrightText)

Parameters:

copyrightText - the copyrightText to set

getLicenseComments

public String getLicenseComments()

Returns:

the licenseComment

getLicenseComment

@Deprecated
public String getLicenseComment()

Deprecated.

This has been replaced by getLicenseComments to match the latest SPDX 2.0 spec

Returns:

setLicenseComments

public void setLicenseComments(String licenseComments)

Parameters:

licenseComments - the licenseComment to set

setLicenseComment

@Deprecated
public void setLicenseComment(String licenseComment)

Deprecated.

This has been replaced by setLicenseComments to match the latest SPDX 2.0 spec

getType

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

Overrides:

getType in class SpdxElement

Returns:

the RDF class name for the object

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 SpdxElement

Returns:

equivalent

public boolean equivalent(IRdfModel o,
                          boolean testRelationships)

Description copied from class: SpdxElement

Test for equivalent

Overrides:

equivalent in class SpdxElement

testRelationships - If true, test relationships

Returns:

cloneLicenseConcluded

protected AnyLicenseInfo cloneLicenseConcluded()

cloneLicenseInfosFromFiles

protected AnyLicenseInfo[] cloneLicenseInfosFromFiles()

clone

public SpdxItem clone()

Overrides:

clone in class SpdxElement

clone

public SpdxItem 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 SpdxElement

Parameters:

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

Returns:

verify

public List<String> verify()

Specified by:

verify in interface IRdfModel

Overrides:

verify in class SpdxElement

Returns:

List of validation errors for any non SPDX compliant properties.