org.spdx.rdfparser.model

Class ExternalSpdxElement

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.model.SpdxElement

org.spdx.rdfparser.model.ExternalSpdxElement

All Implemented Interfaces:

Cloneable, IRdfModel

public class ExternalSpdxElement
extends SpdxElement

This is an SPDX element which is in an external document. The only fields required to be valid are the id and externalDocumentId.

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
ExternalSpdxElement(String id)

Method Summary

Modifier and Type	Method and Description
ExternalSpdxElement	clone()
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	getExternalDocumentId()
String	getExternalElementId()
void	getPropertiesFromModel() Fetch all of the properties from the model and populate the local Java properties
String	getUri(IModelContainer modelContainer) Get the URI for this RDF object.
void	populateModel() Populate the RDF model from the Java properties
void	setId(String id) The ID is a unique identify for the SPDX element.
List<String>	verify()

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

addAnnotation, addNameToWarnings, addRelationship, arraysEquivalent, arraysEquivalent, clone, cloneAnnotations, cloneRelationships, equivalentConsideringNull, equivalentConsideringNull, getAnnotations, getComment, getId, getName, getNamePropertyName, getRelationships, getType, setAnnotations, setComment, 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

ExternalSpdxElement

public ExternalSpdxElement(String id)
                    throws InvalidSPDXAnalysisException

Parameters:

id - SPDX ID used for referencing this external element. Format ExternalSPDXRef:SPDXID

Throws:

InvalidSPDXAnalysisException

Method Detail

setId

public void setId(String id)
           throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

The ID is a unique identify for the SPDX element. It is only required if this element is to be used outside of the RDF model containing the element.

Overrides:

setId in class SpdxElement

Throws:

InvalidSPDXAnalysisException

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

getUri

public String getUri(IModelContainer modelContainer)
              throws InvalidSPDXAnalysisException

Description copied from class: RdfModelObject

Get the URI for this RDF object. Null if this is for an anonomous node.

Overrides:

getUri in class SpdxElement

Returns:

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 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:

clone

public ExternalSpdxElement clone()

Overrides:

clone in class SpdxElement

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.

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