Package oracle.rules.rl

Class RuleSession

java.lang.Object
oracle.rules.rl.RuleSession
All Implemented Interfaces:
Serializable
public class RuleSession extends Object implements Serializable
RuleSession is the public API for executing Oracle Rule Language.
See Also:

  • Field Details

    • CFG_LOCALE

      public static final String CFG_LOCALE
      The key for setting the Locale for this RuleSession. a RuleSession.
      See Also:

    • CFG_SESSION_NAME

      public static final String CFG_SESSION_NAME
      The key for setting the string to use for this RuleSession.
      See Also:

    • CFG_LOGGING

      public static final String CFG_LOGGING
      The key for setting the Boolean to enable logging for this RuleSession.
      See Also:

    • CFG_DMS

      @Deprecated public static final String CFG_DMS
      Deprecated.
      The key for setting the Boolean to enable DMS for this RuleSession.
      See Also:

    • CFG_APP_NAME

      public static final String CFG_APP_NAME
      See Also:

    • CFG_WATCH

      public static final String CFG_WATCH
      The key for specifying the watch options at RuleSession instantiation. The available watch options are defined as WATCH_xx constants. Multiple options may be configured by or'ng them together. For example:
      Integer watchConfig = Integer.valueOf(RuleSession.WATCH_RULES | RuleSession.WATCH_FACTS); configMap.put(RuleSession.CFG_WATCH, watchConfig);
      These options are restored by the built-in reset function.
      See Also:

    • WATCH_RULES

      public static final int WATCH_RULES
      Watch rules fire.
      See Also:

    • WATCH_ACTIVATIONS

      public static final int WATCH_ACTIVATIONS
      Watch the addition or removal of activations from the agenda.
      See Also:

    • WATCH_FACTS

      public static final int WATCH_FACTS
      Watch the assertion, retraction, or modification of facts in working memory.
      See Also:

    • WATCH_FOCUS

      public static final int WATCH_FOCUS
      Watch ruleset stack changes.
      See Also:

    • WATCH_COMPILATIONS

      public static final int WATCH_COMPILATIONS
      Watch rule compilation into the Rete network.
      See Also:

    • WATCH_ALL

      public static final int WATCH_ALL
      Watch all rule engine activity.
      See Also:

    • CFG_DECISION_TRACE_LEVEL

      public static final String CFG_DECISION_TRACE_LEVEL
      The key for specifying the decision trace level at RuleSession instantiation.
      See Also:

    • DECISION_TRACE_OFF

      public static final int DECISION_TRACE_OFF
      The decision trace level that disables decision tracing.
      See Also:

    • DECISION_TRACE_PRODUCTION

      public static final int DECISION_TRACE_PRODUCTION
      The decision trace level for use in production. Rules fired and fact operations are traced. Fact properties are not included in the trace.
      See Also:

    • DECISION_TRACE_DEVELOPMENT

      public static final int DECISION_TRACE_DEVELOPMENT
      The decision trace level to use for debugging or more detailed tracing. Full decision tracing equivalent to invoking WATCH_ALL plus tracing invocations of the reset function.
      See Also:

    • CFG_DECISION_TRACE_LIMIT

      public static final String CFG_DECISION_TRACE_LIMIT
      The key for specifying the decision trace limit at RuleSession instantiation.
      See Also:

    • CFG_ALGORITHM

      public static final String CFG_ALGORITHM
      The key for choosing the rule evaluation algorithm at RuleSession instantiation. Currently there are two choices, ALGORITHM_RETE and ALGORITHM_NRE. The default is ALGORITHM_RETE.
      See Also:

    • ALGORITHM_RETE

      public static final int ALGORITHM_RETE
      See Also:

    • ALGORITHM_NRE

      public static final int ALGORITHM_NRE
      See Also:

    • CFG_GENERATE_BYTE_CODE

      public static final String CFG_GENERATE_BYTE_CODE
      The key for explicit control of byte code generation for the Non-Rete algorithm (NRE). The default is true.
      See Also:

    • CFG_ALLOW_ERROR_SUPPRESSION

      public static final String CFG_ALLOW_ERROR_SUPPRESSION
      The key for setting the Boolean to allow error suppression support for this RuleSession. The default is true which allows the setErrorInRuleConditionSuppressed() built-in function to control whether errors in rule conditions are suppressed. The default is that error suppression is not enabled and the setting of this configuration parameter does not change that default.

      Setting this parameter to false in conjunction with the selection of the Non-Rete algorithm will result in additional memory usage savings. If the parameter is set to false, an invocation of setErrorInRuleConditionSuppressed() that attempts to enable error suppression will throw an exception.

      See Also:

    • RL_LOGGER

      public static final String RL_LOGGER
      See Also:

    • ASSERT_LOG_PROPERTY

      public static final String ASSERT_LOG_PROPERTY
      See Also:

    • ASSERT_TREE_LOG_PROPERTY

      public static final String ASSERT_TREE_LOG_PROPERTY
      See Also:

    • RETRACT_LOG_PROPERTY

      public static final String RETRACT_LOG_PROPERTY
      See Also:

    • GET_FACTS_BY_TYPE_LOG_PROPERTY

      public static final String GET_FACTS_BY_TYPE_LOG_PROPERTY
      See Also:

    • logBuffer

      public static Map<String,List<RuleSession.LogEntry>> logBuffer

  • Constructor Details

    • RuleSession

      public RuleSession(Map config) throws RLException
      Construct a new RuleSession, containing a Rete Engine and Working Memory.
      Parameters:
      config - session configuration parameters
      Throws:
      RLException

    • RuleSession

      public RuleSession() throws RLException
      Construct a new RuleSession, containing a Rete Engine and Working Memory. Use default locale.
      Throws:
      RLException

    • RuleSession

      public RuleSession(List<String> rlList, Map config) throws RLException
      Construct a new RuleSession, containing a Rete Engine and Working Memory. If the list of RL, rlList, is not null, the RuleSession is initialized with the RL in the list and then frozen. A RuleSession that has been frozen does not allow executeRuleset to be invoked.
      Parameters:
      rlList - an optional list of RL text
      config - session configuration parameters
      Throws:
      RLException

    • RuleSession

      public RuleSession(RuleSession peer) throws RLException
      Throws:
      RLException

  • Method Details

    • getOutputWriter

      public Writer getOutputWriter()
      Get the writer used by RL println, show, and watch functions.
      Returns:
      Writer

    • setOutputWriter

      public void setOutputWriter(Writer w)
      Set the writer used by RL println, show, and watch functions. Default is System.out. Default is used for new and deserialized RuleSessions.
      Parameters:
      w - Writer to set

    • getName

      public String getName()
      Get the name associated with this rule session.
      Returns:
      rule session name

    • getRulesetName

      public String getRulesetName()
      Get the name of the implicit ruleset for top level definitions (default is "main").
      Returns:
      ruleset name

    • setRulesetName

      public void setRulesetName(String n)
      Set the name of the implicit ruleset for top level definitions (default is "main").
      Parameters:
      n - the implicit ruleset name

    • getLocale

      public Locale getLocale()
      Get the Locale for the rule session.
      Returns:
      Locale

    • executeRuleset

      public void executeRuleset(String rulesetString) throws RLException
      Execute the ruleset
      Parameters:
      rulesetString - String containing ruleset text
      Throws:
      RLException

    • executeRuleset

      public void executeRuleset(Reader rulesetReader) throws RLException
      Execute the ruleset
      Parameters:
      rulesetReader - Reader containing ruleset text
      Throws:
      RLException

    • callFunction

      public Object callFunction(String functionName) throws RLException
      Execute the RL function with no arguments, returning result.
      Parameters:
      functionName - name of RL function, optionally ruleset-qualified
      Returns:
      Object result of RL function
      Throws:
      RLException

    • callFunctionWithArgument

      public Object callFunctionWithArgument(String functionName, Object arg) throws RLException
      Execute the RL function with one argument, returning result.
      Parameters:
      functionName - name of RL function, optionally ruleset-qualified
      arg - Object to pass to function
      Returns:
      Object result of RL function
      Throws:
      RLException

    • callFunctionWithArgumentArray

      public Object callFunctionWithArgumentArray(String functionName, Object[] args) throws RLException
      Execute the RL function with given array arguments, returning result.
      Parameters:
      functionName - name of RL function, optionally ruleset-qualified
      args - array of arguments to pass to function
      Returns:
      Object result of RL function
      Throws:
      RLException

    • callFunctionWithArguments

      public Object callFunctionWithArguments(String functionName, Object... args) throws RLException
      Execute the RL function with given arguments, returning result.
      Parameters:
      functionName - name of RL function, optionally ruleset-qualified
      args - vararg arguments to pass to function
      Returns:
      Object result of RL function
      Throws:
      RLException

    • callFunctionWithArgumentList

      public Object callFunctionWithArgumentList(String functionName, List args) throws RLException
      Execute the RL function with given list of arguments, returning result.
      Parameters:
      functionName - name of RL function, optionally ruleset-qualified
      args - list to pass to function
      Returns:
      Object result of RL function
      Throws:
      RLException

    • assertTree

      public Object assertTree(Object root) throws RLException
      Asserts as facts objects from an object tree. Objects in the tree are asserted according to relationships that have been defined for the object's class or a class in its inheritancy graph. This form is intended only for use with RL generated from the oracle.rules.sdk2 rules SDK.
      Parameters:
      root - the root of the object tree.
      Returns:
      the root of the tree.
      Throws:
      RLException - if an error occurs asserting the object tree

    • addLogEntry

      public void addLogEntry(Object root, List args, String property, RuleSession.LogEntry.Status status, String errorMessage, StackTraceElement[] errorStack)

    • assertTree

      public Object assertTree(String spec, Object root) throws RLException
      Asserts as facts objects from an object tree. The spec argument is a colon separated list of package names and controls which objects are asserted. If an object in the tree is in one of the packages in the list, it will be asserted and assertTree will recurse over its bean properties.
      Parameters:
      spec - a list of colon separated packages.
      root - the root of the object tree.
      Returns:
      the root of the tree.
      Throws:
      RLException - if an error occurs asserting the object tree

    • parseRuleset

      public RuleSession.ParsedRulesetInfo parseRuleset(String rulesetString) throws RLException
      Parse and return info about the given ruleset. Info includes JAXB parse tree, names and definitions for all classes, functions, and variables organized by ruleset, and java classes appearing in fact context in this ruleset, organized by package.
      Returns:
      ParsedRulesetInfo
      Throws:
      RLException

    • parseRuleset

      public RuleSession.ParsedRulesetInfo parseRuleset(Reader rulesetReader) throws RLException
      Throws:
      RLException

    • getFactObjects

      public Iterator getFactObjects()
      Get an Iterator over the objects that have been asserted as facts in working memory.
      Returns:
      the iterator over objects in working memory.

    • getFactObjects

      public Iterator getFactObjects(ObjectFilter filter)
      Get an Iterator over the objects in working memory that pass the specified filter.
      Returns:
      the iterator over objects in working memory that pass the specified filter.

    • getFactIds

      public Iterator getFactIds()
      Get an Iterator over the fact IDs for the objects that have been asserted as facts in working memory. Each fact ID (an int, is wrapped in an Integer.
      Returns:
      Iterator

    • getRuleset

      public Ruleset getRuleset(String name)
      Returns the Ruleset for the ruleset with the specified name.
      Parameters:
      name - the ruleset name.
      Returns:
      the Ruleset for the ruleset with the specified name.

    • getRulesets

      public Map<String,Ruleset> getRulesets()
      Returns a Map containig a String,Ruleset key,value pair for each ruleset defined in this RuleSession.
      Returns:
      the Map of Ruleset's.

    • getVariable

      public Object getVariable(String name) throws RLException
      Returns the value of the specified RL global variable. The name must be fully qualified.
      Returns:
      the value of the specified RL global variable.
      Throws:
      RLException - if no such global variable exists.

    • setVariable

      public void setVariable(String name, Object value) throws RLException
      Sets the value of the specified RL global variable. The name must be fully qualified.
      Throws:
      RLException - if no such global variable exists or if the specified value can not be assigned to the variable.

    • isValid

      public boolean isValid()
      Returns true if this RuleSession is valid. Returns false if the RuleSession has encountered an error and should no longer be used.

    • setIsValid

      public void setIsValid(boolean valid)

    • isFrozen

      public boolean isFrozen()
      Returns true if this RuleSession has been completely defined from a List of RL text. If a RuleSession is frozen, attempts to invoke executeRuleset will throw an exception.

    • isSafeToHavePeers

      public boolean isSafeToHavePeers()

    • hasPeers

      public boolean hasPeers()

    • getLogger

      public Logger getLogger()

    • getClassFilter

      public ClassFilter getClassFilter(String className) throws RLException
      Throws:
      RLException

    • internTypeType

      public oracle.rules.rl.xml.TypeType internTypeType(oracle.rules.rl.xml.TypeType tt)

    • getStackTrace

      public static String getStackTrace(Throwable e)