Skip navigation links

ilog.rules.engine
Interface IlrTool

All Known Implementing Classes:

IlrToolAdapter, IlrToolDecorator

public interface IlrTool

The IlrTool interface.

Once connected to an IlrContext, these methods are called to provide notifications of IlrContext changes.

See Also:

IlrLocalTracerToolFactory, ilog.rules.debug.IlrBuilderToolFactory

Method Summary

void	notifyActivateRule(IlrRule rule) Deprecated.
void	notifyAddInstance(IlrRuleInstance instance, IlrRuleInstance previous) Provides notification that a rule instance has been inserted into the agenda.
void	notifyAddRule(IlrRule rule) Provides notification that an IlrRule has been added in the ruleset.
void	notifyAssertLogical(Object object) Provides notification that a logical object has been asserted in working memory.
void	notifyAssertObject(Object object) Provides notification that an object has been asserted in working memory.
void	notifyBeginInstance(IlrRuleInstance instance) Provides notification that a rule instance has been selected to fire and that the first action is about to be executed.
void	notifyBeginSequentialInstance(IlrRule rule, Object[] tuple, int priority) Provides notification that a sequential instance has been added and selected to fire and that the first action is about to be executed.
void	notifyBeginTask(IlrTask task) Provides notification that a task is about to be executed.
void	notifyConnect() Provides notification that a connection has occurred.
void	notifyDeactivateRule(IlrRule rule) Deprecated.
void	notifyDefineFunction(IlrFunction function) Provides notification that an IlrFunction has been defined in the ruleset.
void	notifyDisconnect() Provides notification that a disconnection has occurred.
void	notifyEndInstance(IlrRuleInstance instance) Provides notification that a rule instance has finished executing the action part.
void	notifyEndRuleFlow(IlrTask task) Provides notification that a flow is about to finish its execution.
void	notifyEndSequentialInstance(IlrRule rule, Object[] tuple, int priority) Provides notification that a rule instance has finished executing the action part.
void	notifyEndTask(IlrTask task) Provides notification that a task is about to finish its execution.
void	notifyRemoveAllInstances() Provides notification that all rule instances have been removed from the agenda without having been fired.
void	notifyRemoveInstance(IlrRuleInstance instance) Provides notification that a rule instance has been removed from the agenda without having been fired.
void	notifyRemoveRule(IlrRule rule) Provides notification that an IlrRule has been removed from the ruleset.
void	notifyReset() Provides notification that the context has been reset.
void	notifyRetractAll() Provides notification that all objects have been retracted from working memory.
void	notifyRetractObject(Object object) Provides notification that an object has been retracted from working memory.
void	notifySetInitialRule(Vector initialStatements) Deprecated.
void	notifyStartRuleFlow(IlrTask task) Provides notification that a flow is about to be executed.
void	notifyUpdateObject(Object object) Provides notification that an object has been updated in working memory.

Method Detail

notifyConnect

void notifyConnect()

Provides notification that a connection has occurred.

notifyDisconnect

void notifyDisconnect()

Provides notification that a disconnection has occurred.

notifyAddRule

void notifyAddRule(IlrRule rule)

Provides notification that an IlrRule has been added in the ruleset.

Parameters:

rule - The rule.

notifyRemoveRule

void notifyRemoveRule(IlrRule rule)

Provides notification that an IlrRule has been removed from the ruleset.

Parameters:

rule - The rule.

notifySetInitialRule

void notifySetInitialRule(Vector initialStatements)

Deprecated.

Provides notification that an Initial Action has been set for the ruleset.

Parameters:

initialStatements - The vector containing all IlrStatements.

notifyDefineFunction

void notifyDefineFunction(IlrFunction function)

Provides notification that an IlrFunction has been defined in the ruleset.

Parameters:

function - The function.

notifyActivateRule

void notifyActivateRule(IlrRule rule)

Deprecated.

Provides notification that an IlrRule has been activated in the context.

Parameters:

rule - The rule.

notifyDeactivateRule

void notifyDeactivateRule(IlrRule rule)

Deprecated.

Provides notification that an IlrRule has been deactivated in the context.

Parameters:

rule - The rule.

notifyAssertObject

void notifyAssertObject(Object object)

Provides notification that an object has been asserted in working memory.

Parameters:

object - The object.

notifyAssertLogical

void notifyAssertLogical(Object object)

Provides notification that a logical object has been asserted in working memory.

Parameters:

object - The object.

notifyRetractObject

void notifyRetractObject(Object object)

Provides notification that an object has been retracted from working memory.

Parameters:

object - The object.

notifyUpdateObject

void notifyUpdateObject(Object object)

Provides notification that an object has been updated in working memory.

Parameters:

object - The object.

notifyRetractAll

void notifyRetractAll()

Provides notification that all objects have been retracted from working memory.

notifyReset

void notifyReset()

Provides notification that the context has been reset.

notifyAddInstance

void notifyAddInstance(IlrRuleInstance instance,
                       IlrRuleInstance previous)

Provides notification that a rule instance has been inserted into the agenda.

Parameters:

instance - The rule instance.

previous - The rule instance preceding the current instance, or null

notifyRemoveInstance

void notifyRemoveInstance(IlrRuleInstance instance)

Provides notification that a rule instance has been removed from the agenda without having been fired.

Parameters:

instance - The removed rule instance.

notifyRemoveAllInstances

void notifyRemoveAllInstances()

Provides notification that all rule instances have been removed from the agenda without having been fired.

notifyBeginInstance

void notifyBeginInstance(IlrRuleInstance instance)

Provides notification that a rule instance has been selected to fire and that the first action is about to be executed.

Parameters:

instance - The rule instance.

notifyEndInstance

void notifyEndInstance(IlrRuleInstance instance)

Provides notification that a rule instance has finished executing the action part.

Parameters:

instance - The rule instance.

notifyBeginSequentialInstance

void notifyBeginSequentialInstance(IlrRule rule,
                                   Object[] tuple,
                                   int priority)

Provides notification that a sequential instance has been added and selected to fire and that the first action is about to be executed. Note that for sequential and fastpath algorithms debugging must be enabled thanks to the property: ilog.rules.engine.sequential.debug

notifyEndSequentialInstance

void notifyEndSequentialInstance(IlrRule rule,
                                 Object[] tuple,
                                 int priority)

Provides notification that a rule instance has finished executing the action part. Note that for sequential and fastpath algorithms debugging must be enabled thanks to the property: ilog.rules.engine.sequential.debug

notifyBeginTask

void notifyBeginTask(IlrTask task)

Provides notification that a task is about to be executed.

Parameters:

task - The task.

notifyEndTask

void notifyEndTask(IlrTask task)

Provides notification that a task is about to finish its execution.

Parameters:

task - The task.

notifyStartRuleFlow

void notifyStartRuleFlow(IlrTask task)

Provides notification that a flow is about to be executed. A flow can be either the execution of a flow task, which invokes the execution of other tasks, or a single rule task or function task.

Parameters:

task - The task that models the flow.

notifyEndRuleFlow

void notifyEndRuleFlow(IlrTask task)

Provides notification that a flow is about to finish its execution. A flow can be either the execution of a flow task, which invokes the execution of other tasks, or a single rule task or function task.

Parameters:

task - The task that models the flow.