Interface IAlgorithmParameters

All Known Implementing Classes:

AlgorithmParameters

public interface IAlgorithmParameters

Contains parameters for an InteGraal algorithm or service.

Method Summary

Modifier and Type	Method	Description
boolean	asksCountOnly()	Indicates whether only the count of answers is requested.
boolean	asksLists()	Indicates whether list output is requested.
boolean	asksSet()	Indicates whether set output is requested.
static IAlgorithmParameters	Chase(InteGraalKeywords.Algorithms.Parameters.Chase.Checker chaseType, ExternalAlgorithmHaltingConditions hc)	Creates an IAlgorithmParameters instance for a Chase-based reasoning algorithm with the specified parameters.
static IAlgorithmParameters	Chase(InteGraalKeywords.Algorithms.Parameters.Chase.Checker chaseType, IGParameter<InteGraalKeywords, ?> params)	Creates an IAlgorithmParameters instance for a Chase-based reasoning algorithm with the specified parameters.
static IAlgorithmParameters	Chase(IGParameter<InteGraalKeywords, ?>... params)	Creates an IAlgorithmParameters instance for a Chase-based reasoning algorithm with the specified parameters.
default IAlgorithmParameters	Chase(String chaseType, ExternalAlgorithmHaltingConditions hc)	Creates an IAlgorithmParameters instance for a Chase-based reasoning algorithm with the specified parameters.
static IAlgorithmParameters	Compilation(InteGraalKeywords.Algorithms.Parameters.Compilation ruleCompilation, ExternalAlgorithmHaltingConditions hc)	Creates an IAlgorithmParameters instance for rule compilation with the specified parameters.
static IAlgorithmParameters	Compilation(IGParameter<InteGraalKeywords, ?>... params)	Creates an IAlgorithmParameters instance for rule compilation with the specified parameters.
static IAlgorithmParameters	Explanation(ExternalAlgorithmHaltingConditions hc)	Creates an IAlgorithmParameters instance for query explanation with the specified parameters.
static IAlgorithmParameters	Explanation(IGParameter<InteGraalKeywords, ?>... params)	Creates an IAlgorithmParameters instance for query explanation with the specified parameters.
InteGraalKeywords.Algorithms	getAlgorithm()	Returns the algorithm identified by this configuration.
Optional<InteGraalKeywords.Algorithms.Parameters.Compilation>	getCompilation()	Returns the configured compilation strategy.
Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Computer>	getComputer()	Gets the chase computer used in the algorithm.
Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Checker>	getCriterion()	Gets the chase criterion used in the algorithm.
Optional<InteGraalKeywords.InternalStorageConfiguration.DriverType>	getDBDriver()	Returns the configured database driver type.
Optional<Map<InteGraalKeywords.InternalStorageConfiguration.DBMSDriverParameters, String>>	getDBMSDriverParameters()	Returns the configured DBMS driver parameters.
Optional<InteGraalKeywords.InternalStorageConfiguration.StorageLayout>	getDBStrategy()	Returns the configured storage layout strategy.
Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Evaluator>	getEvaluator()	Gets the evaluator used in the chase algorithm.
Optional<InteGraalKeywords.Algorithms.Parameters.Explanation.ExplainerSolver>	getExplainerSolver()	Returns the configured explainer solver.
Optional<InteGraalKeywords.Algorithms.Parameters.Explanation.ExplainerVerbosity>	getExplainerVerbosity()	Returns the configured explainer verbosity.
Optional<InteGraalKeywords.Algorithms.Parameters.Explanation>	getExplanation()	Returns the selected explanation category.
Optional<InteGraalKeywords.Algorithms.Parameters.Explanation.ExplanationSupportType>	getExplanationSupportType()	Returns the configured explanation support type.
ExternalAlgorithmHaltingConditions	getExternalHaltingConditions()	Returns the external halting conditions currently configured.
Optional<Integer>	getGMUSSolverTreshold()	Returns the configured GMUS solver threshold.
Optional<InteGraalKeywords.Algorithms.Parameters.Explanation.GraphOfRuleInstancesComputation>	getGraphOfRuleInstancesComputation()	Returns the configured graph-of-rule-instances computation strategy.
Optional<InteGraalKeywords.Algorithms.Parameters.Explanation.GraphOfRuleInstancesType>	getGraphOfRuleInstancesType()	Returns the configured graph-of-rule-instances representation.
InteGraalKeywords.Algorithms.Images	getImageType()	Returns the configured image type.
Optional<String>	getMARCOPathToExecutable()	Returns the configured path to the MARCO executable.
Optional<Integer>	getMax()	Returns the maximum number of produced answers.
String	getName()	Returns the display name of this algorithm configuration.
Optional<Integer>	getRank()	Returns the maximum reasoning rank.
InteGraalKeywords.Algorithms.Answers	getResultType()	Returns the configured answer container type.
Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Applier>	getRuleApplier()	Gets the rule applier used in the chase algorithm.
Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Scheduler>	getScheduler()	Gets the chase scheduler used in the algorithm.
Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Namer>	getSkolemization()	Gets the skolemization strategy used in the chase algorithm.
Optional<InteGraalKeywords.InternalStorageConfiguration.DBType>	getStorageType()	Returns the configured storage type.
Optional<Duration>	getTimeout()	Returns the configured timeout.
Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Transformer>	getTransformer()	Gets the transformer used in the chase algorithm.
static IAlgorithmParameters	OMQAChase(InteGraalKeywords.Algorithms.Parameters.Chase.Checker chaseType, ExternalAlgorithmHaltingConditions hc)	Creates an IAlgorithmParameters instance for OMQA Chase-based reasoning with the specified parameters.
static IAlgorithmParameters	OMQAChase(IGParameter<InteGraalKeywords, ?>... params)	Creates an IAlgorithmParameters instance for OMQA Chase-based reasoning with the specified parameters.
static IAlgorithmParameters	OMQAChase(String chaseType, ExternalAlgorithmHaltingConditions hc)	Creates an IAlgorithmParameters instance for OMQA Chase-based reasoning with the specified parameters.
static IAlgorithmParameters	OMQAHybrid(IGParameter<InteGraalKeywords, ?>... params)	Creates an IAlgorithmParameters instance for hybrid reasoning with the specified parameters.
static IAlgorithmParameters	OMQAHybrid(String chaseType, String compilationType, ExternalAlgorithmHaltingConditions hc)	Creates an IAlgorithmParameters instance for hybrid reasoning with the specified parameters.
static IAlgorithmParameters	OMQARewriting(InteGraalKeywords.Algorithms.Parameters.Compilation compilation, ExternalAlgorithmHaltingConditions hc)	Creates an IAlgorithmParameters instance for OMQA rewriting with the specified parameters.
static IAlgorithmParameters	OMQARewriting(IGParameter<InteGraalKeywords, ?>... params)	Creates an IAlgorithmParameters instance for OMQA rewriting with the specified parameters.
static IAlgorithmParameters	OMQARewriting(String ruleCompilation, ExternalAlgorithmHaltingConditions hc)	Creates an IAlgorithmParameters instance for OMQA rewriting with the specified parameters.
static IAlgorithmParameters	QA(ExternalAlgorithmHaltingConditions hc)	Creates an IAlgorithmParameters instance for query answering with a specified timeout.
static IAlgorithmParameters	QA(IGParameter<InteGraalKeywords, ?>... params)	Creates an IAlgorithmParameters instance for query answering with a specified timeout.
static IAlgorithmParameters	Rewriting(InteGraalKeywords.Algorithms.Parameters.Compilation ruleCompilation, ExternalAlgorithmHaltingConditions hc)	Creates an IAlgorithmParameters instance for rewriting-based reasoning with the specified parameters.
static IAlgorithmParameters	Rewriting(IGParameter<InteGraalKeywords, ?>... params)	Creates an IAlgorithmParameters instance for rewriting-based reasoning with the specified parameters.
IAlgorithmParameters	setCompilation(InteGraalKeywords.Algorithms.Parameters.Compilation compilationName)	Sets the compilation strategy.
IAlgorithmParameters	setComputer(InteGraalKeywords.Algorithms.Parameters.Chase.Computer computerName)	Sets the chase computer to be used in the algorithm.
IAlgorithmParameters	setCriterion(InteGraalKeywords.Algorithms.Parameters.Chase.Checker criterionName)	Sets the chase criterion to be used in the algorithm.
IAlgorithmParameters	setDBDriver(InteGraalKeywords.InternalStorageConfiguration.DriverType dbDriverName)	Sets the database driver type.
IAlgorithmParameters	setDBMSDriverParameters(InteGraalKeywords.InternalStorageConfiguration.DBMSDriverParameters paramName, String value)	Sets a single DBMS driver parameter.
IAlgorithmParameters	setDBStrategy(InteGraalKeywords.InternalStorageConfiguration.StorageLayout strategyName)	Sets the storage layout strategy.
IAlgorithmParameters	setEvaluator(InteGraalKeywords.Algorithms.Parameters.Chase.Evaluator evaluatorName)	Sets the evaluator to be used in the chase algorithm.
IAlgorithmParameters	setExplainerSolver(InteGraalKeywords.Algorithms.Parameters.Explanation.ExplainerSolver solver)	Sets the explainer solver.
IAlgorithmParameters	setExplainerVerbosity(InteGraalKeywords.Algorithms.Parameters.Explanation.ExplainerVerbosity verbosity)	Sets the explainer verbosity.
IAlgorithmParameters	setExplanationCategory(InteGraalKeywords.Algorithms.Parameters.Explanation explanationCategory)	Sets the explanation category.
IAlgorithmParameters	setExplanationSupportType(InteGraalKeywords.Algorithms.Parameters.Explanation.ExplanationSupportType explanationSupportType)	Sets the explanation support type.
IAlgorithmParameters	setExternalHaltingConditions(ExternalAlgorithmHaltingConditions hc)	Sets the external halting conditions.
IAlgorithmParameters	setGMUSSolverTreshold(int treshold)	Sets the GMUS solver threshold.
IAlgorithmParameters	setGraphOfRuleInstancesType(InteGraalKeywords.Algorithms.Parameters.Explanation.GraphOfRuleInstancesComputation griComputation)	Sets the graph-of-rule-instances computation strategy.
IAlgorithmParameters	setGraphOfRuleInstancesType(InteGraalKeywords.Algorithms.Parameters.Explanation.GraphOfRuleInstancesType griType)	Sets the graph-of-rule-instances representation.
IAlgorithmParameters	setGSATSolverParameters(InteGraalKeywords.Algorithms.Parameters.Explanation.GSATSolverParameters paramName, String value)	Sets a named GMUS solver parameter.
void	setImageType(InteGraalKeywords.Algorithms.Images type)	sets the type of images
IAlgorithmParameters	setMARCOPathToExecutable(String pathToExecutable)	Sets the path to the MARCO executable.
IAlgorithmParameters	setMax(Integer rank)	Sets the maximum number of produced answers.
IAlgorithmParameters	setOpenParameter(InteGraalKeywords k, Object value)	Sets the value of an open parameter which is not defined within a parent enumeration
IAlgorithmParameters	setOpenParameterFromEnumeration(Class<? extends Enum<?>> className, String propertyName, String value)	Sets the value of a parameter based on the provided class, property name, and value.
IAlgorithmParameters	setOpenParameterFromEnumeration(Enum<?> className, String propertyName, String value)	Sets the value of a parameter based on the provided enumeration, property name, and value.
IAlgorithmParameters	setParameter(Enum<?> enumValue)	Sets the value of a parameter based on the provided enum constant.
IAlgorithmParameters	setRank(Integer rank)	Sets the maximum reasoning rank.
void	setResultType(InteGraalKeywords.Algorithms.Answers type)	sets the type of result
IAlgorithmParameters	setRuleApplier(InteGraalKeywords.Algorithms.Parameters.Chase.Applier applierName)	Sets the rule applier to be used in the chase algorithm.
IAlgorithmParameters	setScheduler(InteGraalKeywords.Algorithms.Parameters.Chase.Scheduler schedulerName)	Sets the chase scheduler to be used in the algorithm.
IAlgorithmParameters	setSkolemization(InteGraalKeywords.Algorithms.Parameters.Chase.Namer skolemizationName)	Sets the skolemization strategy to be used in the chase algorithm.
IAlgorithmParameters	setStorageType(InteGraalKeywords.InternalStorageConfiguration.DBType storageName)	Sets the storage type.
IAlgorithmParameters	setTimeout(Duration timeout)	Sets the global timeout.
IAlgorithmParameters	setTransformer(InteGraalKeywords.Algorithms.Parameters.Chase.Transformer transformerName)	Sets the transformer to be used in the chase algorithm.
boolean	usesOMQAHybridAlgorithm()	Returns whether the OMQA hybrid algorithm should be used.
boolean	usesOMQARewritingAlgorithm()	Indicates whether OMQA via rewriting is configured.
boolean	usesOMQASaturationAlgorithm()	Indicates whether the algorithm uses a saturation algorithm for OMQA.
boolean	usesQueryAnsweringAlgorithm()	Indicates whether query answering is configured.
boolean	usesQueryRewritingAlgorithm()	Indicates whether query rewriting is configured.
boolean	usesRuleCompilationAlgorithm()	Indicates whether rule compilation is configured.
boolean	usesSaturationAlgorithm()	Indicates whether the algorithm uses a saturation algorithm.
boolean	usesStorage()	Indicates whether the algorithm requires external storage settings.

Method Details

getName

String getName()

Returns the display name of this algorithm configuration.

Returns:

a description of the algorithm configuration.

getAlgorithm

InteGraalKeywords.Algorithms getAlgorithm()

Returns the algorithm identified by this configuration.

Returns:

the algorithm type.

QA

static IAlgorithmParameters QA(IGParameter<InteGraalKeywords, ?>... params)

Creates an IAlgorithmParameters instance for query answering with a specified timeout.

Parameters:

params - the conditions to force algorithm termination or storage type

Returns:

A new IAlgorithmParameters instance configured for query answering.

Chase

static IAlgorithmParameters Chase(IGParameter<InteGraalKeywords, ?>... params)

Creates an IAlgorithmParameters instance for a Chase-based reasoning algorithm with the specified parameters.

Parameters:

params - for the chase, storage and forcing termination

Returns:

A new IAlgorithmParameters instance configured for Chase reasoning.

OMQAChase

static IAlgorithmParameters OMQAChase(IGParameter<InteGraalKeywords, ?>... params)

Creates an IAlgorithmParameters instance for OMQA Chase-based reasoning with the specified parameters.

Parameters:

params - for the chase, storage, query answering, and forcing termination

Returns:

A new IAlgorithmParameters instance configured for OMQA Chase reasoning.

Rewriting

static IAlgorithmParameters Rewriting(IGParameter<InteGraalKeywords, ?>... params)

Creates an IAlgorithmParameters instance for rewriting-based reasoning with the specified parameters.

Parameters:

params - for the rewriting and forcing termination

Returns:

A new IAlgorithmParameters instance configured for rewriting.

OMQARewriting

static IAlgorithmParameters OMQARewriting(IGParameter<InteGraalKeywords, ?>... params)

Creates an IAlgorithmParameters instance for OMQA rewriting with the specified parameters.

Parameters:

params - for the rewriting, storage, query answering, and forcing termination

Returns:

A new IAlgorithmParameters instance configured for OMQA rewriting.

OMQAHybrid

static IAlgorithmParameters OMQAHybrid(IGParameter<InteGraalKeywords, ?>... params)

Creates an IAlgorithmParameters instance for hybrid reasoning with the specified parameters.

Parameters:

params - for the rewriting, chase, storages, and forcing termination

Returns:

A new IAlgorithmParameters instance configured for hybrid reasoning.

Compilation

static IAlgorithmParameters Compilation(IGParameter<InteGraalKeywords, ?>... params)

Creates an IAlgorithmParameters instance for rule compilation with the specified parameters.

Parameters:

params - for the compilation and forcing termination

Returns:

A new IAlgorithmParameters instance configured for rule compilation.

Explanation

static IAlgorithmParameters Explanation(IGParameter<InteGraalKeywords, ?>... params)

Creates an IAlgorithmParameters instance for query explanation with the specified parameters.

Parameters:

params - for the explanation process and forcing termination

Returns:

A new IAlgorithmParameters instance configured for query explanation.

QA

static IAlgorithmParameters QA(ExternalAlgorithmHaltingConditions hc)

Creates an IAlgorithmParameters instance for query answering with a specified timeout.

Parameters:

hc - the conditions to force algorithm termination

Returns:

A new IAlgorithmParameters instance configured for query answering.

Chase

static IAlgorithmParameters Chase(InteGraalKeywords.Algorithms.Parameters.Chase.Checker chaseType,
 ExternalAlgorithmHaltingConditions hc)

Creates an IAlgorithmParameters instance for a Chase-based reasoning algorithm with the specified parameters.

Parameters:

chaseType - The type of Chase checker.

hc - the conditions to force algorithm termination

Returns:

A new IAlgorithmParameters instance configured for Chase reasoning.

Chase

static IAlgorithmParameters Chase(InteGraalKeywords.Algorithms.Parameters.Chase.Checker chaseType,
 IGParameter<InteGraalKeywords, ?> params)

Creates an IAlgorithmParameters instance for a Chase-based reasoning algorithm with the specified parameters.

Parameters:

chaseType - The type of Chase checker.

params - the conditions to force algorithm termination

Returns:

A new IAlgorithmParameters instance configured for Chase reasoning.

Chase

default IAlgorithmParameters Chase(String chaseType,
 ExternalAlgorithmHaltingConditions hc)

Creates an IAlgorithmParameters instance for a Chase-based reasoning algorithm with the specified parameters.

Parameters:

chaseType - The type of Chase checker.

hc - the conditions to force algorithm termination

Returns:

A new IAlgorithmParameters instance configured for Chase reasoning.

OMQAChase

static IAlgorithmParameters OMQAChase(String chaseType,
 ExternalAlgorithmHaltingConditions hc)

Creates an IAlgorithmParameters instance for OMQA Chase-based reasoning with the specified parameters.

Parameters:

chaseType - The type of Chase checker as a string.

hc - the conditions to force algorithm termination

Returns:

A new IAlgorithmParameters instance configured for OMQA Chase reasoning.

OMQAChase

static IAlgorithmParameters OMQAChase(InteGraalKeywords.Algorithms.Parameters.Chase.Checker chaseType,
 ExternalAlgorithmHaltingConditions hc)

Creates an IAlgorithmParameters instance for OMQA Chase-based reasoning with the specified parameters.

Parameters:

chaseType - The type of Chase checker as a string.

hc - the conditions to force algorithm termination

Returns:

A new IAlgorithmParameters instance configured for OMQA Chase reasoning.

Rewriting

static IAlgorithmParameters Rewriting(InteGraalKeywords.Algorithms.Parameters.Compilation ruleCompilation,
 ExternalAlgorithmHaltingConditions hc)

Creates an IAlgorithmParameters instance for rewriting-based reasoning with the specified parameters.

Parameters:

ruleCompilation - The compilation method for rewriting.

hc - the conditions to force algorithm termination

Returns:

A new IAlgorithmParameters instance configured for rewriting.

OMQARewriting

static IAlgorithmParameters OMQARewriting(InteGraalKeywords.Algorithms.Parameters.Compilation compilation,
 ExternalAlgorithmHaltingConditions hc)

Creates an IAlgorithmParameters instance for OMQA rewriting with the specified parameters.

Parameters:

compilation - The compilation method for rewriting.

hc - the conditions to force algorithm termination

Returns:

A new IAlgorithmParameters instance configured for OMQA rewriting.

OMQARewriting

static IAlgorithmParameters OMQARewriting(String ruleCompilation,
 ExternalAlgorithmHaltingConditions hc)

Creates an IAlgorithmParameters instance for OMQA rewriting with the specified parameters.

Parameters:

ruleCompilation - The compilation method for rewriting.

hc - the conditions to force algorithm termination

Returns:

A new IAlgorithmParameters instance configured for OMQA rewriting.

OMQAHybrid

static IAlgorithmParameters OMQAHybrid(String chaseType,
 String compilationType,
 ExternalAlgorithmHaltingConditions hc)

Creates an IAlgorithmParameters instance for hybrid reasoning with the specified parameters.

Parameters:

chaseType - The type of Chase checker.

compilationType - The type of rule compilation.

hc - the conditions to force algorithm termination

Returns:

A new IAlgorithmParameters instance configured for hybrid reasoning.

Compilation

static IAlgorithmParameters Compilation(InteGraalKeywords.Algorithms.Parameters.Compilation ruleCompilation,
 ExternalAlgorithmHaltingConditions hc)

Creates an IAlgorithmParameters instance for rule compilation with the specified parameters.

Parameters:

ruleCompilation - The compilation method for rule compilation.

hc - the conditions to force algorithm termination

Returns:

A new IAlgorithmParameters instance configured for rule compilation.

Explanation

static IAlgorithmParameters Explanation(ExternalAlgorithmHaltingConditions hc)

Creates an IAlgorithmParameters instance for query explanation with the specified parameters.

Parameters:

hc - the conditions to force algorithm termination

Returns:

A new IAlgorithmParameters instance configured for query explanation.

setParameter

IAlgorithmParameters setParameter(Enum<?> enumValue)

Sets the value of a parameter based on the provided enum constant.

Parameters:

enumValue - The enum constant to be set as a parameter value.

Returns:

the updated algorithm parameters

setOpenParameterFromEnumeration

IAlgorithmParameters setOpenParameterFromEnumeration(Class<? extends Enum<?>> className,
 String propertyName,
 String value)

Sets the value of a parameter based on the provided class, property name, and value.

Parameters:

className - The class type of the enum which defines the property name.

propertyName - The name of the property to be set.

value - The value to be assigned to the property.

Returns:

the updated algorithm parameters

setOpenParameterFromEnumeration

IAlgorithmParameters setOpenParameterFromEnumeration(Enum<?> className,
 String propertyName,
 String value)

Sets the value of a parameter based on the provided enumeration, property name, and value.

Parameters:

className - The parent enum which defines the property name.

propertyName - The name of the property to be set.

value - The value to be assigned to the property.

Returns:

the updated algorithm parameters

setOpenParameter

IAlgorithmParameters setOpenParameter(InteGraalKeywords k,
 Object value)

Sets the value of an open parameter which is not defined within a parent enumeration

Parameters:

k - The property name

value - The value to be assigned to the property.

Returns:

the updated algorithm parameters

usesStorage

boolean usesStorage()

Indicates whether the algorithm requires external storage settings.

Returns:

true if storage is configured

getStorageType

Optional<InteGraalKeywords.InternalStorageConfiguration.DBType> getStorageType()

Returns the configured storage type.

Returns:

the storage type, if any

setStorageType

IAlgorithmParameters setStorageType(InteGraalKeywords.InternalStorageConfiguration.DBType storageName)

Sets the storage type.

Parameters:

storageName - the storage type to use

Returns:

the updated algorithm parameters

getDBDriver

Optional<InteGraalKeywords.InternalStorageConfiguration.DriverType> getDBDriver()

Returns the configured database driver type.

Returns:

the driver type, if any

setDBDriver

IAlgorithmParameters setDBDriver(InteGraalKeywords.InternalStorageConfiguration.DriverType dbDriverName)

Sets the database driver type.

Parameters:

dbDriverName - the driver type to use

Returns:

the updated algorithm parameters

getDBMSDriverParameters

Optional<Map<InteGraalKeywords.InternalStorageConfiguration.DBMSDriverParameters, String>> getDBMSDriverParameters()

Returns the configured DBMS driver parameters.

Returns:

the DBMS driver parameters, if any

setDBMSDriverParameters

IAlgorithmParameters setDBMSDriverParameters(InteGraalKeywords.InternalStorageConfiguration.DBMSDriverParameters paramName,
 String value)

Sets a single DBMS driver parameter.

Parameters:

paramName - the parameter to set

value - the parameter value

Returns:

the updated algorithm parameters

getDBStrategy

Optional<InteGraalKeywords.InternalStorageConfiguration.StorageLayout> getDBStrategy()

Returns the configured storage layout strategy.

Returns:

the storage layout, if any

setDBStrategy

IAlgorithmParameters setDBStrategy(InteGraalKeywords.InternalStorageConfiguration.StorageLayout strategyName)

Sets the storage layout strategy.

Parameters:

strategyName - the layout strategy to use

Returns:

the updated algorithm parameters

usesQueryAnsweringAlgorithm

boolean usesQueryAnsweringAlgorithm()

Indicates whether query answering is configured.

Returns:

true if query answering is enabled

asksLists

boolean asksLists()

Indicates whether list output is requested.

Returns:

true if only the result should be a list

asksSet

boolean asksSet()

Indicates whether set output is requested.

Returns:

true if only the result should be a set

getResultType

InteGraalKeywords.Algorithms.Answers getResultType()

Returns the configured answer container type.

Returns:

the result type (list, set, count)

getImageType

InteGraalKeywords.Algorithms.Images getImageType()

Returns the configured image type.

Returns:

the image type (constants, all)

asksCountOnly

boolean asksCountOnly()

Indicates whether only the count of answers is requested.

Returns:

true if only the count is requested.

setResultType

void setResultType(InteGraalKeywords.Algorithms.Answers type)

sets the type of result

Parameters:

type - expected

setImageType

void setImageType(InteGraalKeywords.Algorithms.Images type)

sets the type of images

Parameters:

type - expected

usesSaturationAlgorithm

boolean usesSaturationAlgorithm()

Indicates whether the algorithm uses a saturation algorithm.

Returns:

true if the algorithm uses a saturation algorithm, false otherwise

usesOMQASaturationAlgorithm

boolean usesOMQASaturationAlgorithm()

Indicates whether the algorithm uses a saturation algorithm for OMQA.

Returns:

true if the algorithm uses a saturation algorithm for OMQA, false otherwise

getScheduler

Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Scheduler> getScheduler()

Gets the chase scheduler used in the algorithm.

Returns:

an Optional containing the scheduler, or an empty Optional if not set

setScheduler

IAlgorithmParameters setScheduler(InteGraalKeywords.Algorithms.Parameters.Chase.Scheduler schedulerName)

Sets the chase scheduler to be used in the algorithm.

Parameters:

schedulerName - the scheduler to be set

Returns:

the configuration with settled value

getCriterion

Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Checker> getCriterion()

Gets the chase criterion used in the algorithm.

Returns:

an Optional containing the chase criterion, or an empty Optional if not set

setCriterion

IAlgorithmParameters setCriterion(InteGraalKeywords.Algorithms.Parameters.Chase.Checker criterionName)

Sets the chase criterion to be used in the algorithm.

Parameters:

criterionName - the chase criterion to be set

Returns:

the configuration with settled value

getComputer

Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Computer> getComputer()

Gets the chase computer used in the algorithm.

Returns:

an Optional containing the chase computer, or an empty Optional if not set

setComputer

IAlgorithmParameters setComputer(InteGraalKeywords.Algorithms.Parameters.Chase.Computer computerName)

Sets the chase computer to be used in the algorithm.

Parameters:

computerName - the chase computer to be set

Returns:

the configuration with settled value

getRuleApplier

Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Applier> getRuleApplier()

Gets the rule applier used in the chase algorithm.

Returns:

an Optional containing the rule applier, or an empty Optional if not set

setRuleApplier

IAlgorithmParameters setRuleApplier(InteGraalKeywords.Algorithms.Parameters.Chase.Applier applierName)

Sets the rule applier to be used in the chase algorithm.

Parameters:

applierName - the rule applier to be set

Returns:

the configuration with settled value

getSkolemization

Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Namer> getSkolemization()

Gets the skolemization strategy used in the chase algorithm.

Returns:

an Optional containing the skolemization strategy, or an empty Optional if not set

setSkolemization

IAlgorithmParameters setSkolemization(InteGraalKeywords.Algorithms.Parameters.Chase.Namer skolemizationName)

Sets the skolemization strategy to be used in the chase algorithm.

Parameters:

skolemizationName - the skolemization strategy to be set

Returns:

the configuration with settled value

getEvaluator

Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Evaluator> getEvaluator()

Gets the evaluator used in the chase algorithm.

Returns:

an Optional containing the evaluator, or an empty Optional if not set

setEvaluator

IAlgorithmParameters setEvaluator(InteGraalKeywords.Algorithms.Parameters.Chase.Evaluator evaluatorName)

Sets the evaluator to be used in the chase algorithm.

Parameters:

evaluatorName - the evaluator to be set

Returns:

the configuration with settled value

getTransformer

Optional<InteGraalKeywords.Algorithms.Parameters.Chase.Transformer> getTransformer()

Gets the transformer used in the chase algorithm.

Returns:

an Optional containing the transformer, or an empty Optional if not set

setTransformer

IAlgorithmParameters setTransformer(InteGraalKeywords.Algorithms.Parameters.Chase.Transformer transformerName)

Sets the transformer to be used in the chase algorithm.

Parameters:

transformerName - the transformer to be set

Returns:

the configuration with settled value

usesQueryRewritingAlgorithm

boolean usesQueryRewritingAlgorithm()

Indicates whether query rewriting is configured.

Returns:

true if query rewriting is enabled

usesRuleCompilationAlgorithm

boolean usesRuleCompilationAlgorithm()

Indicates whether rule compilation is configured.

Returns:

true if rule compilation is enabled

usesOMQARewritingAlgorithm

boolean usesOMQARewritingAlgorithm()

Indicates whether OMQA via rewriting is configured.

Returns:

true if OMQA rewriting is enabled

getCompilation

Optional<InteGraalKeywords.Algorithms.Parameters.Compilation> getCompilation()

Returns the configured compilation strategy.

Returns:

the compilation strategy, if any

setCompilation

IAlgorithmParameters setCompilation(InteGraalKeywords.Algorithms.Parameters.Compilation compilationName)

Sets the compilation strategy.

Parameters:

compilationName - the compilation strategy to use

Returns:

the updated algorithm parameters

usesOMQAHybridAlgorithm

boolean usesOMQAHybridAlgorithm()

Returns whether the OMQA hybrid algorithm should be used.

Returns:

true if the hybrid algorithm is enabled

getExternalHaltingConditions

ExternalAlgorithmHaltingConditions getExternalHaltingConditions()

Returns the external halting conditions currently configured.

Returns:

the external halting conditions

setExternalHaltingConditions

IAlgorithmParameters setExternalHaltingConditions(ExternalAlgorithmHaltingConditions hc)

Sets the external halting conditions.

Parameters:

hc - the halting conditions to use

Returns:

the updated algorithm parameters

setMax

IAlgorithmParameters setMax(Integer rank)

Sets the maximum number of produced answers.

Parameters:

rank - the maximum number of answers

Returns:

the updated algorithm parameters

setRank

IAlgorithmParameters setRank(Integer rank)

Sets the maximum reasoning rank.

Parameters:

rank - the reasoning depth limit

Returns:

the updated algorithm parameters

setTimeout

IAlgorithmParameters setTimeout(Duration timeout)

Sets the global timeout.

Parameters:

timeout - the timeout duration

Returns:

the updated algorithm parameters

getMax

Optional<Integer> getMax()

Returns the maximum number of produced answers.

Returns:

the maximum number of answers, if any

getRank

Optional<Integer> getRank()

Returns the maximum reasoning rank.

Returns:

the reasoning rank, if any

getTimeout

Optional<Duration> getTimeout()

Returns the configured timeout.

Returns:

the timeout, if any

getExplanation

Optional<InteGraalKeywords.Algorithms.Parameters.Explanation> getExplanation()

Returns the selected explanation category.

Returns:

the explanation category, if any

setExplanationCategory

IAlgorithmParameters setExplanationCategory(InteGraalKeywords.Algorithms.Parameters.Explanation explanationCategory)

Sets the explanation category.

Parameters:

explanationCategory - the explanation category to use

Returns:

the updated algorithm parameters

getExplainerSolver

Optional<InteGraalKeywords.Algorithms.Parameters.Explanation.ExplainerSolver> getExplainerSolver()

Returns the configured explainer solver.

Returns:

the explainer solver, if any

setExplainerSolver

IAlgorithmParameters setExplainerSolver(InteGraalKeywords.Algorithms.Parameters.Explanation.ExplainerSolver solver)

Sets the explainer solver.

Parameters:

solver - the solver to use

Returns:

the updated algorithm parameters

getExplanationSupportType

Optional<InteGraalKeywords.Algorithms.Parameters.Explanation.ExplanationSupportType> getExplanationSupportType()

Returns the configured explanation support type.

Returns:

the explanation support type, if any

setExplanationSupportType

IAlgorithmParameters setExplanationSupportType(InteGraalKeywords.Algorithms.Parameters.Explanation.ExplanationSupportType explanationSupportType)

Sets the explanation support type.

Parameters:

explanationSupportType - the support type to use

Returns:

the updated algorithm parameters

getExplainerVerbosity

Optional<InteGraalKeywords.Algorithms.Parameters.Explanation.ExplainerVerbosity> getExplainerVerbosity()

Returns the configured explainer verbosity.

Returns:

the explainer verbosity, if any

setExplainerVerbosity

IAlgorithmParameters setExplainerVerbosity(InteGraalKeywords.Algorithms.Parameters.Explanation.ExplainerVerbosity verbosity)

Sets the explainer verbosity.

Parameters:

verbosity - the verbosity level to use

Returns:

the updated algorithm parameters

getGraphOfRuleInstancesType

Optional<InteGraalKeywords.Algorithms.Parameters.Explanation.GraphOfRuleInstancesType> getGraphOfRuleInstancesType()

Returns the configured graph-of-rule-instances representation.

Returns:

the GRI representation, if any

setGraphOfRuleInstancesType

IAlgorithmParameters setGraphOfRuleInstancesType(InteGraalKeywords.Algorithms.Parameters.Explanation.GraphOfRuleInstancesType griType)

Sets the graph-of-rule-instances representation.

Parameters:

griType - the GRI representation to use

Returns:

the updated algorithm parameters

getGraphOfRuleInstancesComputation

Optional<InteGraalKeywords.Algorithms.Parameters.Explanation.GraphOfRuleInstancesComputation> getGraphOfRuleInstancesComputation()

Returns the configured graph-of-rule-instances computation strategy.

Returns:

the GRI computation strategy, if any

setGraphOfRuleInstancesType

IAlgorithmParameters setGraphOfRuleInstancesType(InteGraalKeywords.Algorithms.Parameters.Explanation.GraphOfRuleInstancesComputation griComputation)

Sets the graph-of-rule-instances computation strategy.

Parameters:

griComputation - the computation strategy to use

Returns:

the updated algorithm parameters

getGMUSSolverTreshold

Optional<Integer> getGMUSSolverTreshold()

Returns the configured GMUS solver threshold.

Returns:

the threshold, if any

setGMUSSolverTreshold

IAlgorithmParameters setGMUSSolverTreshold(int treshold)

Sets the GMUS solver threshold.

Parameters:

treshold - the threshold value

Returns:

the updated algorithm parameters

getMARCOPathToExecutable

Optional<String> getMARCOPathToExecutable()

Returns the configured path to the MARCO executable.

Returns:

the executable path, if any

setMARCOPathToExecutable

IAlgorithmParameters setMARCOPathToExecutable(String pathToExecutable)

Sets the path to the MARCO executable.

Parameters:

pathToExecutable - the executable path

Returns:

the updated algorithm parameters

setGSATSolverParameters

IAlgorithmParameters setGSATSolverParameters(InteGraalKeywords.Algorithms.Parameters.Explanation.GSATSolverParameters paramName,
 String value)

Sets a named GMUS solver parameter.

Parameters:

paramName - the parameter name

value - the parameter value

Returns:

the updated algorithm parameters