org.semwebcentral.sweetrules.infrastructure
Interface ISweetIEDescriptor

All Known Implementing Classes:
AbstractSweetIEDescriptor

public interface ISweetIEDescriptor

An interface to describe an inference engine

Author:
Shashidhara K Ganjugunte, Dr. Benjamin Grosof, Dr. Said Tabet, Chitravanu Neogy

Method Summary
 void addInferenceTaskClass(java.lang.Class taskClass)
          Adds a task to the list of supported tasks
 ISweetCanonicalVersionNumber getEngineVersionNumber()
          Retrieves the version number of the engine
 SweetIEInferenceType getInferenceType()
          Returns the type of the inferencing done by the inference engine for e.g. forward, backward etc
 java.lang.String getName()
          Returns the name of the inference engine
 ISweetKRDescriptor getNativeKRDescriptor()
          Returns the Native KR descriptor of this inference engine
 java.lang.Class[] getSupportedTasks()
          Returns an array containing all supported tasks
 void setEngineVersionNumber(ISweetCanonicalVersionNumber version)
          Sets the version number of the engine
 void setInferenceType(SweetIEInferenceType inferenceType)
          Sets the type of the inferencing done by the inference engine for e.g. forward, backward etc
 void setName(java.lang.String name)
          Sets the name of the inference engine
 void setNativeKRDescriptor(ISweetKRDescriptor krDescriptor)
          Sets the KR descriptor for the inference engine
 

Method Detail

getName

public java.lang.String getName()
Returns the name of the inference engine

Returns:
Name of the inference engine.

setName

public void setName(java.lang.String name)
Sets the name of the inference engine

Parameters:
name - The name of the inference engine (for e.g. XSB)

getInferenceType

public SweetIEInferenceType getInferenceType()
Returns the type of the inferencing done by the inference engine for e.g. forward, backward etc

Returns:
The inference type of the engine

setInferenceType

public void setInferenceType(SweetIEInferenceType inferenceType)
Sets the type of the inferencing done by the inference engine for e.g. forward, backward etc

Parameters:
inferenceType - The inference type of the engine

getNativeKRDescriptor

public ISweetKRDescriptor getNativeKRDescriptor()
Returns the Native KR descriptor of this inference engine

Returns:
The native kr descriptor of the inference engine

setNativeKRDescriptor

public void setNativeKRDescriptor(ISweetKRDescriptor krDescriptor)
Sets the KR descriptor for the inference engine

Parameters:
krDescriptor - The KR descriptor of the inference engine

getEngineVersionNumber

public ISweetCanonicalVersionNumber getEngineVersionNumber()
Retrieves the version number of the engine

Returns:
Version number of the engine

setEngineVersionNumber

public void setEngineVersionNumber(ISweetCanonicalVersionNumber version)
Sets the version number of the engine

Parameters:
version - The version number to set

getSupportedTasks

public java.lang.Class[] getSupportedTasks()
Returns an array containing all supported tasks

Returns:
The array of supported tasks

addInferenceTaskClass

public void addInferenceTaskClass(java.lang.Class taskClass)
Adds a task to the list of supported tasks

Parameters:
taskClass - The task to be added as a supported task