org.spdx.rdfparser.model

Class SpdxFile

java.lang.Object

org.spdx.rdfparser.model.RdfModelObject

org.spdx.rdfparser.model.SpdxElement

org.spdx.rdfparser.model.SpdxItem

org.spdx.rdfparser.model.SpdxFile

All Implemented Interfaces:

Cloneable, Comparable<SpdxFile>, IRdfModel

public class SpdxFile
extends SpdxItem
implements Comparable<SpdxFile>

A File represents a named sequence of information that is contained in a software package.

Author:

Gary O'Neall

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpdxFile.FileType

Field Summary

Fields

Modifier and Type	Field and Description
static Map<SpdxFile.FileType,String>	FILE_TYPE_TO_TAG Deprecated.
static Map<String,SpdxFile.FileType>	TAG_TO_FILE_TYPE Deprecated.

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
SpdxFile(IModelContainer modelContainer, org.apache.jena.graph.Node node)
SpdxFile(String fileName, SpdxFile.FileType[] fileTypes, String sha1Value, AnyLicenseInfo licenseConcluded, AnyLicenseInfo[] licenseInfoInFiles, String licenseComment, String copyrightText, DoapProject[] artifactOfs, String fileComment)
SpdxFile(String name, String comment, Annotation[] annotations, Relationship[] relationships, AnyLicenseInfo licenseConcluded, AnyLicenseInfo[] licenseInfoInFile, String copyrightText, String licenseComment, SpdxFile.FileType[] fileTypes, Checksum[] checksums, String[] fileContributors, String noticeText, DoapProject[] artifactOf)

Method Summary

Modifier and Type	Method and Description
void	addChecksum(Checksum checksum) Add a checksum
void	addFileType(SpdxFile.FileType fileType) Add a file type to this file
SpdxFile	clone()
SpdxFile	clone(Map<String,SpdxElement> clonedElementIds) Clones this element, but prevents infinite recursion by keeping track of all elements which have been cloned
protected DoapProject[]	cloneArtifactOf()
protected Checksum[]	cloneChecksum()
SpdxFile[]	cloneFileDependencies(Map<String,SpdxElement> clonedElementIds)
int	compareTo(SpdxFile file) This method is used for sorting a list of SPDX files
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.
protected static org.apache.jena.rdf.model.Resource	findFileResource(IModelContainer modelContainer, SpdxFile spdxFile) Finds the resource for an existing file in the model
DoapProject[]	getArtifactOf() Deprecated.
Checksum[]	getChecksums()
AnyLicenseInfo	getConcludedLicenses() Deprecated.
String[]	getContributors() Deprecated.
String	getCopyright() Deprecated.
String[]	getFileContributors()
SpdxFile[]	getFileDependencies() Deprecated.
SpdxFile.FileType[]	getFileTypes()
protected String	getLicenseInfoFromFilesPropertyName()
protected String	getNamePropertyName()
String	getNoticeText()
void	getPropertiesFromModel() Fetch all of the properties from the model and populate the local Java properties
AnyLicenseInfo[]	getSeenLicenses() Deprecated.
String	getSha1()
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	setArtifactOf(DoapProject[] artifactOf) Deprecated.
void	setChecksums(Checksum[] checksums)
void	setConcludedLicenses(AnyLicenseInfo concludedLicense) Deprecated.
void	setContributors(String[] contributors) Deprecated.
void	setCopyright(String copyright) Deprecated.
void	setFileContributors(String[] fileContributors)
void	setFileDependencies(SpdxFile[] fileDependencies) Deprecated.
void	setFileTypes(SpdxFile.FileType[] fileTypes)
void	setNoticeText(String noticeText)
void	setSeenLicenses(AnyLicenseInfo[] seenLicenses) Deprecated.
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, getRelationships, getUri, setAnnotations, setComment, setId, setName, setRelationships, toString

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

Field Detail

FILE_TYPE_TO_TAG

@Deprecated
public static final Map<SpdxFile.FileType,String> FILE_TYPE_TO_TAG

Deprecated.

TAG_TO_FILE_TYPE

@Deprecated
public static final Map<String,SpdxFile.FileType> TAG_TO_FILE_TYPE

Deprecated.

Constructor Detail

SpdxFile

public SpdxFile(String name,
                String comment,
                Annotation[] annotations,
                Relationship[] relationships,
                AnyLicenseInfo licenseConcluded,
                AnyLicenseInfo[] licenseInfoInFile,
                String copyrightText,
                String licenseComment,
                SpdxFile.FileType[] fileTypes,
                Checksum[] checksums,
                String[] fileContributors,
                String noticeText,
                DoapProject[] artifactOf)
         throws InvalidSPDXAnalysisException

Parameters:

name - fileName

comment - Comment on the file

annotations - annotations for the file

relationships - Relationships to this file

licenseConcluded -

licenseInfoInFile -

copyrightText -

licenseComment -

Throws:

InvalidSPDXAnalysisException

SpdxFile

public SpdxFile(String fileName,
                SpdxFile.FileType[] fileTypes,
                String sha1Value,
                AnyLicenseInfo licenseConcluded,
                AnyLicenseInfo[] licenseInfoInFiles,
                String licenseComment,
                String copyrightText,
                DoapProject[] artifactOfs,
                String fileComment)
         throws InvalidSPDXAnalysisException

Parameters:

fileName -

fileTypes -

sha1Value -

licenseConcluded -

licenseInfoInFiles -

licenseComment -

copyrightText -

artifactOfs -

fileComment -

Throws:

InvalidSPDXAnalysisException

SpdxFile

public SpdxFile(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

findFileResource

protected static org.apache.jena.rdf.model.Resource findFileResource(IModelContainer modelContainer,
                                                                     SpdxFile spdxFile)
                                                              throws InvalidSPDXAnalysisException

Finds the resource for an existing file in the model

Parameters:

spdxFile -

Returns:

resource of an SPDX file with the same name and checksum. Null if none found

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

getSha1

public String getSha1()

Returns:

the Sha1 checksum value for this file, or a blank string if no sha1 checksum has been set

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

getLicenseInfoFromFilesPropertyName

protected String getLicenseInfoFromFilesPropertyName()

Overrides:

getLicenseInfoFromFilesPropertyName in class SpdxItem

Returns:

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

getNamePropertyName

protected String getNamePropertyName()

Overrides:

getNamePropertyName in class SpdxElement

Returns:

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

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

getFileTypes

public SpdxFile.FileType[] getFileTypes()

Returns:

the fileType

setFileTypes

public void setFileTypes(SpdxFile.FileType[] fileTypes)
                  throws InvalidSPDXAnalysisException

Parameters:

fileTypes - the fileTypes to set

Throws:

InvalidSPDXAnalysisException

addFileType

public void addFileType(SpdxFile.FileType fileType)
                 throws InvalidSPDXAnalysisException

Add a file type to this file

Parameters:

fileType -

Throws:

InvalidSPDXAnalysisException

getChecksums

public Checksum[] getChecksums()

Returns:

the checksums

setChecksums

public void setChecksums(Checksum[] checksums)
                  throws InvalidSPDXAnalysisException

Parameters:

checksums - the checksums to set

Throws:

InvalidSPDXAnalysisException

addChecksum

public void addChecksum(Checksum checksum)
                 throws InvalidSPDXAnalysisException

Add a checksum

Parameters:

checksum -

Throws:

InvalidSPDXAnalysisException

getFileContributors

public String[] getFileContributors()

Returns:

the fileContributors

setFileContributors

public void setFileContributors(String[] fileContributors)

Parameters:

fileContributors - the fileContributors to set

getNoticeText

public String getNoticeText()

Returns:

the noticeText

setNoticeText

public void setNoticeText(String noticeText)

Parameters:

noticeText - the noticeText to set

getArtifactOf

@Deprecated
public DoapProject[] getArtifactOf()

Deprecated.

Artifact of has been replaced by a relationship to a package with the filesAnalyzed set to false

Returns:

the artifactOf

setArtifactOf

@Deprecated
public void setArtifactOf(DoapProject[] artifactOf)
                                throws InvalidSPDXAnalysisException

Deprecated.

Artifact of has been replaced by a relationship to a package with the filesAnalyzed set to false

Parameters:

artifactOf - the artifactOf to set

Throws:

InvalidSPDXAnalysisException

getFileDependencies

@Deprecated
public SpdxFile[] getFileDependencies()

Deprecated.

This method should no longer be used. The Relationship property should be used in its place.

Returns:

the fileDependencies

setFileDependencies

@Deprecated
public void setFileDependencies(SpdxFile[] fileDependencies)
                                      throws InvalidSPDXAnalysisException

Deprecated.

This method should no longer be used. The Relationship property should be used in its place.

Parameters:

fileDependencies - the fileDependencies to set

Throws:

InvalidSPDXAnalysisException

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:

cloneChecksum

protected Checksum[] cloneChecksum()

cloneArtifactOf

protected DoapProject[] cloneArtifactOf()

cloneFileDependencies

public SpdxFile[] cloneFileDependencies(Map<String,SpdxElement> clonedElementIds)

clone

public SpdxFile 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 SpdxFile 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(SpdxFile file)

This method is used for sorting a list of SPDX files

Specified by:

compareTo in interface Comparable<SpdxFile>

Parameters:

file - SPDXFile that is compared

Returns:

getCopyright

@Deprecated
public String getCopyright()

Deprecated.

This method should be replaced by the more consistent getCopyrightText This method will be removed in a future release

Returns:

setCopyright

@Deprecated
public void setCopyright(String copyright)

Deprecated.

This method should be replaced by the more consistent setCopyrightText This method will be removed in a future release

Parameters:

copyright -

getConcludedLicenses

@Deprecated
public AnyLicenseInfo getConcludedLicenses()

Deprecated.

This method should be replaced by the more consistent getLicenseConcluded This method will be removed in a future release

Returns:

setConcludedLicenses

@Deprecated
public void setConcludedLicenses(AnyLicenseInfo concludedLicense)
                                       throws InvalidSPDXAnalysisException

Deprecated.

This method should be replaced by the more consistent setLicenseConcluded This method will be removed in a future release

Throws:

InvalidSPDXAnalysisException

getContributors

@Deprecated
public String[] getContributors()

Deprecated.

This method should be replaced by the more consistent getFileContributors This method will be removed in a future release

Returns:

setContributors

@Deprecated
public void setContributors(String[] contributors)

Deprecated.

This method should be replaced by the more consistent setFileContributors This method will be removed in a future release

getSeenLicenses

@Deprecated
public AnyLicenseInfo[] getSeenLicenses()

Deprecated.

This method should be replaced by the more consistent getLicenseInfoFromFiles This method will be removed in a future release

Returns:

setSeenLicenses

@Deprecated
public void setSeenLicenses(AnyLicenseInfo[] seenLicenses)
                                  throws InvalidSPDXAnalysisException

Deprecated.

This method should be replaced by the more consistent setLicenseInfoFromFiles This method will be removed in a future release

Throws:

InvalidSPDXAnalysisException