Class LicenseRdfaFormatWriter

java.lang.Object

org.spdx.licenselistpublisher.licensegenerator.LicenseRdfaFormatWriter

All Implemented Interfaces:

ILicenseFormatWriter

public class LicenseRdfaFormatWriter
extends Object
implements ILicenseFormatWriter

Author:

Gary O'Neall

Constructor Summary

Constructors

Constructor	Description
LicenseRdfaFormatWriter(String version, String releaseDate, File rdfaFolder)

Method Summary

Modifier and Type	Method	Description
LicenseHTMLFile	getLicHtml()
File	getRdfaFolder()
String	getReleaseDate()
LicenseTOCHTMLFile	getTableOfContentsHTML()
String	getVersion()
void	setLicHtml(LicenseHTMLFile licHtml)
void	setRdfaFolder(File rdfaFolder)
void	setReleaseDate(String releaseDate)
void	setTableOfContentsHTML(LicenseTOCHTMLFile tableOfContentsHTML)
void	setVersion(String version)
void	writeException(ListedExceptionContainer exceptionContainer)
void	writeLicense(ListedLicenseContainer licenseContainer, boolean deprecated, String deprecatedVersion)	Formats and writes a specific license
void	writeToC()	Write the Table of Contents file for the format if applicable

Methods inherited from class java.lang.Object

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

Constructor Details

LicenseRdfaFormatWriter

public LicenseRdfaFormatWriter(String version,
 String releaseDate,
 File rdfaFolder)

Parameters:

version - License list version

releaseDate - release date for the license list

rdfaFolder - Folder to store all of the RDFa files

Method Details

getRdfaFolder

public File getRdfaFolder()

Returns:

the rdfaFolder

setRdfaFolder

public void setRdfaFolder(File rdfaFolder)

Parameters:

rdfaFolder - the rdfaFolder to set

getVersion

public String getVersion()

Returns:

the version

setVersion

public void setVersion(String version)

Parameters:

version - the version to set

getReleaseDate

public String getReleaseDate()

Returns:

the releaseDate

setReleaseDate

public void setReleaseDate(String releaseDate)

Parameters:

releaseDate - the releaseDate to set

getLicHtml

public LicenseHTMLFile getLicHtml()

Returns:

the licHtml

setLicHtml

public void setLicHtml(LicenseHTMLFile licHtml)

Parameters:

licHtml - the licHtml to set

getTableOfContentsHTML

public LicenseTOCHTMLFile getTableOfContentsHTML()

Returns:

the tableOfContentsHTML

setTableOfContentsHTML

public void setTableOfContentsHTML(LicenseTOCHTMLFile tableOfContentsHTML)

Parameters:

tableOfContentsHTML - the tableOfContentsHTML to set

writeLicense

public void writeLicense(ListedLicenseContainer licenseContainer,
 boolean deprecated,
 String deprecatedVersion)
                  throws IOException,
LicenseGeneratorException,
org.spdx.core.InvalidSPDXAnalysisException

Description copied from interface: ILicenseFormatWriter

Formats and writes a specific license

Specified by:

writeLicense in interface ILicenseFormatWriter

Parameters:

licenseContainer - License to be added

deprecated - True if deprecated

deprecatedVersion - License list version when the license was deprecated, null otherwise

Throws:

IOException

LicenseGeneratorException

org.spdx.core.InvalidSPDXAnalysisException

writeToC

public void writeToC()
              throws IOException

Description copied from interface: ILicenseFormatWriter

Write the Table of Contents file for the format if applicable

Specified by:

writeToC in interface ILicenseFormatWriter

Throws:

IOException

writeException

public void writeException(ListedExceptionContainer exceptionContainer)
                    throws IOException,
org.spdx.licenseTemplate.InvalidLicenseTemplateException,
org.spdx.core.InvalidSPDXAnalysisException

Specified by:

writeException in interface ILicenseFormatWriter

Parameters:

exceptionContainer - Exception to be formatted and written

Throws:

IOException

org.spdx.licenseTemplate.InvalidLicenseTemplateException

org.spdx.core.InvalidSPDXAnalysisException