Package org.spdx.library.model.v2

Class Relationship

java.lang.Object

org.spdx.core.CoreModelObject

org.spdx.library.model.v2.ModelObjectV2

org.spdx.library.model.v2.Relationship

All Implemented Interfaces:

Comparable<Relationship>

public class Relationship
extends ModelObjectV2
implements Comparable<Relationship>

A Relationship represents a relationship between two SpdxElements.

Author:

Gary O'Neall

Nested Class Summary

Nested classes/interfaces inherited from class org.spdx.core.CoreModelObject

org.spdx.core.CoreModelObject.CoreModelObjectBuilder

Field Summary

Fields inherited from class org.spdx.library.model.v2.ModelObjectV2

LATEST_SPDX_2_VERSION

Fields inherited from class org.spdx.core.CoreModelObject

copyManager, idPrefix, modelStore, objectUri, specVersion, strict

Constructor Summary

Constructors

Constructor	Description
Relationship()
Relationship(String id)
Relationship(org.spdx.storage.IModelStore modelStore, String documentUri, String id, org.spdx.core.IModelCopyManager 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
int	compareTo(Relationship o)
Optional<String>	getComment()
Optional<SpdxElement>	getRelatedSpdxElement()
RelationshipType	getRelationshipType()
String	getType()
Relationship	setComment(String comment)
Relationship	setRelatedSpdxElement(SpdxElement relatedSpdxElement)
Relationship	setRelationshipType(RelationshipType type)	Set the relationship type
String	toString()

Methods inherited from class org.spdx.library.model.v2.ModelObjectV2

_verify, createAnnotation, createByteOffsetPointer, createChecksum, createConjunctiveLicenseSet, createCreationInfo, createCrossRef, createDisjunctiveLicenseSet, createExternalDocumentRef, createExternalRef, createExtractedLicense, createLineCharPointer, createPackage, createPackageVerificationCode, createRelationship, createSpdxFile, createSpdxSnippet, createStartEndPointer, equals, getAnyLicenseInfoPropertyValue, getDocumentUri, getElementPropertyValue, getId, hashCode, isEquivalentToNull, isNoAssertion, isRelatedElement, toTypedValue, verify

Methods inherited from class org.spdx.core.CoreModelObject

addPropertyValueToCollection, clearValueCollection, clone, copyFrom, enterCriticalSection, equivalent, equivalent, getBooleanPropertyValue, getCopyManager, getDoublePropertyValue, getEnumPropertyValue, getIdPrefix, getIntegerPropertyValue, getModelStore, getObjectPropertyValue, getObjectPropertyValue, getObjectPropertyValueCollection, getObjectPropertyValueSet, getObjectUri, getPropertyValueDescriptors, getSpecVersion, getStringCollection, getStringPropertyValue, isCollectionMembersAssignableTo, isExternal, isStrict, leaveCriticalSection, removeProperty, removePropertyValueFromCollection, setCopyManager, setIdPrefix, setPropertyValue, setStrict, updateAddPropertyValueToCollection, updateClearValueCollection, updatePropertyValue, updateRemoveProperty, updateRemovePropertyValueFromCollection, verify, verify, verifyCollection

Methods inherited from class java.lang.Object

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

Constructor Detail

Relationship

public Relationship()
             throws org.spdx.core.InvalidSPDXAnalysisException

Throws:

org.spdx.core.InvalidSPDXAnalysisException

Relationship

public Relationship(String id)
             throws org.spdx.core.InvalidSPDXAnalysisException

Parameters:

id - identifier

Throws:

org.spdx.core.InvalidSPDXAnalysisException

Relationship

public Relationship(org.spdx.storage.IModelStore modelStore,
                    String documentUri,
                    String id,
                    org.spdx.core.IModelCopyManager copyManager,
                    boolean create)
             throws org.spdx.core.InvalidSPDXAnalysisException

Parameters:

modelStore - container which includes the model data

documentUri - URI for the SPDX document containing the model data

id - identifier

copyManager - if non-null, allows for copying of any properties set which use other model stores or document URI's

create - if true, create the license if it does not exist

Throws:

org.spdx.core.InvalidSPDXAnalysisException

Method Detail

getType

public String getType()

Specified by:

getType in class org.spdx.core.CoreModelObject

_verify

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

Description copied from class: ModelObjectV2

Implementation of the specific verifications for this model object

Specified by:

_verify in class ModelObjectV2

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

getRelationshipType

public RelationshipType getRelationshipType()
                                     throws org.spdx.core.InvalidSPDXAnalysisException

Returns:

the relationshipType

Throws:

org.spdx.core.InvalidSPDXAnalysisException

setRelationshipType

public Relationship setRelationshipType(RelationshipType type)
                                 throws org.spdx.core.InvalidSPDXAnalysisException

Set the relationship type

Parameters:

type -

Returns:

this to chain setters

Throws:

org.spdx.core.InvalidSPDXAnalysisException

getComment

public Optional<String> getComment()
                            throws org.spdx.core.InvalidSPDXAnalysisException

Returns:

the comment

Throws:

org.spdx.core.InvalidSPDXAnalysisException

setComment

public Relationship setComment(String comment)
                        throws org.spdx.core.InvalidSPDXAnalysisException

Parameters:

comment - the comment to set

Returns:

this to chain setters

Throws:

org.spdx.core.InvalidSPDXAnalysisException

getRelatedSpdxElement

public Optional<SpdxElement> getRelatedSpdxElement()
                                            throws org.spdx.core.InvalidSPDXAnalysisException

Returns:

the relatedSpdxElement

Throws:

org.spdx.core.InvalidSPDXAnalysisException

setRelatedSpdxElement

public Relationship setRelatedSpdxElement(SpdxElement relatedSpdxElement)
                                   throws org.spdx.core.InvalidSPDXAnalysisException

Parameters:

relatedSpdxElement - the relatedSpdxElement to set

Returns:

this to chain setters

Throws:

org.spdx.core.InvalidSPDXAnalysisException

compareTo

public int compareTo(Relationship o)

Specified by:

compareTo in interface Comparable<Relationship>

toString

public String toString()

Overrides:

toString in class ModelObjectV2