org.spdx.rdfparser.model

Class Relationship

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.model.Relationship

All Implemented Interfaces:

Cloneable, Comparable<Relationship>, IRdfModel

public class Relationship
extends RdfModelObject
implements Comparable<Relationship>

A Relationship represents a relationship between two SpdxElements.

Author:

Gary O'Neall

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Relationship.RelationshipType

Field Summary

Fields

Modifier and Type	Field and Description
static Map<Relationship.RelationshipType,String>	RELATIONSHIP_TYPE_TO_TAG Deprecated.
static Map<String,Relationship.RelationshipType>	TAG_TO_RELATIONSHIP_TYPE Deprecated.

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

model, modelContainer, node, refreshOnGet, resource

Constructor Summary

Constructors

Constructor and Description
Relationship(IModelContainer modelContainer, com.hp.hpl.jena.graph.Node node)
Relationship(SpdxElement relatedSpdxElement, Relationship.RelationshipType relationshipType, String comment)

Method Summary

Methods

Modifier and Type	Method and Description
Relationship	clone()
Relationship	clone(Map<String,SpdxElement> clonedElementIds)
int	compareTo(Relationship o)
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
String	getComment()
void	getPropertiesFromModel() Fetch all of the properties from the model and populate the local Java properties
SpdxElement	getRelatedSpdxElement()
Relationship.RelationshipType	getRelationshipType()
com.hp.hpl.jena.rdf.model.Resource	getType(com.hp.hpl.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	setComment(String comment)
void	setRelatedSpdxElement(SpdxElement relatedSpdxElement)
void	setRelationshipType(Relationship.RelationshipType relationshipType)
List<String>	verify()

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

addPropertyUriValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, arraysEquivalent, createResource, createResource, equals, equivalentConsideringNull, findAnnotationPropertyValues, findAnyLicenseInfoPropertyValue, findAnyLicenseInfoPropertyValues, findChecksumPropertyValue, findCreationInfoPropertyValue, findDuplicateResource, findElementPropertyValue, findExternalDocRefPropertyValues, findExternalDocRefPropertyValues, findMultipleChecksumPropertyValues, findMultipleDoapPropertyValues, findMultipleElementPropertyValues, findMultiplePropertyValues, findRelationshipPropertyValues, findReviewPropertyValues, findSinglePropertyValue, findUriPropertyValue, findUriPropertyValues, findVerificationCodePropertyValue, getNode, hashCode, isRefreshOnGet, removePropertyValue, resourcesEqual, setMultipleObjectsForSameNode, setPropertyUriValue, setPropertyUriValues, 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, toString, wait, wait, wait

Field Detail

RELATIONSHIP_TYPE_TO_TAG

@Deprecated
public static final Map<Relationship.RelationshipType,String> RELATIONSHIP_TYPE_TO_TAG

Deprecated.

TAG_TO_RELATIONSHIP_TYPE

@Deprecated
public static final Map<String,Relationship.RelationshipType> TAG_TO_RELATIONSHIP_TYPE

Deprecated.

Constructor Detail

Relationship

public Relationship(SpdxElement relatedSpdxElement,
            Relationship.RelationshipType relationshipType,
            String comment)

Parameters:

relatedSpdxElement - The SPDX Element that is related

relationshipType - Type of relationship - See the specification for a description of the types

comment - optional comment for the relationship

Relationship

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

Parameters:

model - Model containing the relationship

node - Node describing the relationship

Throws:

InvalidSPDXAnalysisException

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

verify

public List<String> verify()

Specified by:

verify in interface IRdfModel

Returns:

List of validation errors for any non SPDX compliant properties.

getType

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

Specified by:

getType in class RdfModelObject

Returns:

the RDF class name for the object

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

getUri

public String getUri(IModelContainer modelContainer)

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:

getRelationshipType

public Relationship.RelationshipType getRelationshipType()

Returns:

the relationshipType

setRelationshipType

public void setRelationshipType(Relationship.RelationshipType relationshipType)
                         throws InvalidSPDXAnalysisException

Parameters:

relationshipType - the relationshipType to set

Throws:

InvalidSPDXAnalysisException

getComment

public String getComment()

Returns:

the comment

setComment

public void setComment(String comment)

Parameters:

comment - the comment to set

getRelatedSpdxElement

public SpdxElement getRelatedSpdxElement()

Returns:

the relatedSpdxElement

setRelatedSpdxElement

public void setRelatedSpdxElement(SpdxElement relatedSpdxElement)
                           throws InvalidSPDXAnalysisException

Parameters:

relatedSpdxElement - the relatedSpdxElement to set

Throws:

InvalidSPDXAnalysisException

clone

public Relationship clone()

Overrides:

clone in class 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

Returns:

clone

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

Parameters:

clonedElementIds -

Returns:

compareTo

public int compareTo(Relationship o)

Specified by:

compareTo in interface Comparable<Relationship>