DOAPProject.java

/**
 * 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;

import com.hp.hpl.jena.graph.Node;
import com.hp.hpl.jena.graph.Triple;
import com.hp.hpl.jena.rdf.model.Model;
import com.hp.hpl.jena.rdf.model.Property;
import com.hp.hpl.jena.rdf.model.Resource;
import com.hp.hpl.jena.util.iterator.ExtendedIterator;

/**
 * Contains a DOAP project
 * Currently, only the home page and name properties are supported
 * @author Gary O'Neall
 *
 */
public class DOAPProject {
	private String name = null;
	private String homePage = null;
	private Node projectNode = null;
	private Resource projectResource = null;
	private Model model = null;
	
	/**
	 * This method will create a DOAP Project object from a DOAP document
	 * which already exists.  The DOAP project is read from the uri and
	 * the model is created from the existing data.
	 * @param model Jena model to populate
	 * @param projectUrl The URL of the DOAP project
	 * @return
	 * @throws InvalidSPDXAnalysisException 
	 */
	static DOAPProject getExistingProject(Model model, String projectUrl) throws InvalidSPDXAnalysisException {
		Resource projectResource = model.createResource(projectUrl);
		model.read(projectUrl);
		return new DOAPProject(model, projectResource.asNode());
	}
	
	public DOAPProject(Model model, Node node) throws InvalidSPDXAnalysisException {
		this.model = model;
		this.projectNode = node;
		if (projectNode.isBlank()) {
			this.projectResource = model.createResource(node.getBlankNodeId());
		} else if (projectNode.isURI()) {
			this.projectResource = model.createResource(node.getURI());
		} else {
			throw(new InvalidSPDXAnalysisException("Can not create a DOAP project from a literal node"));
		}
		
		// name
		Node p = model.getProperty(SPDXAnalysis.DOAP_NAMESPACE, SPDXAnalysis.PROP_PROJECT_NAME).asNode();
		Triple m = Triple.createMatch(projectNode, p, null);
		ExtendedIterator<Triple> tripleIter = model.getGraph().find(m);	
		while (tripleIter.hasNext()) {
			Triple t = tripleIter.next();
			this.name = t.getObject().toString(false);
		}
		// home page
		p = model.getProperty(SPDXAnalysis.DOAP_NAMESPACE, SPDXAnalysis.PROP_PROJECT_HOMEPAGE).asNode();
		m = Triple.createMatch(projectNode, p, null);
		tripleIter = model.getGraph().find(m);	
		while (tripleIter.hasNext()) {
			Triple t = tripleIter.next();
			this.homePage = t.getObject().toString(false);
		}
	}

	/**
	 * @param projectName
	 * @param homePage
	 */
	public DOAPProject(String projectName, String homePage) {
		this.name = projectName;
		this.homePage = homePage;
	}

	/**
	 * @return the name
	 */
	public String getName() {
		return name;
	}

	/**
	 * @param name the name to set
	 */
	public void setName(String name) {
		this.name = name;
		if (this.projectNode != null && this.model != null) {
			Property p = model.createProperty(SPDXAnalysis.DOAP_NAMESPACE, SPDXAnalysis.PROP_PROJECT_NAME);
			model.removeAll(projectResource, p, null);
			p = model.createProperty(SPDXAnalysis.DOAP_NAMESPACE, SPDXAnalysis.PROP_PROJECT_NAME);
			projectResource.addProperty(p, name);
		}
	}

	/**
	 * @return the homePage
	 */
	public String getHomePage() {
		return homePage;
	}

	/**
	 * @param homePage the homePage to set
	 */
	public void setHomePage(String homePage) {
		this.homePage = homePage;
		if (this.projectNode != null && this.model != null) {
			Property p = model.createProperty(SPDXAnalysis.DOAP_NAMESPACE, SPDXAnalysis.PROP_PROJECT_HOMEPAGE);
			model.removeAll(projectResource, p, null);
			if (homePage != null) {
				p = model.createProperty(SPDXAnalysis.DOAP_NAMESPACE, SPDXAnalysis.PROP_PROJECT_HOMEPAGE);
				Resource homePageResource = model.createResource(homePage);
				projectResource.addProperty(p, homePageResource);
			}
		}
	}
	
	public String getProjectUri() {
		if (projectNode == null || !projectNode.isURI()) {
			return null;
		} else {
			return projectNode.getURI();
		}
	}
	
	public Resource createResource(Model model) {
		Resource type = model.createResource(SPDXAnalysis.DOAP_NAMESPACE + SPDXAnalysis.CLASS_DOAP_PROJECT);
		Resource retval = model.createResource(type);
		populateModel(model, retval);
		return retval;
	}

	/**
	 * @param model Jena model to populate
	 * @param projectResource Project resource to populate
	 */
	private void populateModel(Model model, Resource projectResource) {
		this.model = model;
		this.projectNode = projectResource.asNode();
		this.projectResource = projectResource;
		
		// Name		
		if (name != null) {
			Property p = model.createProperty(SPDXAnalysis.DOAP_NAMESPACE, SPDXAnalysis.PROP_PROJECT_NAME);
			projectResource.addProperty(p, name);
		}

		// HomePage
		if (homePage != null) {
			Property p = model.createProperty(SPDXAnalysis.DOAP_NAMESPACE, SPDXAnalysis.PROP_PROJECT_HOMEPAGE);
			projectResource.addProperty(p, homePage);
		}		
	}
}