de.derivo.sparqldlapi.QueryEngine Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of de-derivo-sparqldlapi Show documentation

This library was originally developed by Mario Volke and Derivo Systems.

The newest version!

// Copyright (c) 2011. This source code is available under the terms of the GNU Lesser General Public License (LGPL)
// Author: Mario Volke 
// derivo GmbH, James-Franck-Ring, 89081 Ulm 

package de.derivo.sparqldlapi;

import org.semanticweb.owlapi.model.OWLOntologyManager;
import org.semanticweb.owlapi.reasoner.OWLReasoner;

import de.derivo.sparqldlapi.exceptions.QueryEngineException;
import de.derivo.sparqldlapi.impl.QueryEngineImpl;

/**
 * The query engine that executes a query and generates the appropriate result set.
 * 
 * @author Mario Volke
 */
public abstract class QueryEngine 
{	
	/**
	 * Factory method to create a QueryEngine instance.
	 * 
	 * @param manager An OWLOntologyManager instance of OWLAPI v3
	 * @param reasoner An OWLReasoner instance.
	 * @return an instance of QueryEngine
	 */
	public static QueryEngine create(OWLOntologyManager manager, OWLReasoner reasoner)
	{
		return new QueryEngineImpl(manager, reasoner);
	}
	
	/**
	 * Factory method to create a QueryEngine instance.
	 * 
	 * @param manager An OWLOntologyManager instance of OWLAPI v3
	 * @param reasoner An OWLReasoner instance.
	 * @param strictMode If strict mode is enabled the query engine will throw a QueryEngineException if data types withing the query are not correct (e.g. Class(URI_OF_AN_INDIVIDUAL))
	 * @return an instance of QueryEngine
	 */
	public static QueryEngine create(OWLOntologyManager manager, OWLReasoner reasoner, boolean strict)
	{
		return new QueryEngineImpl(manager, reasoner, strict);
	}
	
	/**
	 * Execute a sparql-dl query and generate the result set.
	 * 
	 * @param query
	 * @return The query result set.
	 */
	public abstract QueryResult execute(Query query)
		throws QueryEngineException;
}