org.spdx.rdfparser.model

Class SpdxSnippet

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.model.SpdxElement

org.spdx.rdfparser.model.SpdxItem

org.spdx.rdfparser.model.SpdxSnippet

All Implemented Interfaces:

Cloneable, Comparable<SpdxSnippet>, IRdfModel

public class SpdxSnippet
extends SpdxItem
implements Comparable<SpdxSnippet>

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
SpdxSnippet(IModelContainer modelContainer, org.apache.jena.graph.Node node)
SpdxSnippet(String name, String comment, Annotation[] annotations, Relationship[] relationships, AnyLicenseInfo licenseConcluded, AnyLicenseInfo[] licenseInfoInFile, String copyrightText, String licenseComment, SpdxFile snippetFromFile, StartEndPointer byteRange, StartEndPointer lineRange)

Method Summary

Modifier and Type	Method and Description
SpdxSnippet	clone()
SpdxSnippet	clone(Map<String,SpdxElement> clonedElementIds) Clones this element, but prevents infinite recursion by keeping track of all elements which have been cloned
int	compareTo(SpdxSnippet 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
boolean	equivalent(IRdfModel o, boolean testRelationships) Test for equivalent
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.
StartEndPointer	getByteRange()
String	getLicenseInfoFromFilesPropertyName()
StartEndPointer	getLineRange()
void	getPropertiesFromModel() Fetch all of the properties from the model and populate the local Java properties
SpdxFile	getSnippetFromFile()
org.apache.jena.rdf.model.Resource	getType(org.apache.jena.rdf.model.Model model)
void	populateModel() Populate the RDF model from the Java properties
void	setByteRange(StartEndPointer byteRange)
void	setLineRange(StartEndPointer lineRange)
void	setSnippetFromFile(SpdxFile snippetFromFile)
String	toString()
List<String>	verify()

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

cloneLicenseConcluded, cloneLicenseInfosFromFiles, getCopyrightText, getLicenseComment, getLicenseComments, getLicenseConcluded, getLicenseInfoFromFiles, setCopyrightText, setLicenseComment, setLicenseComments, setLicenseConcluded, setLicenseInfosFromFiles

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

addAnnotation, addNameToWarnings, addRelationship, arraysEquivalent, arraysEquivalent, cloneAnnotations, cloneRelationships, equivalentConsideringNull, equivalentConsideringNull, getAnnotations, getComment, getId, getName, getNamePropertyName, getRelationships, getUri, setAnnotations, setComment, setId, setName, setRelationships

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

SpdxSnippet

public SpdxSnippet(String name,
                   String comment,
                   Annotation[] annotations,
                   Relationship[] relationships,
                   AnyLicenseInfo licenseConcluded,
                   AnyLicenseInfo[] licenseInfoInFile,
                   String copyrightText,
                   String licenseComment,
                   SpdxFile snippetFromFile,
                   StartEndPointer byteRange,
                   StartEndPointer lineRange)

Parameters:

name - Identify a specific snippet in a human convenient manner

comment - This field provides a place for the SPDX document creator to record any general comments about the snippet.

annotations -

relationships -

licenseConcluded - This field contains the license the SPDX file creator has concluded as governing the snippet or alternative values if the governing license cannot be determined

licenseInfoInFile -

copyrightText - Identify the copyright holder of the snippet, as well as any dates present.

licenseComment - This field provides a place for the SPDX document creator to record any relevant background references or analysis that went in to arriving at the Concluded License for a snippet

snippetFromFile - Uniquely identify the file in an SPDX document which this snippet is associated

byteRange - This field defines the byte range in the original host file (in X.2) that the snippet information applies to.

lineRange - This optional field defines the line range in the original host file (in X.2) that the snippet information applies to.

SpdxSnippet

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

Parameters:

modelContainer -

node -

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

Overrides:

getPropertiesFromModel in class SpdxItem

Throws:

InvalidSPDXAnalysisException

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

getLicenseInfoFromFilesPropertyName

public String getLicenseInfoFromFilesPropertyName()

Overrides:

getLicenseInfoFromFilesPropertyName in class SpdxItem

Returns:

Property name for licenseInfoFromFiles. Override if using a subproperty of "licenseDeclared".

getSnippetFromFile

public SpdxFile getSnippetFromFile()
                            throws InvalidSPDXAnalysisException

Returns:

the snippetFromFile

Throws:

InvalidSPDXAnalysisException

setSnippetFromFile

public void setSnippetFromFile(SpdxFile snippetFromFile)
                        throws InvalidSPDXAnalysisException

Parameters:

snippetFromFile - the snippetFromFile to set

Throws:

InvalidSPDXAnalysisException

getByteRange

public StartEndPointer getByteRange()
                             throws InvalidSPDXAnalysisException

Returns:

the byteRange

Throws:

InvalidSPDXAnalysisException

setByteRange

public void setByteRange(StartEndPointer byteRange)
                  throws InvalidSPDXAnalysisException

Parameters:

byteRange - the byteRange to set

Throws:

InvalidSPDXAnalysisException

getLineRange

public StartEndPointer getLineRange()
                             throws InvalidSPDXAnalysisException

Returns:

the lineRange

Throws:

InvalidSPDXAnalysisException

setLineRange

public void setLineRange(StartEndPointer lineRange)
                  throws InvalidSPDXAnalysisException

Parameters:

lineRange - the lineRange to set

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 SpdxItem

Throws:

InvalidSPDXAnalysisException

getType

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

Overrides:

getType in class SpdxItem

Returns:

the RDF class name for the 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

Overrides:

equivalent in class SpdxItem

Returns:

equivalent

public boolean equivalent(IRdfModel o,
                          boolean testRelationships)

Description copied from class: SpdxElement

Test for equivalent

Overrides:

equivalent in class SpdxItem

testRelationships - If true, test relationships

Returns:

clone

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

Description copied from class: SpdxElement

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

Overrides:

clone in class SpdxItem

Parameters:

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

Returns:

clone

public SpdxSnippet clone()

Overrides:

clone in class SpdxItem

verify

public List<String> verify()

Specified by:

verify in interface IRdfModel

Overrides:

verify in class SpdxItem

Returns:

List of validation errors for any non SPDX compliant properties.

compareTo

public int compareTo(SpdxSnippet o)

Specified by:

compareTo in interface Comparable<SpdxSnippet>

toString

public String toString()

Overrides:

toString in class SpdxElement