org.spdx.rdfparser.model

Class Checksum

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.model.Checksum

All Implemented Interfaces:

Cloneable, Comparable<Checksum>, IRdfModel

public class Checksum
extends RdfModelObject
implements Comparable<Checksum>

A Checksum is value that allows the contents of a file to be authenticated. Even small changes to the content of the file will change its checksum. This class allows the results of a variety of checksum and cryptographic message digest algorithms to be represented.

Author:

Gary O'Neall

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Checksum.ChecksumAlgorithm

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.collect.ImmutableMap<Checksum.ChecksumAlgorithm,String>	CHECKSUM_ALGORITHM_TO_TAG
static com.google.common.collect.ImmutableMap<String,Checksum.ChecksumAlgorithm>	CHECKSUM_TAG_TO_ALGORITHM

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

model, modelContainer, node, refreshOnGet, resource

Constructor Summary

Constructors

Constructor and Description
Checksum(Checksum.ChecksumAlgorithm algorithm, String checksumValue)
Checksum(IModelContainer modelContainer, org.apache.jena.graph.Node node)

Method Summary

Modifier and Type	Method and Description
Checksum	clone()
int	compareTo(Checksum compare)
boolean	equivalent(IRdfModel compare) Returns true if the compare object contains properties which would be equal if they were contained in the same RDF Model
org.apache.jena.rdf.model.Resource	findDuplicateResource(IModelContainer modelContainer, String uri) Search the model to see if there is a duplicate resource either based on the URI or based on other information.
protected static org.apache.jena.rdf.model.Resource	findSpdxChecksum(org.apache.jena.rdf.model.Model model, Checksum checksum)
Checksum.ChecksumAlgorithm	getAlgorithm()
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.
String	getValue()
void	populateModel() Populate the RDF model from the Java properties
void	setAlgorithm(Checksum.ChecksumAlgorithm algorithm)
void	setValue(String checksumValue)
String	toString()
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, 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

CHECKSUM_ALGORITHM_TO_TAG

public static final com.google.common.collect.ImmutableMap<Checksum.ChecksumAlgorithm,String> CHECKSUM_ALGORITHM_TO_TAG

CHECKSUM_TAG_TO_ALGORITHM

public static final com.google.common.collect.ImmutableMap<String,Checksum.ChecksumAlgorithm> CHECKSUM_TAG_TO_ALGORITHM

Constructor Detail

Checksum

public Checksum(Checksum.ChecksumAlgorithm algorithm,
                String checksumValue)

Checksum

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

Parameters:

modelContainer -

node -

Throws:

InvalidSPDXAnalysisException

Method Detail

findSpdxChecksum

protected static org.apache.jena.rdf.model.Resource findSpdxChecksum(org.apache.jena.rdf.model.Model model,
                                                                     Checksum checksum)
                                                              throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

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

getAlgorithm

public Checksum.ChecksumAlgorithm getAlgorithm()

Returns:

the algorithm

setAlgorithm

public void setAlgorithm(Checksum.ChecksumAlgorithm algorithm)
                  throws InvalidSPDXAnalysisException

Parameters:

algorithm - the algorithm to set

Throws:

InvalidSPDXAnalysisException

getValue

public String getValue()

Returns:

the checksumValue

setValue

public void setValue(String checksumValue)

Parameters:

checksumValue - the checksumValue to set

verify

public List<String> verify()

Specified by:

verify in interface IRdfModel

Returns:

List of validation errors for any non SPDX compliant properties.

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:

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

findDuplicateResource

public org.apache.jena.rdf.model.Resource findDuplicateResource(IModelContainer modelContainer,
                                                                String uri)
                                                         throws InvalidSPDXAnalysisException

Description copied from class: RdfModelObject

Search the model to see if there is a duplicate resource either based on the URI or based on other information. Subclasses may choose to override this method to prevent duplicate resource from being created with the same properties.

Overrides:

findDuplicateResource in class RdfModelObject

Returns:

Any duplicate resource found. Null if no duplicate resource was found.

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

clone

public Checksum clone()

Overrides:

clone in class Object

equivalent

public boolean equivalent(IRdfModel compare)

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:

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Checksum compare)

Specified by:

compareTo in interface Comparable<Checksum>