Package net.ssehub.easy.reasoning.core.reasoner

Class DelegatingReasonerInstance

java.lang.Object

net.ssehub.easy.reasoning.core.reasoner.DelegatingReasonerInstance

All Implemented Interfaces:

IReasonerInstance

public class DelegatingReasonerInstance
extends java.lang.Object
implements IReasonerInstance

Provides a default implementation for reasoner instances by delegating the respective calls to a given delegate reasoner. Use this class to simplify calls for IReasoner#createInstance( net.ssehub.easy.varModel.model.Project, net.ssehub.easy.varModel.confModel.Configuration, ReasonerConfiguration), i.e., to avoid null pointer returns.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private Configuration	config
private IReasoner	delegate
private boolean	isRunning
private ReasonerConfiguration	rConfig

Constructor Summary

Constructors

Constructor	Description
DelegatingReasonerInstance(Configuration config, ReasonerConfiguration rConfig, IReasoner delegate)	Creates a delegating reasoner instance.

Method Summary

Modifier and Type	Method	Description
ReasoningResult	check(ProgressObserver observer)	Checks the configuration according to the given project structure and does not affect the configuration.
ValueCreationResult	createValue(AbstractVariable var, IDatatype type, ProgressObserver observer)	Creates the value for a certain IVML type/variable.
EvaluationResult	evaluate(java.util.List<Constraint> constraints, ProgressObserver observer)	Evaluates a given list of constraints (in the sense of boolean conditions) which are related to and valid in the context of the given project and configuration.
ReasonerDescriptor	getDescriptor()	Returns a descriptor stating common information about this reasoner.
Project	getProject()	Returns the project this instance is attached to.
ReasonerConfiguration	getReasonerConfiguration()	Returns the reasoner configuration this project is running with.
ReasoningResult	isConsistent(ProgressObserver observer)	Checks whether a given variability model (project) is satisfiable.
boolean	isRunning()	Returns whether the reasoner is (still) operating.
void	notify(IReasonerMessage message)	Is called when a reasoner message is issued.
ReasoningResult	propagate(ProgressObserver observer)	Checks the configuration according to the given model and propagates values, if possible.
boolean	stop()	Stops/terminates reasoning.

Methods inherited from class java.lang.Object

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

Field Detail

delegate

private IReasoner delegate

config

private Configuration config

rConfig

private ReasonerConfiguration rConfig

isRunning

private boolean isRunning

Constructor Detail

DelegatingReasonerInstance

public DelegatingReasonerInstance(Configuration config,
                                  ReasonerConfiguration rConfig,
                                  IReasoner delegate)

Creates a delegating reasoner instance.

Parameters:

config - the configuration to reason bound to this instance

rConfig - the reasoner configuration

delegate - the delegate

Method Detail

getDescriptor

public ReasonerDescriptor getDescriptor()

Description copied from interface: IReasonerInstance

Returns a descriptor stating common information about this reasoner.

Specified by:

getDescriptor in interface IReasonerInstance

Returns:

the descriptor

isConsistent

public ReasoningResult isConsistent(ProgressObserver observer)

Description copied from interface: IReasonerInstance

Checks whether a given variability model (project) is satisfiable.

Specified by:

isConsistent in interface IReasonerInstance

Parameters:

observer - an optional progress observer, shall be ProgressObserver.NO_OBSERVER if unused

Returns:

The result of this reasoning step. Can have the status Status.UNSUPPORTED if the concrete reasoner does not support this operation.

check

public ReasoningResult check(ProgressObserver observer)

Description copied from interface: IReasonerInstance

Checks the configuration according to the given project structure and does not affect the configuration.

Specified by:

check in interface IReasonerInstance

Parameters:

observer - an optional progress observer, shall be ProgressObserver.NO_OBSERVER if unused

Returns:

The result of this reasoning step. Can have the status Status.UNSUPPORTED if the concrete reasoner does not support this operation.

propagate

public ReasoningResult propagate(ProgressObserver observer)

Description copied from interface: IReasonerInstance

Checks the configuration according to the given model and propagates values, if possible.

Specified by:

propagate in interface IReasonerInstance

Parameters:

observer - an optional progress observer, shall be ProgressObserver.NO_OBSERVER if unused

Returns:

The result of this reasoning step. Can have the status Status.UNSUPPORTED if the concrete reasoner does not support this operation.

evaluate

public EvaluationResult evaluate(java.util.List<Constraint> constraints,
                                 ProgressObserver observer)

Description copied from interface: IReasonerInstance

Evaluates a given list of constraints (in the sense of boolean conditions) which are related to and valid in the context of the given project and configuration.

Specified by:

evaluate in interface IReasonerInstance

Parameters:

constraints - the constraints (expressions which evaluate to a boolean value)

observer - an optional progress observer, shall be ProgressObserver.NO_OBSERVER if unused

Returns:

The result of this reasoning step. Can have the status Status.UNSUPPORTED if the concrete reasoner does not support this operation.

createValue

public ValueCreationResult createValue(AbstractVariable var,
                                       IDatatype type,
                                       ProgressObserver observer)

Description copied from interface: IReasonerInstance

Creates the value for a certain IVML type/variable.

Specified by:

createValue in interface IReasonerInstance

Parameters:

var - the variable to create the value for (may be null if type is given, may imply additional constraints)

type - the type to create the value for (may be null if var is given)

observer - an optional progress observer, shall be ProgressObserver.NO_OBSERVER if unused

Returns:

the value creation result

notify

public void notify(IReasonerMessage message)

Description copied from interface: IReasonerInstance

Is called when a reasoner message is issued.

Specified by:

notify in interface IReasonerInstance

Parameters:

message - the message sent

isRunning

public boolean isRunning()

Description copied from interface: IReasonerInstance

Returns whether the reasoner is (still) operating.

Specified by:

isRunning in interface IReasonerInstance

Returns:

true for operating, false else

stop

public boolean stop()

Description copied from interface: IReasonerInstance

Stops/terminates reasoning. If possible, a reasoner shall stop the reasoning operations as quick as possible. A reasoner must not implement this operation.

Specified by:

stop in interface IReasonerInstance

Returns:

true if the reasoner tries to stop, false else (operation not implemented)

See Also:

ReasoningResult.setStopped(boolean)

getProject

public Project getProject()

Description copied from interface: IReasonerInstance

Returns the project this instance is attached to.

Specified by:

getProject in interface IReasonerInstance

Returns:

the project

getReasonerConfiguration

public ReasonerConfiguration getReasonerConfiguration()

Description copied from interface: IReasonerInstance

Returns the reasoner configuration this project is running with.

Specified by:

getReasonerConfiguration in interface IReasonerInstance

Returns:

the reasoner configuration