org.spdx.jacksonstore.PropertyComparator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spdx-jackson-store Show documentation

Storage for SPDX documents utilizing Jackson Databind. This store supports serializing and deserializing files in JSON, YAML and XML formats.

There is a newer version: 2.0.0-RC1

Show newest version

/**
 * Copyright (c) 2020 Source Auditor Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 * 
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
package org.spdx.jacksonstore;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;

import org.spdx.library.SpdxConstants;

/**
 * Comparator for property names for different SPDX class types
 * 
 * To change the order of properties, change the order in the arrays for the specific type
 * If a property or type isn't in the propertyOrderMap, the alphaNumeric comparison of property names will be used
 * 
 * @author Gary O'Neall
 *
 */
public class PropertyComparator implements Comparator {
	
	static final List DOCUMENT_PROPERTY_ORDER = Arrays.asList(new String[] {
			SpdxConstants.PROP_DOCUMENT_NAMESPACE,
			SpdxConstants.PROP_SPDX_SPEC_VERSION,
			SpdxConstants.PROP_SPDX_CREATION_INFO,
			SpdxConstants.PROP_NAME,
			SpdxConstants.PROP_SPDX_DATA_LICENSE,
			SpdxConstants.RDFS_PROP_COMMENT,
			SpdxConstants.PROP_SPDX_EXTERNAL_DOC_REF,
			SpdxConstants.PROP_DOCUMENT_DESCRIBES,
			SpdxConstants.PROP_DOCUMENT_PACKAGES,
			SpdxConstants.PROP_DOCUMENT_FILES,
			SpdxConstants.PROP_DOCUMENT_SNIPPETS,
			SpdxConstants.PROP_SPDX_EXTRACTED_LICENSES,
			SpdxConstants.PROP_ANNOTATION,
			SpdxConstants.PROP_DOCUMENT_RELATIONSHIPS
	});
	static final Map> propertyOrderMap;
	static {
		HashMap> hm = new HashMap<>();
		hm.put(SpdxConstants.CLASS_SPDX_DOCUMENT, DOCUMENT_PROPERTY_ORDER);
		propertyOrderMap = Collections.unmodifiableMap(hm);
	}
	private List propertyOrder;

	public PropertyComparator(String type) {
		propertyOrder = propertyOrderMap.get(type);
		if (Objects.isNull(propertyOrder)) {
			propertyOrder = new ArrayList<>();
		}
	}

	@Override
	public int compare(String o1, String o2) {
		int i1 = propertyOrder.indexOf(o1);
		if (i1 < 0) {
			i1 = 999;
		}
		int i2 = propertyOrder.indexOf(o2);
		if (i2 < 0) {
			i2 = 999;
		}
		int retval = Integer.compare(i1, i2);
		if (retval == 0) {
			retval = o1.compareTo(o2);
		}
		return retval;
	}

}