org.spdx.rdfparser.license.AnyLicenseInfo Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spdx-tools Show documentation
SPDX tools
There is a newer version: 2.2.8
/**
 * Copyright (c) 2011 Source Auditor Inc.
 *
 *   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.rdfparser.license;

import java.util.List;

import org.spdx.rdfparser.IModelContainer;
import org.spdx.rdfparser.InvalidSPDXAnalysisException;
import org.spdx.rdfparser.RdfParserHelper;
import org.spdx.rdfparser.model.IRdfModel;

import com.hp.hpl.jena.graph.Node;
import com.hp.hpl.jena.rdf.model.Model;
import com.hp.hpl.jena.rdf.model.Resource;

/**
 * This abstract class represents several ways of describing licensing information.
 * License info can be described as a set of conjunctive licenses (where all licenses
 * terms must apply), a set of disjunctive licenses (where there is a choice of one
 * license among the set described) or a specific license.  The specific licenses
 * are of a SimpleLicensingInfoType
 * @author Gary O'Neall
 *
 */
public abstract class AnyLicenseInfo implements Cloneable, IRdfModel {

	Model model = null;
	Node licenseInfoNode = null;
	Resource resource = null;
	IModelContainer modelContainer = null;
	
	/**
	 * Create a new LicenseInfo object where the information is copied from
	 * the model at the LicenseInfo node
	 * @param modelContainer container which includes the license
	 * @param licenseInfoNode
	 * @throws InvalidSPDXAnalysisException 
	 */
	AnyLicenseInfo(IModelContainer modelContainer, Node licenseInfoNode) throws InvalidSPDXAnalysisException {
		this.modelContainer = modelContainer;
		this.model = modelContainer.getModel();
		this.licenseInfoNode = licenseInfoNode;
		resource = RdfParserHelper.convertToResource(model, licenseInfoNode);
	}


	AnyLicenseInfo() {
		this.model = null;
		this.licenseInfoNode = null;
		this.resource = null;
	}
	
	/**
	 * If a resource does not already exist in this model for this object,
	 * create a new resource and populate it.  If the resource does exist,
	 * return the existing resource.
	 * @param modelContainer container which includes the license
	 * @param enclosingSpdxDoc The SPDX Document where this license will be contained
	 * @return resource created from the model
	 * @throws InvalidSPDXAnalysisException 
	 */
	@Override
    public Resource createResource(IModelContainer modelContainer) throws InvalidSPDXAnalysisException {
		if (this.model != null &&
				(this.modelContainer.equals(modelContainer)) 
//						|| (this.licenseInfoNode.isURI()))	// Remove this line to cause the spdx listed license 
				&&											// references to reference the URL rather than copy all of the properties into this model
				this.licenseInfoNode != null &&
				this.resource != null) {
			return resource;
		} else {
			this.modelContainer = modelContainer;
			this.model = modelContainer.getModel();
			Resource retval = _createResource();
			this.licenseInfoNode = retval.asNode();
			this.resource = retval;
			return retval;
		}
	}
	
	/**
	 * Internal implementation of create resource which is subclass specific
	 * @return
	 * @throws InvalidSPDXAnalysisException 
	 */
	protected abstract Resource _createResource() throws InvalidSPDXAnalysisException;
	
	// force subclasses to implement toString
	@Override
    public abstract String toString();
	
	// force subclasses to implement equals
	@Override
    public abstract boolean equals(Object o);
	
	// force subclasses to implement hashcode
	@Override
    public abstract int hashCode();

	/**
	 * @return
	 */
	@Override
    public abstract List verify();

	/**
	 * @return
	 */
	public Resource getResource() {
		return this.resource;
	}
	
	@Override
    public abstract AnyLicenseInfo clone();
}