Package org.spdx.library.model

Class ExternalSpdxElement

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.SpdxElement

org.spdx.library.model.ExternalSpdxElement

All Implemented Interfaces:

IndividualUriValue

public class ExternalSpdxElement
extends SpdxElement
implements IndividualUriValue

This is an SPDX element which is in an external document. The ID must be in the form SpdxConstants.EXTERNAL_ELEMENT_REF_PATTERN.pattern()

Author:

Gary O'Neall

Field Summary

Fields inherited from class org.spdx.library.model.ModelObject

strict

Constructor Summary

Constructors

Constructor	Description
ExternalSpdxElement(String id)
ExternalSpdxElement(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)

Method Summary

Modifier and Type	Method	Description
protected List<String>	_verify(Set<String> verifiedIds, String specVersion)	Implementation of the specific verifications for this model object
boolean	addAnnotation(Annotation annotation)	Add an annotation
boolean	addRelationship(Relationship relationship)	Add a relationship
boolean	equals(Object comp)
boolean	equivalent(ModelObject compare)
static String	externalDocumentIdToNamespace(String externalDocumentId, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)
static String	externalSpdxElementIdToURI(String externalSpdxElementId, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)
Collection<Annotation>	getAnnotations()
Optional<String>	getComment()
String	getExternalDocumentId()
String	getExternalElementId()
String	getExternalSpdxElementURI()
String	getIndividualURI()
Optional<String>	getName()
Collection<Relationship>	getRelationships()
String	getType()
int	hashCode()
boolean	removeAnnotation(Annotation annotation)	Remove an annotation
boolean	removeRelationship(Relationship relationship)	Remove a relationship
SpdxElement	setAnnotations(Collection<Annotation> annotations)	Clears and resets the annotations collection to the parameter
void	setComment(String comment)	Sets the comment
ExternalSpdxElement	setName(String name)	Set the name
SpdxElement	setRelationships(Collection<Relationship> relationships)	clear and reset the relationships to the paramater relationship
static ExternalSpdxElement	uriToExternalSpdxElement(String uri, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)	Create an ExternalSpdxElement based on a URI of the form externaldocumentnamespace#SPDXRef-[NUM]
static String	uriToExternalSpdxElementId(String uri, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager)	Convert a URI to an ID for an External SPDX Element

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

addNameToWarnings, getNamePropertyName

Methods inherited from class org.spdx.library.model.ModelObject

addPropertyValueToCollection, addValueToCollection, clearValueCollection, clearValueCollection, clone, copyFrom, createAnnotation, createByteOffsetPointer, createChecksum, createConjunctiveLicenseSet, createCreationInfo, createCrossRef, createDisjunctiveLicenseSet, createExternalDocumentRef, createExternalRef, createLineCharPointer, createPackage, createPackageVerificationCode, createRelationship, createSpdxFile, createSpdxSnippet, createStartEndPointer, enterCriticalSection, equivalent, getAnyLicenseInfoPropertyValue, getBooleanPropertyValue, getCopyManager, getDocumentUri, getElementPropertyValue, getEnumPropertyValue, getId, getIntegerPropertyValue, getModelStore, getObjectPropertyValue, getObjectPropertyValue, getObjectPropertyValueCollection, getObjectPropertyValueSet, getPropertyValueNames, getStringCollection, getStringPropertyValue, idToIdType, isCollectionMembersAssignableTo, isStrict, leaveCriticalSection, removeProperty, removeProperty, removePropertyValueFromCollection, removePropertyValueFromCollection, replacePropertyValueCollection, setCopyManager, setPropertyValue, setPropertyValue, setStrict, toString, toTypedValue, updateAddPropertyValueToCollection, updateClearValueCollection, updatePropertyValue, updateRemoveProperty, updateRemovePropertyValueFromCollection, verify, verify, verify, verifyCollection

Methods inherited from class java.lang.Object

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

Constructor Details

ExternalSpdxElement

public ExternalSpdxElement(String id) throws InvalidSPDXAnalysisException

Parameters:

id -

Throws:

InvalidSPDXAnalysisException

ExternalSpdxElement

public ExternalSpdxElement(IModelStore modelStore, String documentUri, String id, @Nullable ModelCopyManager copyManager, boolean create) throws InvalidSPDXAnalysisException

Parameters:

modelStore -

documentUri -

id -

create -

Throws:

InvalidSPDXAnalysisException

Method Details

getExternalDocumentId

public String getExternalDocumentId() throws InvalidSPDXAnalysisException

Returns:

external document ID for the external reference

Throws:

InvalidSPDXAnalysisException

getExternalElementId

public String getExternalElementId() throws InvalidSPDXAnalysisException

Returns:

element ID used in the external document

Throws:

InvalidSPDXAnalysisException

getType

public String getType()

Specified by:

getType in class ModelObject

Returns:

The class name for this object. Class names are defined in the constants file

_verify

protected List<String> _verify(Set<String> verifiedIds, String specVersion)

Description copied from class: ModelObject

Implementation of the specific verifications for this model object

Overrides:

_verify in class SpdxElement

Parameters:

verifiedIds - list of all Element Id's which have already been verified - prevents infinite recursion

specVersion - Version of the SPDX spec to verify against

Returns:

Any verification errors or warnings associated with this object

getExternalSpdxElementURI

public String getExternalSpdxElementURI() throws InvalidSPDXAnalysisException

Returns:

the External URI associated with this external SPDX element

Throws:

InvalidSPDXAnalysisException

externalSpdxElementIdToURI

public static String externalSpdxElementIdToURI(String externalSpdxElementId, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager) throws InvalidSPDXAnalysisException

Parameters:

externalSpdxElementId -

stModelStore -

stDocumentUri -

copyManager -

Returns:

The URI associated with the external SPDX element with the ID externalSpdxElementId

Throws:

InvalidSPDXAnalysisException

uriToExternalSpdxElementId

public static String uriToExternalSpdxElementId(String uri, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager) throws InvalidSPDXAnalysisException

Convert a URI to an ID for an External SPDX Element

Parameters:

uri - URI with the external document namespace and the external SPDX ref in the form namespace#SPDXRef-[NUM]

stModelStore -

stDocumentUri -

copyManager - if true, create the external doc ref if it is not already in the ModelStore

Returns:

external SPDX element ID in the form DocumentRef-XX:SPDXRef-YY

Throws:

InvalidSPDXAnalysisException

uriToExternalSpdxElement

public static ExternalSpdxElement uriToExternalSpdxElement(String uri, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager) throws InvalidSPDXAnalysisException

Create an ExternalSpdxElement based on a URI of the form externaldocumentnamespace#SPDXRef-[NUM]

Parameters:

uri - RI of the form externaldocumentnamespace#SPDXRef-[NUM]

stModelStore -

stDocumentUri -

copyManager - if non-null, create the external doc ref if it is not already in the ModelStore

Returns:

ExternalSpdxRef

Throws:

InvalidSPDXAnalysisException

externalDocumentIdToNamespace

public static String externalDocumentIdToNamespace(String externalDocumentId, IModelStore stModelStore, String stDocumentUri, ModelCopyManager copyManager) throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

equivalent

public boolean equivalent(ModelObject compare)

Overrides:

equivalent in class ModelObject

Returns:

true if all the properties have the same or equivalent values

getIndividualURI

public String getIndividualURI()

Specified by:

getIndividualURI in interface IndividualUriValue

Returns:

a unique identifier for this value. Typically the namespace + the long name

addAnnotation

public boolean addAnnotation(Annotation annotation) throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

Add an annotation

Overrides:

addAnnotation in class SpdxElement

Returns:

Throws:

InvalidSPDXAnalysisException

addRelationship

public boolean addRelationship(Relationship relationship) throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

Add a relationship

Overrides:

addRelationship in class SpdxElement

Returns:

Throws:

InvalidSPDXAnalysisException

setComment

public void setComment(String comment) throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

Sets the comment

Overrides:

setComment in class SpdxElement

Throws:

InvalidSPDXAnalysisException

setName

public ExternalSpdxElement setName(String name) throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

Set the name

Overrides:

setName in class SpdxElement

Returns:

this so that you can chain setters

Throws:

InvalidSPDXAnalysisException

getAnnotations

public Collection<Annotation> getAnnotations() throws InvalidSPDXAnalysisException

Overrides:

getAnnotations in class SpdxElement

Returns:

Annotations

Throws:

InvalidSPDXAnalysisException

setAnnotations

public SpdxElement setAnnotations(Collection<Annotation> annotations) throws InvalidSPDXAnalysisException

Clears and resets the annotations collection to the parameter

Overrides:

setAnnotations in class SpdxElement

Parameters:

annotations -

Returns:

this to chain setters

Throws:

InvalidSPDXAnalysisException

removeAnnotation

public boolean removeAnnotation(Annotation annotation) throws InvalidSPDXAnalysisException

Remove an annotation

Overrides:

removeAnnotation in class SpdxElement

Parameters:

annotation -

Returns:

Throws:

InvalidSPDXAnalysisException

getRelationships

public Collection<Relationship> getRelationships() throws InvalidSPDXAnalysisException

Overrides:

getRelationships in class SpdxElement

Returns:

Relationships

Throws:

InvalidSPDXAnalysisException

setRelationships

public SpdxElement setRelationships(Collection<Relationship> relationships) throws InvalidSPDXAnalysisException

clear and reset the relationships to the paramater relationship

Overrides:

setRelationships in class SpdxElement

Parameters:

relationships -

Returns:

this to chain sets

Throws:

InvalidSPDXAnalysisException

removeRelationship

public boolean removeRelationship(Relationship relationship) throws InvalidSPDXAnalysisException

Remove a relationship

Overrides:

removeRelationship in class SpdxElement

Parameters:

relationship -

Returns:

Throws:

InvalidSPDXAnalysisException

getComment

public Optional<String> getComment() throws InvalidSPDXAnalysisException

Overrides:

getComment in class SpdxElement

Returns:

the comment

Throws:

InvalidSPDXAnalysisException

getName

public Optional<String> getName() throws InvalidSPDXAnalysisException

Overrides:

getName in class SpdxElement

Returns:

the name

Throws:

InvalidSPDXAnalysisException

equals

public boolean equals(Object comp)

Overrides:

equals in class ModelObject

hashCode

public int hashCode()

Overrides:

hashCode in class ModelObject