org.apache.stanbol.reasoners.owlapi

Class AbstractOWLApiReasoningService

java.lang.Object

org.apache.stanbol.reasoners.owlapi.AbstractOWLApiReasoningService

All Implemented Interfaces:

OWLApiReasoningService, org.apache.stanbol.reasoners.servicesapi.ReasoningService<org.semanticweb.owlapi.model.OWLOntology,org.semanticweb.owlapi.model.SWRLRule,org.semanticweb.owlapi.model.OWLAxiom>

public abstract class AbstractOWLApiReasoningService
extends Object
implements OWLApiReasoningService

This abstract class implements basic methods for a reasoning service based on OWLApi

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.stanbol.reasoners.servicesapi.ReasoningService

org.apache.stanbol.reasoners.servicesapi.ReasoningService.Tasks

Field Summary

Fields inherited from interface org.apache.stanbol.reasoners.servicesapi.ReasoningService

SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
AbstractOWLApiReasoningService()

Method Summary

Methods

Modifier and Type	Method and Description
protected Set<org.semanticweb.owlapi.model.OWLAxiom>	classify(org.semanticweb.owlapi.model.OWLOntology ontology) Classify, returns only axioms about classes and instances This is the default implementation of task ReasoningService.Tasks.CLASSIFY.
protected Set<org.semanticweb.owlapi.model.OWLAxiom>	classify(org.semanticweb.owlapi.model.OWLOntology ontology, List<org.semanticweb.owlapi.model.SWRLRule> rules) Classify, merge SWRL rules in the input ontology, before This is the default implementation of task ReasoningService.Tasks.CLASSIFY when rules are given.
protected org.semanticweb.owlapi.model.OWLOntologyManager	createOWLOntologyManager() An OWLOntologyManager to be used to place a target ontology.
protected Set<org.semanticweb.owlapi.model.OWLAxiom>	enrich(org.semanticweb.owlapi.model.OWLOntology ontology) Enrich, return all inferences.
protected Set<org.semanticweb.owlapi.model.OWLAxiom>	enrich(org.semanticweb.owlapi.model.OWLOntology ontology, boolean filtered) Enrich, return all inferences.
protected Set<org.semanticweb.owlapi.model.OWLAxiom>	enrich(org.semanticweb.owlapi.model.OWLOntology ontology, List<org.semanticweb.owlapi.model.SWRLRule> rules) Enrich, merge SWRL rules and return all inferences.
protected Set<org.semanticweb.owlapi.model.OWLAxiom>	enrich(org.semanticweb.owlapi.model.OWLOntology ontology, List<org.semanticweb.owlapi.model.SWRLRule> rules, boolean filtered) Enrich, merge SWRL rules and return all inferences.
protected List<org.semanticweb.owlapi.util.InferredAxiomGenerator<? extends org.semanticweb.owlapi.model.OWLAxiom>>	getClassifyAxiomGenerators() InferredAxiomGenerators to use for the classify() reasoning method.
protected List<org.semanticweb.owlapi.util.InferredAxiomGenerator<? extends org.semanticweb.owlapi.model.OWLAxiom>>	getEnrichAxiomGenerators() InferredAxiomGenerators to use for the enrich() reasoning method.
Class<org.semanticweb.owlapi.model.OWLOntology>	getModelType() OWLApi based reasoning services have type OWLOntology as input type
protected abstract org.semanticweb.owlapi.reasoner.OWLReasoner	getReasoner(org.semanticweb.owlapi.model.OWLOntology ontology) Method to be implemented by subclasses.
Class<org.semanticweb.owlapi.model.SWRLRule>	getRuleType() OWLApi based reasoning services have type SWRLRule as rule type
Class<org.semanticweb.owlapi.model.OWLAxiom>	getStatementType() OWLApi based reasoning services have type OWLAxiom as statement type
List<String>	getSupportedTasks() The abstract implementation of an OWLApi based reasoning service supports all default ReasoningService.Tasks.
boolean	isConsistent(org.semanticweb.owlapi.model.OWLOntology ontology) Only check consistency.
boolean	isConsistent(org.semanticweb.owlapi.model.OWLOntology ontology, List<org.semanticweb.owlapi.model.SWRLRule> rules) Only check consistency.
Set<org.semanticweb.owlapi.model.OWLAxiom>	run(org.semanticweb.owlapi.model.OWLOntology input, List<org.semanticweb.owlapi.util.InferredAxiomGenerator<? extends org.semanticweb.owlapi.model.OWLAxiom>> generators) Generic method for running the reasoner
Set<org.semanticweb.owlapi.model.OWLAxiom>	run(org.semanticweb.owlapi.model.OWLOntology ontology, List<org.semanticweb.owlapi.model.SWRLRule> rules, List<org.semanticweb.owlapi.util.InferredAxiomGenerator<? extends org.semanticweb.owlapi.model.OWLAxiom>> generators) Merges the SWRL rules in the input ontology, then calls run(OWLOntology,List
Set<org.semanticweb.owlapi.model.OWLAxiom>	runTask(String taskID, org.semanticweb.owlapi.model.OWLOntology data) This method provides the default implementation for executing one of the default tasks with no additional arguments.
Set<org.semanticweb.owlapi.model.OWLAxiom>	runTask(String taskID, org.semanticweb.owlapi.model.OWLOntology data, List<org.semanticweb.owlapi.model.SWRLRule> rules, boolean filtered, Map<String,List<String>> parameters) This method provides the default implementation for executing one of the default tasks.
boolean	supportsTask(String taskID)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.stanbol.reasoners.servicesapi.ReasoningService

getPath

Constructor Detail

AbstractOWLApiReasoningService

public AbstractOWLApiReasoningService()

Method Detail

createOWLOntologyManager

protected org.semanticweb.owlapi.model.OWLOntologyManager createOWLOntologyManager()

An OWLOntologyManager to be used to place a target ontology. We don't want to use the manager bound to the input ontologies for that, we don't want to interfere with it. Other OWLApiReasoningServices may want to change this.

Returns:

getReasoner

protected abstract org.semanticweb.owlapi.reasoner.OWLReasoner getReasoner(org.semanticweb.owlapi.model.OWLOntology ontology)

Method to be implemented by subclasses.

Parameters:

ontology -

Returns:

run

public Set<org.semanticweb.owlapi.model.OWLAxiom> run(org.semanticweb.owlapi.model.OWLOntology input,
                                             List<org.semanticweb.owlapi.util.InferredAxiomGenerator<? extends org.semanticweb.owlapi.model.OWLAxiom>> generators)
                                               throws org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException,
                                                      org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

Generic method for running the reasoner

Specified by:

run in interface OWLApiReasoningService

Parameters:

input -

generators -

Returns:

Throws:

org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

run

public Set<org.semanticweb.owlapi.model.OWLAxiom> run(org.semanticweb.owlapi.model.OWLOntology ontology,
                                             List<org.semanticweb.owlapi.model.SWRLRule> rules,
                                             List<org.semanticweb.owlapi.util.InferredAxiomGenerator<? extends org.semanticweb.owlapi.model.OWLAxiom>> generators)
                                               throws org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException,
                                                      org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

Merges the SWRL rules in the input ontology, then calls run(OWLOntology,List>)

Specified by:

run in interface OWLApiReasoningService

Parameters:

ontology -

rules -

generators -

Returns:

Throws:

org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

runTask

public Set<org.semanticweb.owlapi.model.OWLAxiom> runTask(String taskID,
                                                 org.semanticweb.owlapi.model.OWLOntology data)
                                                   throws org.apache.stanbol.reasoners.servicesapi.UnsupportedTaskException,
                                                          org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException,
                                                          org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

This method provides the default implementation for executing one of the default tasks with no additional arguments. TODO: Add support for the filtered parameter on task 'classify';

Specified by:

runTask in interface org.apache.stanbol.reasoners.servicesapi.ReasoningService<org.semanticweb.owlapi.model.OWLOntology,org.semanticweb.owlapi.model.SWRLRule,org.semanticweb.owlapi.model.OWLAxiom>

Throws:

org.apache.stanbol.reasoners.servicesapi.UnsupportedTaskException

org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

runTask

public Set<org.semanticweb.owlapi.model.OWLAxiom> runTask(String taskID,
                                                 org.semanticweb.owlapi.model.OWLOntology data,
                                                 List<org.semanticweb.owlapi.model.SWRLRule> rules,
                                                 boolean filtered,
                                                 Map<String,List<String>> parameters)
                                                   throws org.apache.stanbol.reasoners.servicesapi.UnsupportedTaskException,
                                                          org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException,
                                                          org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

This method provides the default implementation for executing one of the default tasks. TODO: Add support for the filtered parameter on task 'classify';

Specified by:

runTask in interface org.apache.stanbol.reasoners.servicesapi.ReasoningService<org.semanticweb.owlapi.model.OWLOntology,org.semanticweb.owlapi.model.SWRLRule,org.semanticweb.owlapi.model.OWLAxiom>

Throws:

org.apache.stanbol.reasoners.servicesapi.UnsupportedTaskException

org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

getClassifyAxiomGenerators

protected List<org.semanticweb.owlapi.util.InferredAxiomGenerator<? extends org.semanticweb.owlapi.model.OWLAxiom>> getClassifyAxiomGenerators()

InferredAxiomGenerators to use for the classify() reasoning method. Subclasses may want to change this.

Returns:

getEnrichAxiomGenerators

protected List<org.semanticweb.owlapi.util.InferredAxiomGenerator<? extends org.semanticweb.owlapi.model.OWLAxiom>> getEnrichAxiomGenerators()

InferredAxiomGenerators to use for the enrich() reasoning method. Subclasses may want to change this.

Returns:

classify

protected Set<org.semanticweb.owlapi.model.OWLAxiom> classify(org.semanticweb.owlapi.model.OWLOntology ontology)
                                                       throws org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException,
                                                              org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

Classify, returns only axioms about classes and instances This is the default implementation of task ReasoningService.Tasks.CLASSIFY. Subclasses may want to change it.

Parameters:

ontology -

Returns:

Throws:

org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

classify

protected Set<org.semanticweb.owlapi.model.OWLAxiom> classify(org.semanticweb.owlapi.model.OWLOntology ontology,
                                                  List<org.semanticweb.owlapi.model.SWRLRule> rules)
                                                       throws org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException,
                                                              org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

Classify, merge SWRL rules in the input ontology, before This is the default implementation of task ReasoningService.Tasks.CLASSIFY when rules are given. Subclasses may want to change it.

Parameters:

ontology -

rules -

Returns:

Throws:

org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

enrich

protected Set<org.semanticweb.owlapi.model.OWLAxiom> enrich(org.semanticweb.owlapi.model.OWLOntology ontology)
                                                     throws org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException,
                                                            org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

Enrich, return all inferences. This is the same as enrich(ontology,false); This is the default implementation of task ReasoningService.Tasks.ENRICH. Subclasses may want to change it.

Parameters:

ontology -

Returns:

Throws:

org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

enrich

protected Set<org.semanticweb.owlapi.model.OWLAxiom> enrich(org.semanticweb.owlapi.model.OWLOntology ontology,
                                                boolean filtered)
                                                     throws org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException,
                                                            org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

Enrich, return all inferences. If filtered = false, then merge the inferences with the input This is the default implementation of task ReasoningService.Tasks.ENRICH. Subclasses may want to change it.

Parameters:

ontology -

filtered -

Returns:

Throws:

org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

enrich

protected Set<org.semanticweb.owlapi.model.OWLAxiom> enrich(org.semanticweb.owlapi.model.OWLOntology ontology,
                                                List<org.semanticweb.owlapi.model.SWRLRule> rules)
                                                     throws org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException,
                                                            org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

Enrich, merge SWRL rules and return all inferences. This is the same as enrich(ontology,rules,false) This is the default implementation of task ReasoningService.Tasks.ENRICH. Subclasses may want to change it.

Parameters:

ontology -

rules -

Returns:

Throws:

org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

enrich

protected Set<org.semanticweb.owlapi.model.OWLAxiom> enrich(org.semanticweb.owlapi.model.OWLOntology ontology,
                                                List<org.semanticweb.owlapi.model.SWRLRule> rules,
                                                boolean filtered)
                                                     throws org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException,
                                                            org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

Enrich, merge SWRL rules and return all inferences. If filtered = false, then merge the inferences with the input. This is the default implementation of task ReasoningService.Tasks.ENRICH. Subclasses may want to change it.

Parameters:

ontology -

rules -

filtered -

Returns:

Throws:

org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

org.apache.stanbol.reasoners.servicesapi.InconsistentInputException

isConsistent

public boolean isConsistent(org.semanticweb.owlapi.model.OWLOntology ontology)
                     throws org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

Only check consistency. Subclasses may want to change how.

Specified by:

isConsistent in interface org.apache.stanbol.reasoners.servicesapi.ReasoningService<org.semanticweb.owlapi.model.OWLOntology,org.semanticweb.owlapi.model.SWRLRule,org.semanticweb.owlapi.model.OWLAxiom>

Parameters:

ontology -

Returns:

Throws:

org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

isConsistent

public boolean isConsistent(org.semanticweb.owlapi.model.OWLOntology ontology,
                   List<org.semanticweb.owlapi.model.SWRLRule> rules)
                     throws org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

Only check consistency. Subclasses may want to change how.

Specified by:

isConsistent in interface org.apache.stanbol.reasoners.servicesapi.ReasoningService<org.semanticweb.owlapi.model.OWLOntology,org.semanticweb.owlapi.model.SWRLRule,org.semanticweb.owlapi.model.OWLAxiom>

Parameters:

ontology -

rules -

Returns:

Throws:

org.apache.stanbol.reasoners.servicesapi.ReasoningServiceException

getSupportedTasks

public List<String> getSupportedTasks()

The abstract implementation of an OWLApi based reasoning service supports all default ReasoningService.Tasks. Subclasses may want to extend this.

Specified by:

getSupportedTasks in interface org.apache.stanbol.reasoners.servicesapi.ReasoningService<org.semanticweb.owlapi.model.OWLOntology,org.semanticweb.owlapi.model.SWRLRule,org.semanticweb.owlapi.model.OWLAxiom>

supportsTask

public boolean supportsTask(String taskID)

Specified by:

supportsTask in interface org.apache.stanbol.reasoners.servicesapi.ReasoningService<org.semanticweb.owlapi.model.OWLOntology,org.semanticweb.owlapi.model.SWRLRule,org.semanticweb.owlapi.model.OWLAxiom>

getModelType

public Class<org.semanticweb.owlapi.model.OWLOntology> getModelType()

OWLApi based reasoning services have type OWLOntology as input type

Specified by:

getModelType in interface org.apache.stanbol.reasoners.servicesapi.ReasoningService<org.semanticweb.owlapi.model.OWLOntology,org.semanticweb.owlapi.model.SWRLRule,org.semanticweb.owlapi.model.OWLAxiom>

getRuleType

public Class<org.semanticweb.owlapi.model.SWRLRule> getRuleType()

OWLApi based reasoning services have type SWRLRule as rule type

Specified by:

getRuleType in interface org.apache.stanbol.reasoners.servicesapi.ReasoningService<org.semanticweb.owlapi.model.OWLOntology,org.semanticweb.owlapi.model.SWRLRule,org.semanticweb.owlapi.model.OWLAxiom>

getStatementType

public Class<org.semanticweb.owlapi.model.OWLAxiom> getStatementType()

OWLApi based reasoning services have type OWLAxiom as statement type

Specified by:

getStatementType in interface org.apache.stanbol.reasoners.servicesapi.ReasoningService<org.semanticweb.owlapi.model.OWLOntology,org.semanticweb.owlapi.model.SWRLRule,org.semanticweb.owlapi.model.OWLAxiom>