org.spdx.rdfparser

Class SPDXFile

java.lang.Object

org.spdx.rdfparser.SPDXFile

All Implemented Interfaces:

Comparable<SPDXFile>

public class SPDXFile
extends Object
implements Comparable<SPDXFile>

Contains and SPDXFile object and updates the RDF model.

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field and Description
static HashMap<String,String>	FILE_TYPE_TO_RESOURCE
static HashMap<String,String>	RESOURCE_TO_FILE_TYPE

Constructor Summary

Constructors

Constructor and Description
SPDXFile(com.hp.hpl.jena.rdf.model.Model model, com.hp.hpl.jena.graph.Node fileNode) Construct an SPDX File form the fileNode
SPDXFile(String name, String type, String sha1, SPDXLicenseInfo concludedLicenses, SPDXLicenseInfo[] seenLicenses, String licenseComments, String copyright, DOAPProject[] artifactOf)
SPDXFile(String name, String type, String sha1, SPDXLicenseInfo concludedLicenses, SPDXLicenseInfo[] seenLicenses, String licenseComments, String copyright, DOAPProject[] artifactOf, String comment)
SPDXFile(String name, String type, String sha1, SPDXLicenseInfo concludedLicenses, SPDXLicenseInfo[] seenLicenses, String licenseComments, String copyright, DOAPProject[] artifactOf, String comment, SPDXFile[] fileDependencies, String[] contributors, String noticeText)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(SPDXFile file) This method is used for sorting a list of SPDX files
protected static com.hp.hpl.jena.rdf.model.Resource	convertToResource(com.hp.hpl.jena.rdf.model.Model cmodel, com.hp.hpl.jena.graph.Node cnode) Convert a node to a resource
com.hp.hpl.jena.rdf.model.Resource	createResource(com.hp.hpl.jena.rdf.model.Model model)
boolean	equals(Object o)
static String	fileTypeResourceToString(com.hp.hpl.jena.rdf.model.Resource fileTypeResource)
static com.hp.hpl.jena.rdf.model.Resource	fileTypeStringToTypeResource(String fileType, com.hp.hpl.jena.rdf.model.Model model) Converts a string file type to an RDF resource
protected static com.hp.hpl.jena.rdf.model.Resource	findFileResource(com.hp.hpl.jena.rdf.model.Model model, SPDXFile spdxFile) Finds the resource for an existing file in the model
DOAPProject[]	getArtifactOf()
String	getComment()
SPDXLicenseInfo	getConcludedLicenses()
String[]	getContributors()
String	getCopyright()
SPDXFile[]	getFileDependencies()
String	getLicenseComments()
String	getName()
String	getNoticeText()
protected com.hp.hpl.jena.rdf.model.Resource	getResource()
SPDXLicenseInfo[]	getSeenLicenses()
String	getSha1()
String	getType()
void	setArtifactOf(DOAPProject[] artifactOf)
void	setComment(String comment)
void	setConcludedLicenses(SPDXLicenseInfo fileLicenses)
void	setContributors(String[] contributors) Set the contributors to the file
void	setCopyright(String copyright)
void	setFileDependencies(SPDXFile[] fileDependencies) Set the file dependencies for this file
void	setLicenseComments(String licenseComments)
void	setName(String name)
void	setNoticeText(String noticeText)
void	setSeenLicenses(SPDXLicenseInfo[] seenLicenses)
void	setSha1(String sha1)
void	setType(String type)
ArrayList<String>	verify()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FILE_TYPE_TO_RESOURCE

public static HashMap<String,String> FILE_TYPE_TO_RESOURCE

RESOURCE_TO_FILE_TYPE

public static HashMap<String,String> RESOURCE_TO_FILE_TYPE

Constructor Detail

SPDXFile

public SPDXFile(com.hp.hpl.jena.rdf.model.Model model,
        com.hp.hpl.jena.graph.Node fileNode)
         throws InvalidSPDXAnalysisException

Construct an SPDX File form the fileNode

Parameters:

fileNode - RDF Graph node representing the SPDX File

Throws:

InvalidSPDXAnalysisException

SPDXFile

public SPDXFile(String name,
        String type,
        String sha1,
        SPDXLicenseInfo concludedLicenses,
        SPDXLicenseInfo[] seenLicenses,
        String licenseComments,
        String copyright,
        DOAPProject[] artifactOf,
        String comment,
        SPDXFile[] fileDependencies,
        String[] contributors,
        String noticeText)

SPDXFile

public SPDXFile(String name,
        String type,
        String sha1,
        SPDXLicenseInfo concludedLicenses,
        SPDXLicenseInfo[] seenLicenses,
        String licenseComments,
        String copyright,
        DOAPProject[] artifactOf)

SPDXFile

public SPDXFile(String name,
        String type,
        String sha1,
        SPDXLicenseInfo concludedLicenses,
        SPDXLicenseInfo[] seenLicenses,
        String licenseComments,
        String copyright,
        DOAPProject[] artifactOf,
        String comment)

Method Detail

convertToResource

protected static com.hp.hpl.jena.rdf.model.Resource convertToResource(com.hp.hpl.jena.rdf.model.Model cmodel,
                                                   com.hp.hpl.jena.graph.Node cnode)
                                                               throws InvalidSPDXAnalysisException

Convert a node to a resource

Parameters:

cmodel -

cnode -

Returns:

Throws:

InvalidSPDXAnalysisException

createResource

public com.hp.hpl.jena.rdf.model.Resource createResource(com.hp.hpl.jena.rdf.model.Model model)
                                                  throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

findFileResource

protected static com.hp.hpl.jena.rdf.model.Resource findFileResource(com.hp.hpl.jena.rdf.model.Model model,
                                                  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

getSeenLicenses

public SPDXLicenseInfo[] getSeenLicenses()

Returns:

the seenLicenses

Throws:

InvalidSPDXAnalysisException

setSeenLicenses

public void setSeenLicenses(SPDXLicenseInfo[] seenLicenses)

Parameters:

seenLicenses - the seenLicenses to set

getLicenseComments

public String getLicenseComments()

Returns:

the licenseComments

setLicenseComments

public void setLicenseComments(String licenseComments)

Parameters:

licenseComments - the licenseComments to set

getNoticeText

public String getNoticeText()

Returns:

the noticeText

setNoticeText

public void setNoticeText(String noticeText)

Parameters:

noticeTexgt - the noticeText to set

getComment

public String getComment()

setComment

public void setComment(String comment)

getCopyright

public String getCopyright()

Returns:

the copyright

setCopyright

public void setCopyright(String copyright)

Parameters:

copyright - the copyright to set

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

getConcludedLicenses

public SPDXLicenseInfo getConcludedLicenses()

Returns:

the fileLicenses

Throws:

InvalidSPDXAnalysisException

setConcludedLicenses

public void setConcludedLicenses(SPDXLicenseInfo fileLicenses)

Parameters:

fileLicenses - the fileLicenses to set

getSha1

public String getSha1()

Returns:

the sha1

Throws:

InvalidSPDXAnalysisException

setSha1

public void setSha1(String sha1)

Parameters:

sha1 - the sha1 to set

getType

public String getType()

Returns:

the type

Throws:

InvalidSPDXAnalysisException

setType

public void setType(String type)
             throws InvalidSPDXAnalysisException

Parameters:

type - the type to set

Throws:

InvalidSPDXAnalysisException

fileTypeStringToTypeResource

public static com.hp.hpl.jena.rdf.model.Resource fileTypeStringToTypeResource(String fileType,
                                                              com.hp.hpl.jena.rdf.model.Model model)
                                                                       throws InvalidSPDXAnalysisException

Converts a string file type to an RDF resource

Parameters:

fileType -

Returns:

Throws:

InvalidSPDXAnalysisException

fileTypeResourceToString

public static String fileTypeResourceToString(com.hp.hpl.jena.rdf.model.Resource fileTypeResource)
                                       throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

getArtifactOf

public DOAPProject[] getArtifactOf()

Returns:

the artifactOf

Throws:

InvalidSPDXAnalysisException

setArtifactOf

public void setArtifactOf(DOAPProject[] artifactOf)

Parameters:

artifactOf - the artifactOf to set

verify

public ArrayList<String> verify()

Returns:

getFileDependencies

public SPDXFile[] getFileDependencies()

Returns:

file dependencies

Throws:

InvalidSPDXAnalysisException

setFileDependencies

public void setFileDependencies(SPDXFile[] fileDependencies)
                         throws InvalidSPDXAnalysisException

Set the file dependencies for this file

Parameters:

fileDependencies -

Throws:

InvalidSPDXAnalysisException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getResource

protected com.hp.hpl.jena.rdf.model.Resource getResource()

Returns:

the Jena resource if it exists in the model

getContributors

public String[] getContributors()

Returns:

contributors to the file

setContributors

public void setContributors(String[] contributors)

Set the contributors to the file

Parameters:

contributors -

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: