org.spdx.rdfparser.model

Class Annotation

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.model.Annotation

All Implemented Interfaces:

Cloneable, Comparable<Annotation>, IRdfModel

public class Annotation
extends RdfModelObject
implements Comparable<Annotation>

An Annotation is a comment on an SpdxItem by an agent.

Author:

Gary O'Neall

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Annotation.AnnotationType

Field Summary

Fields

Modifier and Type	Field and Description
static Map<Annotation.AnnotationType,String>	ANNOTATION_TYPE_TO_TAG Deprecated.
static Map<String,Annotation.AnnotationType>	TAG_TO_ANNOTATION_TYPE Deprecated.

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

model, modelContainer, node, refreshOnGet, resource

Constructor Summary

Constructors

Constructor and Description
Annotation(IModelContainer modelContainer, org.apache.jena.graph.Node annotationNode)
Annotation(String annotator, Annotation.AnnotationType annotationType, String date, String comment)

Method Summary

Modifier and Type	Method and Description
Annotation	clone()
int	compareTo(Annotation 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	getAnnotationDate()
Annotation.AnnotationType	getAnnotationType()
String	getAnnotationTypeTag()
String	getAnnotator()
String	getComment()
void	getPropertiesFromModel() Fetch all of the properties from the model and populate the local Java properties
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 model from the properties
void	setAnnotationDate(String date)
void	setAnnotationType(Annotation.AnnotationType annotationType)
void	setAnnotator(String annotator)
void	setComment(String comment)
List<String>	verify()

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

addPropertyUriValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, addPropertyValue, arraysEquivalent, createResource, createResource, equals, equivalentConsideringNull, 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, toString, wait, wait, wait

Field Detail

ANNOTATION_TYPE_TO_TAG

@Deprecated
public static final Map<Annotation.AnnotationType,String> ANNOTATION_TYPE_TO_TAG

Deprecated.

TAG_TO_ANNOTATION_TYPE

@Deprecated
public static final Map<String,Annotation.AnnotationType> TAG_TO_ANNOTATION_TYPE

Deprecated.

Constructor Detail

Annotation

public Annotation(String annotator,
                  Annotation.AnnotationType annotationType,
                  String date,
                  String comment)

Annotation

public Annotation(IModelContainer modelContainer,
                  org.apache.jena.graph.Node annotationNode)
           throws InvalidSPDXAnalysisException

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

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

populateModel

public void populateModel()
                   throws InvalidSPDXAnalysisException

Populate the model from the properties

Specified by:

populateModel 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.

getAnnotationType

public Annotation.AnnotationType getAnnotationType()

Returns:

the annotationType

setAnnotationType

public void setAnnotationType(Annotation.AnnotationType annotationType)
                       throws InvalidSPDXAnalysisException

Parameters:

annotationType - the annotationType to set

Throws:

InvalidSPDXAnalysisException

getAnnotator

public String getAnnotator()

Returns:

the annotator

setAnnotator

public void setAnnotator(String annotator)

Parameters:

annotator - the annotator to set

getComment

public String getComment()

Returns:

the comment

setComment

public void setComment(String comment)

Parameters:

comment - the comment to set

getAnnotationDate

public String getAnnotationDate()

Returns:

the date

setAnnotationDate

public void setAnnotationDate(String date)
                       throws InvalidSPDXAnalysisException

Parameters:

date - the date to set

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:

clone

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

getAnnotationTypeTag

public String getAnnotationTypeTag()

Returns:

The tag value of the annotation type

compareTo

public int compareTo(Annotation o)

Specified by:

compareTo in interface Comparable<Annotation>