Package oracle.rules.sdk2.decisiontable

Class RuleSheet

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent<T>
oracle.rules.sdk2.ruleset.RuleComponent<T>
oracle.rules.sdk2.ruleset.RuleBase<T>
oracle.rules.sdk2.ruleset.RuleCommon<RuleSheet>
oracle.rules.sdk2.decisiontable.RuleSheet
All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>, ActionContext, AutoBindingContext, VariableScope
public class RuleSheet extends RuleCommon<RuleSheet>
A RuleSheet represents a decision table. A RuleSheet provides model support for authoring a set of related rules. The rules share a common PatternTable, Dimensions, and DTActions. The PatternTable selects the fact type(s) for the decision table. Dimensions are the common part of rule conditions shared by all rules, typically a fact property such as "age". Each rule references a DimensionNode that contains one or more Buckets drawn from a Bucketset associated with the Dimension. The bucket value is combined with the Dimension to generate a rule condition, such as "age < 25". DTActions are the common part of actions, and may be parameterized.

Dimensions and DTActions can be reordered within the RuleSheet using DictionaryComponentTable.move(int,int,boolean) A RuleSheet may be flagged with "order rules by bucket". In this case, DTRules cannot be explicitly reordered. DTRules are ordered by the position of the DimensionNode Buckets in the containing Bucketset.

RuleSheet provides boolean properties to allow/disallow gaps and to automatically resolve conflicts by overriding subsuming rules. There is also a method to check for gaps findGaps()

A base priority can be defined so that all rules in the sheet will have priority greater than or equal to the base.

See Also:

  • Field Details

  • Constructor Details

    • RuleSheet

      public RuleSheet(DictionaryObject parent)
      Internal Use Only. Used by RuleSheetTable in ruleset pkg.

  • Method Details

    • getActions

      public List<Action> getActions()
      Specified by:
      getActions in class RuleBase<RuleSheet>

    • getDimensionTableProperty

      public TableProperty<Dimension> getDimensionTableProperty()
      Get DimensionTable Property
      Returns:
      Dimension TableProperty of the RuleSheet

    • getDimensionTable

      public DimensionTable getDimensionTable()
      Get DimensionTable
      Returns:
      DimensionTable of the RuleSheet

    • getDTActionTableProperty

      public TableProperty<DTAction> getDTActionTableProperty()
      Get DTActionTable Property
      Returns:
      DTAction TableProperty of the RuleSheet

    • getDTActionTable

      public DTActionTable getDTActionTable()
      Get DTActionTable
      Returns:
      DTActionTable of the RuleSheet

    • getActionTable

      public ActionTable getActionTable()

    • getDTRuleTableProperty

      public TableProperty<DTRule> getDTRuleTableProperty()
      Get DTRuleTable Property
      Returns:
      DTRule TableProperty of the RuleSheet

    • getDTRuleTable

      public DTRuleTable getDTRuleTable()
      Get DTRuleTable
      Returns:
      DTRuleTable of the RuleSheet

    • getOrderRulesByBucketProperty

      public SettableProperty<Boolean> getOrderRulesByBucketProperty()
      Get OrderRulesByBucket Property
      Returns:
      boolean SettableProperty

    • isOrderRulesByBucket

      public boolean isOrderRulesByBucket()
      whether rules in this DT are automatically ordered by bucket value
      Returns:
      boolean flag

    • setOrderRulesByBucket

      public void setOrderRulesByBucket(boolean flag)
      set whether rules in this DT are automatically ordered by bucket value
      Parameters:
      flag -

    • optimizeDimensionOrder

      public void optimizeDimensionOrder()
      Reorder Dimensions so that the DimensionNode tree has a "low" number of DimensionNodes. Finding the absolute minimum by brute force could be an expensive undertaking (d!) so instead we sort the dimensions by increasing number of distinct node values.

    • findGaps

      public List<Gap> findGaps()
      Find the Gaps (missing rules) in the decision table
      Returns:
      List of Gaps

    • merge

      @Deprecated public void merge(boolean deep) throws SDKException
      Deprecated.
      use compact()
      Merge all rules. To merge rules (and actions) along a single dimension such that dimension nodes have no siblings in that dimension, use Dimension.merge(). To merge all rules that share a DimensionNode (with choice of whether to merge actions), use DimensionNode.merge(boolean). To merge two sibling DimensionNodes into one with combined buckets, use DimensionNode.merge(DimensionNode).
      Parameters:
      deep - if false then a single rule will remain after the merge. If true then rules with identical action nodes will be merged. If there are no actions, then the deep flag is irrelevent.
      Throws:
      SDKException

    • compact

      public void compact()
      Compact all rules. Rules with identical action nodes will be merged. If there are no actions, then all rules are merged to 1.

    • span

      public void span()
      Span all contiguous dimension nodes with sameBuckets.

    • canSpan

      public boolean canSpan()
      Test whether the rulesheet can be spanned.

    • unspan

      public void unspan()
      Unspan all dimension nodes.

    • canUnspan

      public boolean canUnspan()
      Test whether the rulesheet can be unspanned.

    • merge

      @Deprecated public void merge(List<DimensionNode> nodes, boolean deep)
      Deprecated.
      use merge(List<DimensionNode>), compact(List<DimensionNode>), or span(List<DimensionNode>)
      merge the rules containing the listed nodes (which must be siblings). Merged rules will share a single dimension node with merged buckets from the list of nodes.
      Parameters:
      nodes - siblings to merge
      deep - whether to merge descendants of listed nodes that lead to the same actions or just merge the nodes but not their descendants. When not deep, different actions may be merged into an invalid DTActionNode.
      See Also:

    • merge

      public void merge(List<DimensionNode> nodes)
      Merge the dimension nodes. May delete rules and merge rule actions. Does nothing if nodes are not siblings
      Parameters:
      nodes -

    • span

      public void span(List<DimensionNode> nodes)
      Span the consecutive dimension nodes with sameBuckets.
      Parameters:
      nodes -

    • canSpan

      public boolean canSpan(List<DimensionNode> nodes)
      Test if any of the nodes can be spanned.
      Parameters:
      nodes -

    • compact

      public void compact(List<DimensionNode> nodes)
      Compact the dimension nodes. Nodes with same actions may be merged.
      Parameters:
      nodes -
      Throws:
      IllegalArgumentException - if nodes are not siblings

    • canMerge

      public boolean canMerge(List<DimensionNode> nodes)
      Test if nodes can be merged. True iff all nodes are siblings.
      Parameters:
      nodes -

    • split

      public void split() throws SDKException
      Split all nodes in all Dimensions into siblings such that each node has a single bucket value. After the split, the rule sheet may be very large, but will not have overlaps.
      Throws:
      SDKException

    • removeActionlessRules

      public boolean removeActionlessRules()
      Remove rules with no actions selected
      Returns:
      whether rules were removed

    • removeActionlessRules

      public boolean removeActionlessRules(int minRuleIndex, int maxRuleIndex)
      Remove rules with index between minRuleIndex and maxRuleIndex inclusive with no actions selected
      Returns:
      whether rules were removed

    • getStoredPropertyNames

      public String[] getStoredPropertyNames()
      Overrides:
      getStoredPropertyNames in class RuleCommon<RuleSheet>
      Returns:
      Array of property names which are persisted in the order in which they appear in the schema.

    • getPropertyNames

      public String[] getPropertyNames()
      Overrides:
      getPropertyNames in class RuleCommon<RuleSheet>
      Returns:
      Array of property names available.

    • validate

      public void validate(List<SDKException> errors, List<SDKWarning> warnings)
      Description copied from class: RuleCommon
      Validate and return errors and warnings
      Overrides:
      validate in class RuleCommon<RuleSheet>
      Parameters:
      errors - a List of error exceptions to append to.
      warnings - a List of warning exceptions to append to.
      See Also:

    • validate

      @Deprecated public void validate(List<SDKException> errors, List<SDKWarning> warnings, int modelChangeLowerBound)
      Deprecated.
      Overrides:
      validate in class DictionaryObject

    • validate

      public void validate(List<SDKException> errors, List<SDKWarning> warnings, int modelChangeLowerBound, int ruleChangeLowerBound)
      Validate and return errors and warnings
      Overrides:
      validate in class DictionaryObject
      Parameters:
      errors - a List of error exceptions to append to.
      warnings - a List of warning exceptions to append to.
      modelChangeLowerBound - smallest ModelComponent.CreationUpdateNumber modified in thix tx.
      ruleChangeLowerBound - smallest RuleComponent.CreationUpdateNumber modified in thix tx. Rulesets and rules with UpdateNumber >= modelChangeLowerBound will be revalidated. a value of 0 will force revalidation of all rulesets. A value of Integer.MAX_VALUE will skip validation of all rulesets.

    • getAllowGapsProperty

      public SettableProperty<Boolean> getAllowGapsProperty()
      Get AllowGaps Property.
      Returns:
      boolean SettableProperty

    • isAllowGaps

      public boolean isAllowGaps()
      Are gaps allowed during validation?
      Returns:
      boolean flag

    • setAllowGaps

      public void setAllowGaps(boolean flag)
      set whether gaps are allowed during validation
      Parameters:
      flag -

    • getConflictPolicyProperty

      public TranslatedProperty getConflictPolicyProperty()
      Get Conflict Policy Property. Options are "manual", "auto override", and "ignore"
      Returns:
      String SettableProperty

    • isAutoConflictResolution

      @Deprecated public boolean isAutoConflictResolution()
      Deprecated.
      use getConflictPolicyProperty() and test if the value is CONFLICT_AUTO_OVERRIDE
      whether conflicts where ruleX's condition subsumes ruleY's condition are resolved automatically by ruleY overriding ruleX
      Returns:
      boolean flag

    • setAutoConflictResolution

      @Deprecated public void setAutoConflictResolution(boolean flag)
      Deprecated.
      use getConflictPolicyProperty() and set the value to CONFLICT_AUTO_OVERRIDE or CONFLICT_MANUAL
      set whether conflicts are resolved automatically.
      Parameters:
      flag -
      See Also:

    • hasNoConflict

      public boolean hasNoConflict()
      whether the decision table has any conflicts resolved as "no conflict"
      Returns:
      boolean flag

    • hasOverride

      public boolean hasOverride()
      whether the decision table has any conflicts resolved as override
      Returns:
      boolean flag

    • hasRunBefore

      public boolean hasRunBefore()
      whether the decision table has any conflicts resolved as "run before"
      Returns:
      boolean flag

    • hasConflict

      public boolean hasConflict()
      whether the decision table has any unresolved conflicts
      Overrides:
      hasConflict in class DictionaryComponent<RuleSheet>
      Returns:
      boolean flag

    • put

      public Object put(String key, Object value)
      Description copied from class: DictionaryComponent
      Generic property setter. Throws runtime exceptions for incorrect arguments. Please see the specific bean class for a list of properties, their types, and permissible values.

      A put() with either null key or null value throws a NullPointerException.

      A put() with a key that is not a String throws a ClassCastException

      A put() of a value that is not of the correct type for the key throws a ClassCastException.

      Bean properties which have no set() method are read only, and cannot be modified using the put(). Attempting to do so throws a runtime IllegalArgumentException. PROP_ID, and PROP_*_SELECTED are always read only.

      Specified by:
      put in interface Map<String,Object>
      Overrides:
      put in class RuleCommon<RuleSheet>
      Parameters:
      key - the key of the property to set
      value - the value of the named property to set
      Returns:
      the previous value of the property

    • getVerticalOrientationProperty

      public SettableProperty<Boolean> getVerticalOrientationProperty()
      Get Vertical Orientation Property
      Returns:
      Boolean SettableProperty

    • isVerticalOrientation

      public boolean isVerticalOrientation()
      Get Rule Orientation in Decision Table
      Returns:
      boolean orientation, true if vertical otherwise false

    • SetVerticalOrientation

      public void SetVerticalOrientation(boolean isVertical)
      Set whether Rule Orientation in Decision Table is Vertical or Horizontal
      Parameters:
      isVertical - is true if vertical and false otherwise