clara.rules.engine — com.github.k13labs/clara-rules 1.4.4

This namespace is for internal use and may move in the future. Most users should use only the clara.rules namespace.

*current-session* clj

*pending-external-retractions* clj

*rule-context* clj

->LocalSession clj

(->LocalSession rulebase
                memory
                transport
                listener
                get-alphas-fn
                pending-operations)

as-read-only clj

(as-read-only session)

assemble clj

(assemble {:keys [rulebase memory transport listeners get-alphas-fn]})

Assembles a session from the given components, which must be a map containing the following:

:rulebase A recorec matching the clara.rules.compiler/Rulebase structure. :memory An implementation of the clara.rules.memory/IMemoryReader protocol :transport An implementation of the clara.rules.engine/ITransport protocol :listeners A vector of listeners implementing the clara.rules.listener/IPersistentListener protocol :get-alphas-fn The function used to return the alpha nodes for a fact of the given type.

assemble-read-only clj

(assemble-read-only {:keys [rulebase memory]})

empty-token clj

find-listeners clj

(find-listeners session pred)

Return all listeners on the session matching the predicate.

get-conditions-and-rule-names clj

(get-conditions-and-rule-names node)

Returns a map from conditions to sets of rules.

get-terminal-node-types clj

(get-terminal-node-types node)

IAccumInspect clj protocol

This protocol is expected to be implemented on accumulator nodes in the rules network. It is not expected that users will implement this protocol, and most likely will not call the protocol function directly.

token->matching-elements clj

(token->matching-elements node memory token)

Takes a token that was previously propagated from the node, or a token that is a descendant of such a token, and returns the facts in elements matching the token propagated from the node. During rules firing accumulators only propagate bindings created and the result binding downstream rather than all facts that were accumulated over, but there are use-cases in session inspection where we want to retrieve the individual facts.

Example: [?min-temp <- (acc/min :temperature) :from [Temperature (= temperature ?loc)]] [?windspeed <- [WindSpeed (= location ?loc)]]

Given a token propagated from the node for the WindSpeed condition we could retrieve the Temperature facts from the matching location.

IAccumRightActivate clj protocol

pre-reduce clj

(pre-reduce node elements)

right-activate-reduced clj

(right-activate-reduced node join-bindings reduced memory transport listener)

IAlphaActivate clj protocol

alpha-activate clj

(alpha-activate node facts memory transport listener)

alpha-retract clj

(alpha-retract node facts memory transport listener)

IConditionNode clj protocol

get-condition-description clj

(get-condition-description this)

ILeftActivate clj protocol

description clj

(description node)

get-join-keys clj

(get-join-keys node)

left-activate clj

(left-activate node join-bindings tokens memory transport listener)

left-retract clj

(left-retract node join-bindings tokens memory transport listener)

insert-facts! clj

(insert-facts! facts unconditional)

Place facts in a stateful cache to be inserted into the session immediately after the RHS of a rule fires.

IRightActivate clj protocol

right-activate clj

(right-activate node join-bindings elements memory transport listener)

right-retract clj

(right-retract node join-bindings elements memory transport listener)

ISession clj protocol

components clj

(components session)

fire-rules clj

(fire-rules session)

(fire-rules session opts)

fire-rules-async clj

(fire-rules-async session)

(fire-rules-async session opts)

insert clj

(insert session facts)

query clj

(query session query params)

retract clj

(retract session facts)

ITerminalNode clj protocol

terminal-node-type clj

(terminal-node-type this)

ITransport clj protocol

retract-elements clj

(retract-elements transport memory listener nodes elements)

retract-tokens clj

(retract-tokens transport memory listener nodes tokens)

send-elements clj

(send-elements transport memory listener nodes elements)

send-tokens clj

(send-tokens transport memory listener nodes tokens)

local-memory clj

(local-memory rulebase
              transport
              activation-group-sort-fn
              activation-group-fn
              alphas-fn)

Returns a local, in-process working memory.

node-rule-names clj

(node-rule-names child-type node)

node-type->abbreviated-type clj

To minimize function name length and attempt to prevent issues with filename length we can use these abbreviations to shorten the node types. Used during compilation of the rules network.

options->activation-group-fn clj

(options->activation-group-fn options)

Given a map of options for a session, construct a function that takes a production and returns the activation group to which it belongs, considering both user-provided and internal salience. Under normal circumstances this function should only be called by Clara itself.

options->activation-group-sort-fn clj

(options->activation-group-sort-fn options)

Given the map of options for a session, construct an activation group sorting function that takes into account the user-provided salience and internal salience. User-provided salience is considered first. Under normal circumstances this function should only be called by Clara itself.

remove-listeners clj

(remove-listeners session pred)

Return a new session with all listeners matching the predicate removed

retract-facts! clj

(retract-facts! facts)

Perform the fact retraction.

rhs-retract-facts! clj

(rhs-retract-facts! facts)

Place all facts retracted in the RHS in a buffer to be retracted after the eval'ed RHS function completes.

rulebase->query-only-rulebase clj

(rulebase->query-only-rulebase rulebase)

Construcs a read only network from a rulebase, the read only network only contains query nodes

with-listener clj

(with-listener session listener)

Return a new session with the listener added to the provided session, in addition to all listeners previously on the session.