Package org.semanticweb.owlapi.reasoner

Class SimpleConfiguration

java.lang.Object

org.semanticweb.owlapi.reasoner.SimpleConfiguration

All Implemented Interfaces:

Serializable, OWLReasonerConfiguration

public class SimpleConfiguration
extends Object
implements OWLReasonerConfiguration

A simple configuration with the general options.

Since:

3.0.0

Author:

Matthew Horridge, The University of Manchester, Information Management Group

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SimpleConfiguration()	default constructor
SimpleConfiguration(long timeOut)
SimpleConfiguration(FreshEntityPolicy freshEntityPolicy, long timeOut)
SimpleConfiguration(ReasonerProgressMonitor progressMonitor)
SimpleConfiguration(ReasonerProgressMonitor progressMonitor, long timeOut)
SimpleConfiguration(ReasonerProgressMonitor progressMonitor, FreshEntityPolicy freshEntityPolicy, long timeOut, IndividualNodeSetPolicy individualNodeSetPolicy)

Method Summary

Modifier and Type	Method	Description
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

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

Constructor Detail

SimpleConfiguration

public SimpleConfiguration()

default constructor

SimpleConfiguration

public SimpleConfiguration(@Nonnull
                           ReasonerProgressMonitor progressMonitor)

Parameters:

progressMonitor - the progress monitor to use

SimpleConfiguration

public SimpleConfiguration(@Nonnull
                           ReasonerProgressMonitor progressMonitor,
                           long timeOut)

Parameters:

progressMonitor - the progress monitor to use

timeOut - the timeout in milliseconds

SimpleConfiguration

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

Parameters:

progressMonitor - the progress monitor to use

freshEntityPolicy - the policy for fresh entities

timeOut - the timeout in milliseconds

individualNodeSetPolicy - the policy for individual nodes

SimpleConfiguration

public SimpleConfiguration(@Nonnull
                           FreshEntityPolicy freshEntityPolicy,
                           long timeOut)

Parameters:

freshEntityPolicy - the policy for fresh entities

timeOut - the timeout in milliseconds

SimpleConfiguration

public SimpleConfiguration(long timeOut)

Parameters:

timeOut - the timeout in milliseconds

Method Detail

getProgressMonitor

@Nonnull
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

@Nonnull
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

@Nonnull
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.