org.spdx.tools

Class ConvertLicenseListXml

java.lang.Object

org.spdx.tools.ConvertLicenseListXml

All Implemented Interfaces:

SpdxRdfConstants

public class ConvertLicenseListXml
extends Object
implements SpdxRdfConstants

Convert the license list XML from the schema used prior to June 2017 to the standard terms documented at https://docs.google.com/document/d/1z9n44xLH2MxT576KS_AbTOBtecyl5cw6RsrrQHibQtg/edit

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field and Description
static String	OLD_ALTERNATIVE_TAG
static String	OLD_BODY_TAG
static String	OLD_BREAK_TAG
static String	OLD_BULLET_TAG
static String	OLD_COPYRIGHT_TAG
static String	OLD_DEPRECATED_ATTRIBUTE
static String	OLD_EXCEPTION_TAG
static String	OLD_HEADER_TAG
static String	OLD_ID_ATTRIBUTE
static String	OLD_LICENSE_TAG
static String	OLD_LIST_ITEM_TAG
static String	OLD_LIST_TAG
static String	OLD_NAME_ATTRIBUTE
static String	OLD_NOTES_TAG
static String	OLD_OPTIONAL_TAG
static String	OLD_OSI_APPROVED_ATTRIBUTE
static String	OLD_PARAGRAPH_TAG
static String	OLD_ROOT_ELEMENT_NAME
static String	OLD_TITLE_TAG
static String	OLD_URL_TAG
static String	OLD_URLS_TAG
static String	OLD_VAR_MATCH_ATTRIBUTE
static String	OLD_VAR_NAME_ATTRIBUTE
static String	OLD_VAR_ORIGINAL_ATTRIBUTE
static Map<String,String>	TAG_MAP Map of old tag names to new tag names

Fields inherited from interface org.spdx.rdfparser.SpdxRdfConstants

ALGORITHM_SHA1, CLASS_ANNOTATION, CLASS_DOAP_PROJECT, CLASS_EXTERNAL_DOC_REF, CLASS_OR_LATER_OPERATOR, CLASS_POINTER_BYTE_OFFSET_POINTER, CLASS_POINTER_LINE_CHAR_POINTER, CLASS_POINTER_START_END_POINTER, CLASS_RELATIONSHIP, CLASS_SPDX_ANY_LICENSE_INFO, CLASS_SPDX_CHECKSUM, CLASS_SPDX_CONJUNCTIVE_LICENSE_SET, CLASS_SPDX_CREATION_INFO, CLASS_SPDX_DISJUNCTIVE_LICENSE_SET, CLASS_SPDX_DOCUMENT, CLASS_SPDX_ELEMENT, CLASS_SPDX_EXTERNAL_REFERENCE, CLASS_SPDX_EXTRACTED_LICENSING_INFO, CLASS_SPDX_FILE, CLASS_SPDX_ITEM, CLASS_SPDX_LICENSE, CLASS_SPDX_LICENSE_EXCEPTION, CLASS_SPDX_PACKAGE, CLASS_SPDX_REFERENCE_TYPE, CLASS_SPDX_REVIEW, CLASS_SPDX_SIMPLE_LICENSE_INFO, CLASS_SPDX_SNIPPET, CLASS_SPDX_VERIFICATIONCODE, CLASS_WITH_EXCEPTION_OPERATOR, CREATOR_PREFIX_ORGANIZATION, CREATOR_PREFIX_PERSON, CREATOR_PREFIX_TOOL, DOAP_NAMESPACE, EXTERNAL_DOC_REF_PATTERN, EXTERNAL_DOC_REF_PRENUM, EXTERNAL_ELEMENT_REF_PATTERN, FILE_TYPE_ARCHIVE, FILE_TYPE_BINARY, FILE_TYPE_OTHER, FILE_TYPE_SOURCE, LICENSE_ID_PATTERN, LICENSE_ID_PATTERN_NUMERIC, LICENSEXML_ATTRIBUTE_ALT_MATCH, LICENSEXML_ATTRIBUTE_ALT_NAME, LICENSEXML_ATTRIBUTE_DEPRECATED, LICENSEXML_ATTRIBUTE_DEPRECATED_VERSION, LICENSEXML_ATTRIBUTE_ID, LICENSEXML_ATTRIBUTE_LIST_VERSION_ADDED, LICENSEXML_ATTRIBUTE_NAME, LICENSEXML_ATTRIBUTE_OSI_APPROVED, LICENSEXML_ELEMENT_ALT, LICENSEXML_ELEMENT_BREAK, LICENSEXML_ELEMENT_BULLET, LICENSEXML_ELEMENT_COPYRIGHT_TEXT, LICENSEXML_ELEMENT_CROSS_REF, LICENSEXML_ELEMENT_CROSS_REFS, LICENSEXML_ELEMENT_EXAMPLE, LICENSEXML_ELEMENT_EXCEPTION, LICENSEXML_ELEMENT_ITEM, LICENSEXML_ELEMENT_LICENSE, LICENSEXML_ELEMENT_LICENSE_COLLECTION, LICENSEXML_ELEMENT_LIST, LICENSEXML_ELEMENT_NOTES, LICENSEXML_ELEMENT_OPTIONAL, LICENSEXML_ELEMENT_PARAGRAPH, LICENSEXML_ELEMENT_STANDARD_LICENSE_HEADER, LICENSEXML_ELEMENT_TITLE_TEXT, LICENSEXML_URI, NOASSERTION_VALUE, NON_STD_LICENSE_ID_PRENUM, NONE_VALUE, OWL_NAMESPACE, PROP_ANNOTATION, PROP_ANNOTATION_DATE, PROP_ANNOTATION_TYPE, PROP_ANNOTATOR, PROP_CHECKSUM_ALGORITHM, PROP_CHECKSUM_ALGORITHM_SHA1, PROP_CHECKSUM_VALUE, PROP_COPYRIGHT_TEXT, PROP_CREATION_CREATED, PROP_CREATION_CREATOR, PROP_EXAMPLE, PROP_EXCEPTION_TEXT, PROP_EXTERNAL_DOC_CHECKSUM, PROP_EXTERNAL_DOC_ID, PROP_EXTERNAL_REF, PROP_EXTERNAL_SPDX_DOCUMENT, PROP_EXTRACTED_TEXT, PROP_FILE_ARTIFACTOF, PROP_FILE_CHECKSUM, PROP_FILE_CONTRIBUTOR, PROP_FILE_COPYRIGHT, PROP_FILE_FILE_DEPENDENCY, PROP_FILE_LIC_COMMENTS, PROP_FILE_LICENSE, PROP_FILE_NAME, PROP_FILE_NOTICE, PROP_FILE_SEEN_LICENSE, PROP_FILE_TYPE, PROP_FILE_TYPE_ARCHIVE, PROP_FILE_TYPE_BINARY, PROP_FILE_TYPE_OTHER, PROP_FILE_TYPE_SOURCE, PROP_LIC_COMMENTS, PROP_LIC_ID_DEPRECATED, PROP_LICENSE_CONCLUDED, PROP_LICENSE_DECLARED, PROP_LICENSE_EXCEPTION, PROP_LICENSE_EXCEPTION_ID, PROP_LICENSE_ID, PROP_LICENSE_INFO_FROM_SNIPPETS, PROP_LICENSE_LIST_VERSION, PROP_LICENSE_NAME, PROP_LICENSE_SET_MEMEBER, PROP_LICENSE_TEXT, PROP_NAME, PROP_OWL_SAME_AS, PROP_PACKAGE_CHECKSUM, PROP_PACKAGE_CONCLUDED_LICENSE, PROP_PACKAGE_DECLARED_COPYRIGHT, PROP_PACKAGE_DECLARED_LICENSE, PROP_PACKAGE_DECLARED_NAME, PROP_PACKAGE_DESCRIPTION, PROP_PACKAGE_DOWNLOAD_URL, PROP_PACKAGE_FILE, PROP_PACKAGE_FILE_NAME, PROP_PACKAGE_FILES_ANALYZED, PROP_PACKAGE_LICENSE_COMMENT, PROP_PACKAGE_LICENSE_INFO_FROM_FILES, PROP_PACKAGE_ORIGINATOR, PROP_PACKAGE_SHORT_DESC, PROP_PACKAGE_SOURCE_INFO, PROP_PACKAGE_SUPPLIER, PROP_PACKAGE_VERIFICATION_CODE, PROP_PACKAGE_VERSION_INFO, PROP_POINTER_END_POINTER, PROP_POINTER_LINE_NUMBER, PROP_POINTER_OFFSET, PROP_POINTER_REFERENCE, PROP_POINTER_START_POINTER, PROP_PROJECT_HOMEPAGE, PROP_PROJECT_NAME, PROP_REFERENCE_CATEGORY, PROP_REFERENCE_LOCATOR, PROP_REFERENCE_TYPE, PROP_RELATED_SPDX_ELEMENT, PROP_RELATIONSHIP, PROP_RELATIONSHIP_TYPE, PROP_REVIEW_DATE, PROP_REVIEW_REVIEWER, PROP_SNIPPET_FROM_FILE, PROP_SNIPPET_RANGE, PROP_SPDX_CREATION_INFO, PROP_SPDX_DATA_LICENSE, PROP_SPDX_EXTERNAL_DOC_REF, PROP_SPDX_EXTRACTED_LICENSES, PROP_SPDX_FILE_REFERENCE, PROP_SPDX_PACKAGE, PROP_SPDX_REVIEWED_BY, PROP_SPDX_VERSION, PROP_STD_LICENSE_HEADER_VERSION_1, PROP_STD_LICENSE_NAME, PROP_STD_LICENSE_NAME_VERSION_1, PROP_STD_LICENSE_NOTES_VERSION_1, PROP_STD_LICENSE_NOTICE, PROP_STD_LICENSE_OSI_APPROVED, PROP_STD_LICENSE_OSI_APPROVED_VERSION_1, PROP_STD_LICENSE_TEMPLATE, PROP_STD_LICENSE_TEMPLATE_VERSION_1, PROP_STD_LICENSE_URL_VERSION_1, PROP_VALUE_NOASSERTION, PROP_VALUE_NONE, PROP_VERIFICATIONCODE_IGNORED_FILES, PROP_VERIFICATIONCODE_VALUE, RDF_NAMESPACE, RDF_POINTER_NAMESPACE, RDF_PROP_RESOURCE, RDF_PROP_TYPE, RDFS_NAMESPACE, RDFS_PROP_COMMENT, RDFS_PROP_LABEL, RDFS_PROP_SEE_ALSO, SPDX_DATA_LICENSE_ID, SPDX_DATA_LICENSE_ID_VERSION_1_0, SPDX_DATE_FORMAT, SPDX_DOCUMENT_ID, SPDX_ELEMENT_REF_PATTERN, SPDX_ELEMENT_REF_PRENUM, SPDX_LISTED_REFERENCE_TYPES_PREFIX, SPDX_NAMESPACE, SPDX_VERSION_PATTERN, STANDARD_LICENSE_URL, TERM_LICENSE_NOASSERTION, TERM_LICENSE_NONE, URI_VALUE_NOASSERTION, URI_VALUE_NONE

Constructor Summary

Constructors

Constructor and Description
ConvertLicenseListXml()

Method Summary

Modifier and Type	Method and Description
static void	convertLicenseXmlFile(Path inputFile, Path outputFile) Convert a license list XML file from the schema used prior to June 2017 to the standard terms
static void	main(String[] args) Converts a directory of license XML files.

Methods inherited from class java.lang.Object

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

Field Detail

OLD_ROOT_ELEMENT_NAME

public static final String OLD_ROOT_ELEMENT_NAME

See Also:

Constant Field Values

OLD_NAME_ATTRIBUTE

public static final String OLD_NAME_ATTRIBUTE

See Also:

Constant Field Values

OLD_ID_ATTRIBUTE

public static final String OLD_ID_ATTRIBUTE

See Also:

Constant Field Values

OLD_LICENSE_TAG

public static final String OLD_LICENSE_TAG

See Also:

Constant Field Values

OLD_EXCEPTION_TAG

public static final String OLD_EXCEPTION_TAG

See Also:

Constant Field Values

OLD_BODY_TAG

public static final String OLD_BODY_TAG

See Also:

Constant Field Values

OLD_DEPRECATED_ATTRIBUTE

public static final String OLD_DEPRECATED_ATTRIBUTE

See Also:

Constant Field Values

OLD_NOTES_TAG

public static final String OLD_NOTES_TAG

See Also:

Constant Field Values

OLD_URLS_TAG

public static final String OLD_URLS_TAG

See Also:

Constant Field Values

OLD_URL_TAG

public static final String OLD_URL_TAG

See Also:

Constant Field Values

OLD_HEADER_TAG

public static final String OLD_HEADER_TAG

See Also:

Constant Field Values

OLD_OSI_APPROVED_ATTRIBUTE

public static final String OLD_OSI_APPROVED_ATTRIBUTE

See Also:

Constant Field Values

OLD_COPYRIGHT_TAG

public static final String OLD_COPYRIGHT_TAG

See Also:

Constant Field Values

OLD_TITLE_TAG

public static final String OLD_TITLE_TAG

See Also:

Constant Field Values

OLD_LIST_ITEM_TAG

public static final String OLD_LIST_ITEM_TAG

See Also:

Constant Field Values

OLD_LIST_TAG

public static final String OLD_LIST_TAG

See Also:

Constant Field Values

OLD_ALTERNATIVE_TAG

public static final String OLD_ALTERNATIVE_TAG

See Also:

Constant Field Values

OLD_OPTIONAL_TAG

public static final String OLD_OPTIONAL_TAG

See Also:

Constant Field Values

OLD_BREAK_TAG

public static final String OLD_BREAK_TAG

See Also:

Constant Field Values

OLD_PARAGRAPH_TAG

public static final String OLD_PARAGRAPH_TAG

See Also:

Constant Field Values

OLD_VAR_NAME_ATTRIBUTE

public static final String OLD_VAR_NAME_ATTRIBUTE

See Also:

Constant Field Values

OLD_VAR_ORIGINAL_ATTRIBUTE

public static final String OLD_VAR_ORIGINAL_ATTRIBUTE

See Also:

Constant Field Values

OLD_VAR_MATCH_ATTRIBUTE

public static final String OLD_VAR_MATCH_ATTRIBUTE

See Also:

Constant Field Values

OLD_BULLET_TAG

public static final String OLD_BULLET_TAG

See Also:

Constant Field Values

TAG_MAP

public static Map<String,String> TAG_MAP

Map of old tag names to new tag names

Constructor Detail

ConvertLicenseListXml

public ConvertLicenseListXml()

Method Detail

main

public static void main(String[] args)

Converts a directory of license XML files. args[0] is the path to the directory for the input original xml files args[1] is the path to an empty output directory where the new XML files will be written

Parameters:

args -

convertLicenseXmlFile

public static void convertLicenseXmlFile(Path inputFile,
                                         Path outputFile)
                                  throws LicenseXmlConverterException,
                                         LicenseXmlException

Convert a license list XML file from the schema used prior to June 2017 to the standard terms

Parameters:

inputFile - old format file

outputFile - file to be written with the new format

Throws:

LicenseXmlConverterException

LicenseXmlException