Package oracle.rules.sdk2.ruleset

Class RuleComponent<T extends RuleComponent>

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent<T>
oracle.rules.sdk2.ruleset.RuleComponent<T>
All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>, VariableScope
Direct Known Subclasses:
RuleBase, RuleSet, UnnamedRuleComponent
public abstract class RuleComponent<T extends RuleComponent> extends DictionaryComponent<T> implements VariableScope
RuleComponent is an Abstract Class which enables access to properties through generic accessors by extending HashMap.

The generic get and set can also be used to set additional custom properties which will be stored with the rule component when it is serialized (comments for example). A custom property value must be a String. To avoid collisions, its name must end with "Custom" (@see Util#CUSTOM).

For String property named X, there are corresponding properties 

    getX()                    return the value of X
    get ("X")

    setX ("myValue")          assign "myValue" to X
    put ("X", "myValue")

    getXOptions()             return a String array of option choices
    get("X" + Util.OPTIONS)
    getOptions("X")

    setXOptions(myOptionArray) set the options array, overrides SDK setting
    put ("X" + Util.OPTIONS, myOptionArray)

    getXSelected()            return index of selection in options Array
    get("X" + Util.SELECTED)  (cannot be set)
    getSelected ("X")

    getXConstraint()          return name of data model constraint on X
    get("X" + Util.CONSTRAINT)
    getConstraint ("X")

    setXConstraint("Cname")   return name of data model constraint on X
    set("X" + Util.CONSTRAINT, "Cname")

See Also:

  • Field Details

    • BUILTIN

      public static final String BUILTIN
      name of Choice folder containing builtin tests and aggregates
      See Also:

  • Method Details

    • get

      public RuleComponent get(String tableName, int index)
      Returns the RuleComponent at the given index from the named RuleComponentTable. Shorthand for: 
          (RuleComponent)(((RuleComponentTable)(get ("myTable"))).get(i));
      Parameters:
      tableName - a String property which must be the name of a RuleComponentTable
      index - of the requested RuleComponent
      Returns:
      the RuleComponent at the requested index

    • getParent

      public RuleComponent getParent()
      Get parent RuleComponent Object
      Returns:
      The parent RuleComponent Object

    • getParentTable

      public RuleComponentTable getParentTable()
      Get parent RuleComponentTable Object
      Returns:
      The parent RuleComponentTable Object

    • getParentVariableScope

      public VariableScope getParentVariableScope()
      Get the parent VariableScope
      Returns:
      The parent VariableScope if exists, else null

    • parentActionContext

      public ActionContext parentActionContext()

    • parentAutoBindingContext

      public AutoBindingContext parentAutoBindingContext()

    • parentFunction

      public Function parentFunction()

    • parentRuleBase

      public RuleBase parentRuleBase()

    • parentRuleCommon

      public RuleCommon parentRuleCommon()

    • parentRule

      public Rule parentRule()

    • parentVerbalRule

      public VerbalRule parentVerbalRule()

    • parentRuleSheet

      public RuleSheet parentRuleSheet()

    • parentAction

      public Action parentAction()

    • parentVariable

      public Variable parentVariable()

    • parentPattern

      public Pattern parentPattern()

    • parentTest

      public SimpleTest parentTest()

    • RHSRuleVariables

      public List<ScopedVariable> RHSRuleVariables(boolean includeAggregates)
      Return all rule variables available to the Action of a rule By default, Delegate to the Parent Rule

    • inScopeVariables

      public List<ScopedVariable> inScopeVariables(boolean includeAggregates, VariableScope.ExprLocation loc)
      By default, pass the request to the container
      Specified by:
      inScopeVariables in interface VariableScope

    • inScopeVariables

      public List<ScopedVariable> inScopeVariables()

    • toString

      public void toString(StringBuilder sb, String indent)

    • toString

      public String toString()
      Overrides:
      toString in class Object