Package oracle.rules.sdk2.decisiontable

Class DimensionNode

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent<T>
oracle.rules.sdk2.ruleset.RuleComponent<T>
oracle.rules.sdk2.ruleset.UnnamedRuleComponent<DimensionNode>
oracle.rules.sdk2.decisiontable.DimensionNode
All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>, UnnamedComponent, VariableScope
public class DimensionNode extends UnnamedRuleComponent<DimensionNode>
A DimensionNode stores the dimension values for a "cell" in the decision table. A DimensionNode references one or more buckets from its Dimension's BucketSet.

A DimensionNode's parent can be either a Dimension or a DTRule. We call these nodes dimDNs and ruleDNs. In effect, Dimension nodes are duplicated, but the number of dimDNs is often less that the number of ruleDNs, because the dimDNs form a tree. A dimDN references its parent (a DimensionNode in the previous Dimension) and references its children using an IDTable<DimensionNode> containing dimDNs in the next Dimension in the dimension tree.

DimensionNodes with multiple buckets can be split into sibling nodes each with a single bucket. In an unordered rulesheet, dimDNs with multiple children can be split into sibling nodes each with a single child.

Sibling nodes can be merged by merging their bucket values and their children. The children are ordered by bucket value and duplicates are recursively merged, down to and including the action nodes. Sibling nodes can also be compacted. Compaction will not merge unequal action nodes. In an unordered rulesheet, nodes in the same dimension and in a contiguous range of rules can be merged by replacement with a single dimension node with merged bucket values and concatenated child lists.

In an ordered rulesheet, Dimension nodes are sorted according the the order of buckets in their bucketset. Don't know (?) sorts low. Don't care (-) sorts high. Single values sort lower than multi-values, e.g. 1 is less than 1,2 is less than 2.

See Also:

  • Field Details

  • Method Details

    • getDimDN

      public DimensionNode getDimDN()

    • getBucketSet

      public BucketSet getBucketSet()
      Get BucketSet. DimensionNode always shows the Dimension BucketSet in its picklist
      Returns:
      BucketSet of this DimensionNode's Dimension

    • getBuckets

      public IDTable<Bucket> getBuckets()
      Get DimensionNode Buckets. An empty table denotes ALL buckets (i.e. "don't care", denoted "-")
      Returns:
      IDTable<Bucket> table of buckets denoted by this DimensionNode

    • getValuesProperty

      public DimensionNode.ValuesProperty getValuesProperty()
      Get Values Property
      Returns:
      ValuesProperty

    • getValues

      public String[] getValues()
      Get dimension values of DimensionNode. values are names of buckets.
      Returns:
      dimension values

    • getValueOptions

      public String[] getValueOptions()

    • getValuesFromString

      public String[] getValuesFromString(String values)
      Parse possibly multiple values from comma separated string
      Parameters:
      values -
      Returns:
      String[] of existing bucket aliases

    • getValuesFromString

      public String[] getValuesFromString(String values, boolean translate)
      Parse possibly multiple values from comma separated string
      Parameters:
      values -
      Returns:
      String[] of existing bucket aliases

    • getValuesFromString

      public void getValuesFromString(String values, List<String> existingValues, List<String> newValues)
      Parse possibly multiple values from comma separated string
      Parameters:
      values -
      existingValues - returned existing bucket aliases
      newValues - returned new bucket aliases

    • getValuesFromString

      public void getValuesFromString(String values, List<String> existingValues, List<String> newValues, boolean translate)
      Parse possibly multiple values from comma separated string. The values can have combined ranges. ExistingValues do not.
      Parameters:
      values -
      existingValues - return existing bucket aliases
      newValues - return new bucket aliases
      translate - use translated values

    • getValuesAsString

      public String getValuesAsString(String[] values)
      Get possibly multiple values as a comma separated String
      Parameters:
      values -
      Returns:
      String

    • setValues

      public void setValues(String... values)
      Set dimension values of DimensionNode.
      Parameters:
      values - names of buckets

    • getSelected

      public int[] getSelected()

    • getDimension

      public Dimension getDimension()
      Get Dimension to which this DimensionNode belongs.
      Returns:
      dimension

    • getDimension

      public Dimension getDimension(boolean diff)
      Get Dimension to which this DimensionNode belongs.
      Parameters:
      diff - whether this DimensionNode is in the diff value
      Returns:
      dimension

    • getParentDimensionNode

      public DimensionNode getParentDimensionNode()
      Get parent DimensionNode, i.e., the node above this DimensionNode from the previous Dimension
      Returns:
      DimensionNode or null if first dimension or this is a node from the dimension node table of a rule

    • setParentDimensionNode

      public void setParentDimensionNode(DimensionNode parent)
      set parent DimensionNode
      Parameters:
      parent - TODO: validate correct Dimension

    • getChildDimensionNodes

      public IDTable<DimensionNode> getChildDimensionNodes()
      Get DimensionNode IDTable of child dimension nodes below this Dimension Node in the next Dimension. Last Dimension does not have child dimension nodes.
      Returns:
      DimensionNodeTable, empty if last Dimension or this is a node from the dimension node table of a rule

    • getChildActionNode

      @Deprecated public DTActionNode getChildActionNode()
      Deprecated.
      the returned DTActionNode is in the deprecated DTActionNodeTable of the first DTAction
      Get the child DTActionNode below this DimensionNode. This node must be in the last Dimension to have a child action node.
      Returns:
      DTActionNode or null if not last dimension or no actions

    • merge

      @Deprecated public void merge(boolean deep) throws SDKException
      Deprecated.
      use merge(), compact(), or span()
      Merge all child DimensionNodes, with or without merging actions.
      Throws:
      SDKException

    • merge

      public void merge()
      Merge all child DimensionNodes and actions.

    • compact

      public void compact()
      Merge all child DimensionNodes but do not merge non-identical actions.

    • span

      public void span()
      Span all child DimensionNodes (must have sameBucket).

    • merge

      public void merge(DimensionNode sibling)
      Merge with sibling DimensionNode. Siblings are merged by combining the dimension values from the sibling into this node, and coalescing combined children. If unordered, span the nodes -- nodes must be contiguous and have same buckets
      Parameters:
      sibling - the DimensionNode to merge with this
      See Also:

    • span

      public void span(DimensionNode next)
      Span DimensionNodes. Next must be next in its DimensionNodeTable and have sameBuckets
      Parameters:
      next - the DimensionNode to span with this
      Throws:
      IllegalArgumentException - if DT is ordered

    • canMerge

      public boolean canMerge(DimensionNode sibling)
      Test whether this node can be merged with its sibling. True iff the argument is a sibling of this node.
      Parameters:
      sibling -

    • canSpan

      public boolean canSpan(DimensionNode sibling)
      Test if this node and its sibling can be spanned. True iff the DT is not ordered, the argument is a sibling, the nodes are not in the last dimension, the nodes have the same buckets, and the nodes are adjacent.
      Parameters:
      sibling -

    • split

      public void split()
      split this DimensionNode into siblings such that this node and new siblings each have a single bucket value. All siblings have identical child nodes.

    • unspan

      public void unspan()
      split this DimensionNode into siblings such that each has one child. All siblings have identical buckets.
      Throws:
      IllegalArgumentException - if DT is ordered

    • canSplit

      public boolean canSplit()
      Test whether this node can be split

    • canUnspan

      public boolean canUnspan()
      Test whether this node can be unspanned. True iff it has more than one child DN and the DT is not ordered.
      Returns:

    • getPropertyNames

      public String[] getPropertyNames()
      Specified by:
      getPropertyNames in interface UnnamedComponent
      Overrides:
      getPropertyNames in class UnnamedRuleComponent<DimensionNode>
      Returns:
      Array of property names available.

    • getStoredPropertyNames

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

    • get

      public Object get(Object key)
      Description copied from class: DictionaryComponent
      Generic property getter.

      Please see the specific bean class for a list of properties.

      Specified by:
      get in interface Map<String,Object>
      Overrides:
      get in class UnnamedRuleComponent<DimensionNode>
      Parameters:
      key - a String containing the property name to be fetched.
      Returns:
      the value corresponding to the key: a String, String[], DictionaryComponent, DictionaryComponentTable, etc.

    • 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 UnnamedRuleComponent<DimensionNode>
      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

    • minRuleIndex

      public final int minRuleIndex()
      return minimum rule index of rules including this node.
      Returns:
      index

    • maxRuleIndex

      public final int maxRuleIndex()
      return maximum rule index of rules including this node.
      Returns:
      index

    • sameBuckets

      public boolean sameBuckets(DimensionNode dn)
      Does this node have the same buckets as the given node? If buckets are undefined, must also have same values.
      Parameters:
      dn - a dimension node
      Returns:
      boolean

    • validate

      public void validate(List<SDKException> errors, List<SDKWarning> warnings)
      Validate dimension node. Buckets must be contained in bucketset.
      Overrides:
      validate in class DictionaryComponent<DimensionNode>
      Parameters:
      errors -
      warnings -
      See Also:

    • removeActionlessRules

      public boolean removeActionlessRules()
      Remove rules that include this dimension node with no actions selected
      Returns:
      whether rules were removed

    • forceSync

      public void forceSync()
      Overrides:
      forceSync in class DictionaryComponent<DimensionNode>

    • inScopeVariables

      public List<ScopedVariable> inScopeVariables(boolean includeAggregates, VariableScope.ExprLocation loc)
      Description copied from class: RuleComponent
      By default, pass the request to the container
      Specified by:
      inScopeVariables in interface VariableScope
      Overrides:
      inScopeVariables in class RuleComponent<DimensionNode>