org.semanticweb.elk.reasoner.query.QueryResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elk-reasoner Show documentation

The core ELK Reasoner package

There is a newer version: 0.29.0

package org.semanticweb.elk.reasoner.query;

/*-
 * #%L
 * ELK Reasoner Core
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2011 - 2020 Department of Computer Science, University of Oxford
 * %%
 * 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.
 * #L%
 */

import org.semanticweb.elk.Lock;
import org.semanticweb.elk.owl.interfaces.ElkAxiom;
import org.semanticweb.elk.reasoner.completeness.IncompletenessMonitor;

/**
 * Represents the result of an entailment test for {@link ElkAxiom} (the query).
 * 
 * @author Peter Skocovsky
 * @author Yevgeny Kazakov
 * 
 *         TODO: manage locks using weak references
 */
public interface QueryResult extends Lock {

	/**
	 * @return The query that is tested for the entailment.
	 */
	ElkAxiom getQuery();

	/**
	 * @return {@code true} if the reasoner has determined that the query is
	 *         entailed by the ontology and {@code false} otherwise. If
	 *         {@code false} is returned this does not necessarily mean that the
	 *         query is not entailed since the reasoning results may be
	 *         incomplete. The latter can be checked using
	 *         {@link #getIncompletenessMonitor()}.
	 * @throws ElkQueryException
	 *             if this {@link QueryResult} has not been computed yet
	 */
	boolean entailmentProved() throws ElkQueryException;

	/**
	 * @return the {@link IncompletenessMonitor} using which one can verify
	 *         completeness of the query result. If the query result is
	 *         incomplete then the query may still be entailed even though
	 *         {@link #entailmentProved()} returns {@code false}
	 */
	IncompletenessMonitor getIncompletenessMonitor();

}