Package org.drools.core.rule.consequence

Interface KnowledgeHelper

All Superinterfaces:

org.kie.api.runtime.KieContext, org.kie.api.runtime.rule.RuleContext, java.io.Serializable

public interface KnowledgeHelper
extends org.kie.api.runtime.rule.RuleContext, java.io.Serializable

KnowledgeHelper implementation types are injected into consequenses instrumented at compile time and instances passed at runtime. It provides convenience methods for users to interact with the WorkingMemory.

Of particular interest is the update method as it allows an object to be modified without having to specify the facthandle, because they are not passed to the consequence at runtime. To achieve this the implementation will need to lookup the fact handle of the object form the WorkingMemory.

Method Summary

Modifier and Type	Method	Description
InternalFactHandle	bolster(java.lang.Object object)
InternalFactHandle	bolster(java.lang.Object object, java.lang.Object value)
void	delete(java.lang.Object handle)
void	delete(java.lang.Object object, org.kie.api.runtime.rule.FactHandle.State fhState)
void	delete(org.kie.api.runtime.rule.FactHandle handle)
void	delete(org.kie.api.runtime.rule.FactHandle handle, org.kie.api.runtime.rule.FactHandle.State fhState)
<T,K> T	don(K core, java.lang.Class<T> trait)
<T,K> T	don(K core, java.lang.Class<T> trait, boolean logical)
<T,K> T	don(K core, java.lang.Class<T> trait, Mode... modes)
<T,K> T	don(K core, java.util.Collection<java.lang.Class<? extends Thing>> trait)
<T,K> T	don(K core, java.util.Collection<java.lang.Class<? extends Thing>> trait, boolean logical)
<T,K> T	don(K core, java.util.Collection<java.lang.Class<? extends Thing>> trait, Mode... modes)
<T,K> T	don(Thing<K> core, java.lang.Class<T> trait)
java.lang.Object	get(Declaration declaration)
org.kie.api.runtime.Channel	getChannel(java.lang.String id)
java.util.Map<java.lang.String,org.kie.api.runtime.Channel>	getChannels()
<T> T	getContext(java.lang.Class<T> contextClass)
Declaration	getDeclaration(java.lang.String identifier)
org.kie.api.runtime.rule.EntryPoint	getEntryPoint(java.lang.String id)
InternalFactHandle	getFactHandle(java.lang.Object object)
InternalFactHandle	getFactHandle(InternalFactHandle handle)
Activation	getMatch()
java.lang.ClassLoader	getProjectClassLoader()
RuleImpl	getRule()
Tuple	getTuple()
WorkingMemory	getWorkingMemory()
default void	guard(java.lang.Class<?> ruleUnitClass)
default void	guard(java.lang.Object ruleUnit)
void	halt()
InternalFactHandle	insert(java.lang.Object object)	Asserts an object
InternalFactHandle	insert(java.lang.Object object, boolean dynamic)	Asserts an object specifying that it implement the onPropertyChange listener
org.kie.api.runtime.rule.FactHandle	insertAsync(java.lang.Object object)
InternalFactHandle	insertLogical(java.lang.Object object)
InternalFactHandle	insertLogical(java.lang.Object object, java.lang.Object value)
InternalFactHandle	insertLogical(java.lang.Object object, Mode belief)
InternalFactHandle	insertLogical(java.lang.Object object, Mode... beliefs)
void	reset()
default void	restoreActivationOnConsequenceFailure(Activation activation)
void	retract(java.lang.Object handle)	Deprecated. Use delete
void	retract(org.kie.api.runtime.rule.FactHandle handle)	Deprecated. Use delete
default void	run(java.lang.Class<?> ruleUnitClass)
default void	run(java.lang.Object ruleUnit)
default void	run(java.lang.String ruleUnitName)
void	setActivation(Activation activation)
void	setFocus(java.lang.String focus)
<T,K> Thing<K>	shed(Thing<K> thing, java.lang.Class<T> trait)
<T,K,X extends TraitableBean> Thing<K>	shed(TraitableBean<K,X> core, java.lang.Class<T> trait)
void	update(java.lang.Object newObject)
void	update(java.lang.Object newObject, BitMask mask, java.lang.Class<?> modifiedClass)
void	update(org.kie.api.runtime.rule.FactHandle newObject)
void	update(org.kie.api.runtime.rule.FactHandle handle, java.lang.Object newObject)
void	update(org.kie.api.runtime.rule.FactHandle newObject, BitMask mask, java.lang.Class<?> modifiedClass)

Methods inherited from interface org.kie.api.runtime.KieContext

getKieBase, getKieRuntime, getKnowledgeRuntime

Methods inherited from interface org.kie.api.runtime.rule.RuleContext

blockMatch, cancelMatch, insertLogical, unblockAllMatches

Method Detail

setActivation

void setActivation(Activation activation)

restoreActivationOnConsequenceFailure

default void restoreActivationOnConsequenceFailure(Activation activation)

reset

void reset()

insert

InternalFactHandle insert(java.lang.Object object)

Asserts an object

Parameters:

object - - the object to be asserted

insertAsync

org.kie.api.runtime.rule.FactHandle insertAsync(java.lang.Object object)

insert

InternalFactHandle insert(java.lang.Object object,
                          boolean dynamic)

Asserts an object specifying that it implement the onPropertyChange listener

Parameters:

object - - the object to be asserted

dynamic - - specifies the object implements onPropertyChangeListener

insertLogical

InternalFactHandle insertLogical(java.lang.Object object)

Specified by:

insertLogical in interface org.kie.api.runtime.rule.RuleContext

insertLogical

InternalFactHandle insertLogical(java.lang.Object object,
                                 java.lang.Object value)

insertLogical

InternalFactHandle insertLogical(java.lang.Object object,
                                 Mode belief)

insertLogical

InternalFactHandle insertLogical(java.lang.Object object,
                                 Mode... beliefs)

getFactHandle

InternalFactHandle getFactHandle(java.lang.Object object)

getFactHandle

InternalFactHandle getFactHandle(InternalFactHandle handle)

update

void update(org.kie.api.runtime.rule.FactHandle handle,
            java.lang.Object newObject)

update

void update(org.kie.api.runtime.rule.FactHandle newObject)

update

void update(org.kie.api.runtime.rule.FactHandle newObject,
            BitMask mask,
            java.lang.Class<?> modifiedClass)

update

void update(java.lang.Object newObject)

update

void update(java.lang.Object newObject,
            BitMask mask,
            java.lang.Class<?> modifiedClass)

retract

void retract(org.kie.api.runtime.rule.FactHandle handle)

Deprecated.

Use delete

retract

void retract(java.lang.Object handle)

Deprecated.

Use delete

delete

void delete(java.lang.Object handle)

delete

void delete(java.lang.Object object,
            org.kie.api.runtime.rule.FactHandle.State fhState)

delete

void delete(org.kie.api.runtime.rule.FactHandle handle)

delete

void delete(org.kie.api.runtime.rule.FactHandle handle,
            org.kie.api.runtime.rule.FactHandle.State fhState)

get

java.lang.Object get(Declaration declaration)

getRule

RuleImpl getRule()

Specified by:

getRule in interface org.kie.api.runtime.rule.RuleContext

Returns:

- The rule name

getTuple

Tuple getTuple()

getMatch

Activation getMatch()

Specified by:

getMatch in interface org.kie.api.runtime.rule.RuleContext

getWorkingMemory

WorkingMemory getWorkingMemory()

getEntryPoint

org.kie.api.runtime.rule.EntryPoint getEntryPoint(java.lang.String id)

getChannel

org.kie.api.runtime.Channel getChannel(java.lang.String id)

getChannels

java.util.Map<java.lang.String,org.kie.api.runtime.Channel> getChannels()

setFocus

void setFocus(java.lang.String focus)

getDeclaration

Declaration getDeclaration(java.lang.String identifier)

halt

void halt()

getContext

<T> T getContext(java.lang.Class<T> contextClass)

don

<T,K> T don(K core,
                  java.lang.Class<T> trait,
                  boolean logical)

don

<T,K> T don(K core,
                  java.lang.Class<T> trait,
                  Mode... modes)

don

<T,K> T don(K core,
                  java.lang.Class<T> trait)

don

<T,K> T don(Thing<K> core,
                  java.lang.Class<T> trait)

don

<T,K> T don(K core,
                  java.util.Collection<java.lang.Class<? extends Thing>> trait,
                  boolean logical)

don

<T,K> T don(K core,
                  java.util.Collection<java.lang.Class<? extends Thing>> trait,
                  Mode... modes)

don

<T,K> T don(K core,
                  java.util.Collection<java.lang.Class<? extends Thing>> trait)

shed

<T,K> Thing<K> shed(Thing<K> thing,
                          java.lang.Class<T> trait)

shed

<T,K,X extends TraitableBean> Thing<K> shed(TraitableBean<K,X> core,
                                                        java.lang.Class<T> trait)

bolster

InternalFactHandle bolster(java.lang.Object object)

bolster

InternalFactHandle bolster(java.lang.Object object,
                           java.lang.Object value)

getProjectClassLoader

java.lang.ClassLoader getProjectClassLoader()

run

default void run(java.lang.String ruleUnitName)

run

default void run(java.lang.Object ruleUnit)

run

default void run(java.lang.Class<?> ruleUnitClass)

guard

default void guard(java.lang.Object ruleUnit)

guard

default void guard(java.lang.Class<?> ruleUnitClass)