org.semanticweb.owlapi.reasoner
Class SimpleConfiguration

java.lang.Object
  extended by org.semanticweb.owlapi.reasoner.SimpleConfiguration
All Implemented Interfaces:
OWLReasonerConfiguration

public class SimpleConfiguration
extends java.lang.Object
implements OWLReasonerConfiguration

Author: Matthew Horridge
The University of Manchester
Information Management Group
Date: 18-Mar-2009

A simple configuration with the general options.


Constructor Summary
SimpleConfiguration()
           
SimpleConfiguration(FreshEntityPolicy freshEntityPolicy, long timeOut)
           
SimpleConfiguration(long timeOut)
           
SimpleConfiguration(ReasonerProgressMonitor progressMonitor)
           
SimpleConfiguration(ReasonerProgressMonitor progressMonitor, FreshEntityPolicy freshEntityPolicy, long timeOut, IndividualNodeSetPolicy individualNodeSetPolicy)
           
SimpleConfiguration(ReasonerProgressMonitor progressMonitor, long timeOut)
           
 
Method Summary
 FreshEntityPolicy getFreshEntityPolicy()
          Gets the fresh entity policy that should be used.
 IndividualNodeSetPolicy getIndividualNodeSetPolicy()
          Gets the IndividualNodeSetPolicy which determines how NodeSets of named individuals are returned from the reasoner.
 ReasonerProgressMonitor getProgressMonitor()
          Gets a progress monitor that the reasoner may update with information about the progress of its reasoning process.
 long getTimeOut()
          Gets the timeout in milliseconds for basic single reasoner operations (satisfiability check time out).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SimpleConfiguration

public SimpleConfiguration()

SimpleConfiguration

public SimpleConfiguration(ReasonerProgressMonitor progressMonitor)

SimpleConfiguration

public SimpleConfiguration(ReasonerProgressMonitor progressMonitor,
                           long timeOut)

SimpleConfiguration

public SimpleConfiguration(ReasonerProgressMonitor progressMonitor,
                           FreshEntityPolicy freshEntityPolicy,
                           long timeOut,
                           IndividualNodeSetPolicy individualNodeSetPolicy)

SimpleConfiguration

public SimpleConfiguration(FreshEntityPolicy freshEntityPolicy,
                           long timeOut)

SimpleConfiguration

public SimpleConfiguration(long timeOut)
Method Detail

getProgressMonitor

public ReasonerProgressMonitor getProgressMonitor()
Description copied from interface: OWLReasonerConfiguration
Gets a progress monitor that the reasoner may update with information about the progress of its reasoning process.

Specified by:
getProgressMonitor in interface OWLReasonerConfiguration
Returns:
A progress monitor. By default this returns NullReasonerProgressMonitor

getTimeOut

public long getTimeOut()
Description copied from interface: OWLReasonerConfiguration
Gets the timeout in milliseconds for basic single reasoner operations (satisfiability check time out). If the value is equal to Long.MAX_VALUE then this means that the reasoner should never time out.

The reasoner will monitor the elapsed time during a satisfiability check (attempt to build a model for example) and if the elapsed time exceeds the timeout then it will abort the test as soon as possible and terminate all reasoning. A TimeOutException will be thrown in the thread that invoked the last reasoner operation.

Note that this is not a timeout for method calls such as "getSubClasses", which may involve many satisfiability (or other basic reasoning task) checks, the sum of which may well exceed the timeout.

Specified by:
getTimeOut in interface OWLReasonerConfiguration
Returns:
The time out in milliseconds. By default this is set to the value of Long.MAX_VALUE, which means the reasoner SHOULD NOT timeout.

getFreshEntityPolicy

public FreshEntityPolicy getFreshEntityPolicy()
Description copied from interface: OWLReasonerConfiguration
Gets the fresh entity policy that should be used. By default this is set to FreshEntityPolicy.ALLOW.

Specified by:
getFreshEntityPolicy in interface OWLReasonerConfiguration
Returns:
The fresh entity policy.

getIndividualNodeSetPolicy

public IndividualNodeSetPolicy getIndividualNodeSetPolicy()
Description copied from interface: OWLReasonerConfiguration
Gets the IndividualNodeSetPolicy which determines how NodeSets of named individuals are returned from the reasoner.

Specified by:
getIndividualNodeSetPolicy in interface OWLReasonerConfiguration
Returns:
The IndividualNodeSetPolicy that should be used. By default the policy is IndividualNodeSetPolicy.BY_NAME i.e. by default individuals that are the same as each other are not grouped into the same node within a node set.