org.spdx.merge

Class SpdxLicenseMapper

java.lang.Object

org.spdx.merge.SpdxLicenseMapper

public class SpdxLicenseMapper
extends Object

Author:

Gary

Constructor Summary

Constructors

Constructor and Description
SpdxLicenseMapper()

Method Summary

Modifier and Type	Method and Description
void	clearNonStdLicIdMap()
boolean	docInNonStdLicIdMap(SpdxDocument spdxDoc)
Map<AnyLicenseInfo,AnyLicenseInfo>	foundInterMap(SpdxDocument spdxDoc)
boolean	isNonStdLicIdMapEmpty()
AnyLicenseInfo	mapLicenseInfo(SpdxDocument spdxDoc, AnyLicenseInfo license) a method gets a sub SPDX document and licenses from declared licenses in document package.
AnyLicenseInfo	mapNonStdLicInMap(SpdxDocument spdxDoc, AnyLicenseInfo license) a method gets a sub SPDX document and one of its license (non-standard license).
void	mappingExistingNonStdLic(SpdxDocument output, ExtractedLicenseInfo outputDocLicense, SpdxDocument subDocs, ExtractedLicenseInfo subLicense) Maps a subDoc nonstandard license to an existing output document nonstandard license
ExtractedLicenseInfo	mappingNewNonStdLic(SpdxDocument outputDoc, SpdxDocument subDoc, ExtractedLicenseInfo subNonStdLicInfo) Creates a new non-standard license in the outputDoc and creates a mapping between the output document non-standard license and the subDoc non standard license This particular non-standard license is unique to the outputDoc document.
SpdxFile	replaceNonStdLicInFile(SpdxDocument spdxDoc, SpdxFile subFileInfo) a method gets a sub SPDX document and its file information.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpdxLicenseMapper

public SpdxLicenseMapper()

Method Detail

mappingNewNonStdLic

public ExtractedLicenseInfo mappingNewNonStdLic(SpdxDocument outputDoc,
                                                SpdxDocument subDoc,
                                                ExtractedLicenseInfo subNonStdLicInfo)

Creates a new non-standard license in the outputDoc and creates a mapping between the output document non-standard license and the subDoc non standard license This particular non-standard license is unique to the outputDoc document. The return variable subNonStdLicInfo is cloned from input non-standard license, but replace the license id.

Parameters:

outputDoc -

subDoc -

subNonStdLicInfo -

Returns:

mappingExistingNonStdLic

public void mappingExistingNonStdLic(SpdxDocument output,
                                     ExtractedLicenseInfo outputDocLicense,
                                     SpdxDocument subDocs,
                                     ExtractedLicenseInfo subLicense)

Maps a subDoc nonstandard license to an existing output document nonstandard license

Parameters:

output -

subDocs -

subLicense -

outputDocLicense -

replaceNonStdLicInFile

public SpdxFile replaceNonStdLicInFile(SpdxDocument spdxDoc,
                                       SpdxFile subFileInfo)
                                throws InvalidSPDXAnalysisException

a method gets a sub SPDX document and its file information. Check the non-standard licenses in the file information. Replace the non-standard licenses if this particular license in the HashMap.

Parameters:

spdxDoc -

subFileInfo -

Returns:

Throws:

InvalidSPDXAnalysisException

mapNonStdLicInMap

public AnyLicenseInfo mapNonStdLicInMap(SpdxDocument spdxDoc,
                                        AnyLicenseInfo license)

a method gets a sub SPDX document and one of its license (non-standard license). Replace the input license if it is found in the HashMap. And return the mapped license. If the input license doesn't in the HashMap, return the original input license.

Parameters:

spdxDoc -

license -

Returns:

mapLicenseInfo

public AnyLicenseInfo mapLicenseInfo(SpdxDocument spdxDoc,
                                     AnyLicenseInfo license)

a method gets a sub SPDX document and licenses from declared licenses in document package. Check the object type of input license. If the license is non-standard license, run the license through mapNonStdLicIndMap. Otherwise, return the original input license.

Parameters:

spdxDoc -

license -

Returns:

docInNonStdLicIdMap

public boolean docInNonStdLicIdMap(SpdxDocument spdxDoc)

Parameters:

spdxDoc -

Returns:

foundDocMatch

foundInterMap

public Map<AnyLicenseInfo,AnyLicenseInfo> foundInterMap(SpdxDocument spdxDoc)

Parameters:

spdxDoc -

Returns:

idMap

isNonStdLicIdMapEmpty

public boolean isNonStdLicIdMapEmpty()

Returns:

emptyMap

clearNonStdLicIdMap

public void clearNonStdLicIdMap()