org.spdx.rdfparser.model

Class SpdxElement

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.model.SpdxElement

All Implemented Interfaces:

Cloneable, IRdfModel

Direct Known Subclasses:

ExternalSpdxElement, SpdxDocument, SpdxItem

public class SpdxElement
extends RdfModelObject

An SpdxElement is any thing described in SPDX, either a document or an SpdxItem. SpdxElements can be related to other SpdxElements. All subclasses should override getType, equals and hashCode. If a subproperty is used for the name property name, getNamePropertyName should be overridden. If absolute URIs are required, getUri should be overriden.

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field and Description
protected Annotation[]	annotations
protected String	comment
protected String	name
protected Relationship[]	relationships

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

model, modelContainer, node, refreshOnGet, resource

Constructor Summary

Constructors

Constructor and Description
SpdxElement(IModelContainer modelContainer, org.apache.jena.graph.Node node)
SpdxElement(String name, String comment, Annotation[] annotations, Relationship[] relationships)

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(Annotation annotation)
protected void	addNameToWarnings(List<String> warnings) Add the name of the element to all strings in the list
void	addRelationship(Relationship relationship)
boolean	arraysEquivalent(IRdfModel[] array1, IRdfModel[] array2) Compares 2 arrays to see if the property values for the element RdfModelObjects are the same independent of order and considering nulls
boolean	arraysEquivalent(IRdfModel[] array1, IRdfModel[] array2, boolean testRelationships) Compares 2 arrays to see if the property values for the element RdfModelObjects are the same independent of order and considering nulls
SpdxElement	clone()
SpdxElement	clone(Map<String,SpdxElement> clonedElementIds) Clones this element, but prevents infinite recursion by keeping track of all elements which have been cloned
protected Annotation[]	cloneAnnotations()
protected Relationship[]	cloneRelationships(Map<String,SpdxElement> clonedElementIds)
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
boolean	equivalentConsideringNull(IRdfModel o1, IRdfModel o2) Compares the properties of two RdfModelObjects considering possible null values
boolean	equivalentConsideringNull(SpdxElement o1, SpdxElement o2, boolean testRelationship) Compares the properties of two RdfModelObjects considering possible null values
Annotation[]	getAnnotations()
String	getComment()
String	getId() The ID is a unique identify for the SPDX element.
String	getName()
protected String	getNamePropertyName()
void	getPropertiesFromModel() Fetch all of the properties from the model and populate the local Java properties
Relationship[]	getRelationships()
org.apache.jena.rdf.model.Resource	getType(org.apache.jena.rdf.model.Model model)
String	getUri(IModelContainer modelContainer) Get the URI for this RDF object.
void	populateModel() Populate the RDF model from the Java properties
void	setAnnotations(Annotation[] annotations)
void	setComment(String comment)
void	setId(String id) The ID is a unique identify for the SPDX element.
void	setName(String name) Set the name
void	setRelationships(Relationship[] relationships)
String	toString()
List<String>	verify()

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

Field Detail

annotations

protected Annotation[] annotations

comment

protected String comment

name

protected String name

relationships

protected Relationship[] relationships

Constructor Detail

SpdxElement

public SpdxElement(IModelContainer modelContainer,
                   org.apache.jena.graph.Node node)
            throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

SpdxElement

public SpdxElement(String name,
                   String comment,
                   Annotation[] annotations,
                   Relationship[] relationships)

Parameters:

name - Name of the element

comment - Optional comment on the element

annotations - Optional annotations for the element

relationships - Optional relationships with other elements

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

Specified by:

getPropertiesFromModel in class RdfModelObject

Throws:

InvalidSPDXAnalysisException

populateModel

public void populateModel()
                   throws InvalidSPDXAnalysisException

Description copied from class: RdfModelObject

Populate the RDF model from the Java properties

Specified by:

populateModel in class RdfModelObject

Throws:

InvalidSPDXAnalysisException

verify

public List<String> verify()

Returns:

List of validation errors for any non SPDX compliant properties.

addNameToWarnings

protected void addNameToWarnings(List<String> warnings)

Add the name of the element to all strings in the list

Parameters:

warnings -

getAnnotations

public Annotation[] getAnnotations()

Returns:

the annotations

setAnnotations

public void setAnnotations(Annotation[] annotations)
                    throws InvalidSPDXAnalysisException

Parameters:

annotations - the annotations to set

Throws:

InvalidSPDXAnalysisException

getComment

public String getComment()

Returns:

the comment

setComment

public void setComment(String comment)

Parameters:

comment - the comment to set

getName

public String getName()

Returns:

the name

getNamePropertyName

protected String getNamePropertyName()

Returns:

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

setName

public void setName(String name)

Set the name

Parameters:

name - the name to set

getRelationships

public Relationship[] getRelationships()

Returns:

the relationships

setRelationships

public void setRelationships(Relationship[] relationships)
                      throws InvalidSPDXAnalysisException

Parameters:

relationships - the relationships to set

Throws:

InvalidSPDXAnalysisException

getId

public String getId()

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.

Returns:

the id

setId

public void setId(String id)
           throws InvalidSPDXAnalysisException

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.

Parameters:

id -

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.

Specified by:

getUri in class RdfModelObject

Returns:

Throws:

InvalidSPDXAnalysisException

getType

public org.apache.jena.rdf.model.Resource getType(org.apache.jena.rdf.model.Model model)

Specified by:

getType in class RdfModelObject

Returns:

the RDF class name for the object

cloneAnnotations

protected Annotation[] cloneAnnotations()

cloneRelationships

protected Relationship[] cloneRelationships(Map<String,SpdxElement> clonedElementIds)

clone

public SpdxElement clone()

Overrides:

clone in class Object

clone

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

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

Parameters:

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

Returns:

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

Returns:

equivalent

public boolean equivalent(IRdfModel o,
                          boolean testRelationships)

Test for equivalent

Parameters:

o -

testRelationships - If true, test relationships

Returns:

toString

public String toString()

Overrides:

toString in class Object

addRelationship

public void addRelationship(Relationship relationship)
                     throws InvalidSPDXAnalysisException

Parameters:

describesRelationship -

Throws:

InvalidSPDXAnalysisException

addAnnotation

public void addAnnotation(Annotation annotation)
                   throws InvalidSPDXAnalysisException

Parameters:

annotation -

Throws:

InvalidSPDXAnalysisException

arraysEquivalent

public boolean arraysEquivalent(IRdfModel[] array1,
                                IRdfModel[] array2)

Compares 2 arrays to see if the property values for the element RdfModelObjects are the same independent of order and considering nulls

Overrides:

arraysEquivalent in class RdfModelObject

Parameters:

array1 -

array2 -

testRelationships - If true, test relationships for an SpdxElement (used to manage infinite recursion on circular relationships)

Returns:

arraysEquivalent

public boolean arraysEquivalent(IRdfModel[] array1,
                                IRdfModel[] array2,
                                boolean testRelationships)

Compares 2 arrays to see if the property values for the element RdfModelObjects are the same independent of order and considering nulls

Parameters:

array1 -

array2 -

testRelationships - If true, test relationships for an SpdxElement (used to manage infinite recursion on circular relationships)

Returns:

equivalentConsideringNull

public boolean equivalentConsideringNull(IRdfModel o1,
                                         IRdfModel o2)

Compares the properties of two RdfModelObjects considering possible null values

Overrides:

equivalentConsideringNull in class RdfModelObject

Parameters:

o1 -

o2 -

Returns:

equivalentConsideringNull

public boolean equivalentConsideringNull(SpdxElement o1,
                                         SpdxElement o2,
                                         boolean testRelationship)

Compares the properties of two RdfModelObjects considering possible null values

Parameters:

o1 -

o2 -

testRelationships - If true, test relationships for an SpdxElement (used to manage infinite recursion on circular relationships)

Returns: