Package oracle.rules.sdk2.decisiontable

Class Bucket

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent<T>
oracle.rules.sdk2.datamodel.ModelComponent<Bucket>
oracle.rules.sdk2.decisiontable.Bucket
All Implemented Interfaces:
Serializable, Cloneable, Comparable, Map<String,Object>, ExpressionContext
public class Bucket extends ModelComponent<Bucket> implements Comparable, ExpressionContext
A Bucket defines an atomic value for a Dimension of a decision table. A Bucket is always contained in a BucketSet. The FORM of a Bucket is stored as a BucketSet property. A FORM_LOV Bucket stores its value in its NAME property. A FORM_RANGE Bucket has 2 properties to get/set:
  • minEndpoint is the String representation of the lower end of the range
  • included is the boolean flag indicating whether the endpoint is included in the range
The name property of a range bucket is not settable or stored. It is constructed from the bucket and the next bucket properties.

Bucket comparison simply uses the ordering of the Buckets in the parent table. In this way, bucket lists in the dimension nodes will be ordered as per their bucket set.

See Also:

  • Method Details

    • isRange

      public boolean isRange()

    • getExpressionProperty

      public DictionaryProperty<Expression> getExpressionProperty()
      Get Expression Property
      Returns:
      Expression DictionaryProperty

    • getExpression

      public Expression getExpression()
      Get the Expression associated with the bucket. The Expression is constant. It stores the minimum endpoint of the range, or the value in a LOV bucketset. The name of this bucket will be updated with a string representing the value of this bucketset when update is called on the dictionary or validate is called on this bucket's parent bucketset.
      Returns:
      Expresson

    • getIncludedProperty

      public SettableProperty<Boolean> getIncludedProperty()
      Get Included Property.
      Returns:
      Boolean SettableProperty

    • isIncluded

      public boolean isIncluded()
      Is Endpoint Included
      Returns:
      flag indicating whether endpoint is included in bucket

    • setIncluded

      public void setIncluded(boolean included)
      Set Endpoint Included flag
      Parameters:
      included - - The INCLUDED flag

    • getOtherwiseProperty

      public SettableProperty<Boolean> getOtherwiseProperty()
      Get Otherwise Property. Do not use the setValue method.
      Returns:
      Boolean SettableProperty

    • isOtherwise

      public boolean isOtherwise()
      Is this the special "otherwise" bucket?
      Returns:
      boolean flag

    • getExcludedProperty

      public SettableProperty<Boolean> getExcludedProperty()
      Get Excluded Property.
      Returns:
      Boolean SettableProperty

    • isExcluded

      public boolean isExcluded()
      Is this bucket excluded from the bucket set?
      Returns:
      boolean flag

    • setExcluded

      public void setExcluded(boolean flag)
      Set whether or not to exclude this bucket
      Parameters:
      flag - whether or not to exclude

    • isRemovable

      public boolean isRemovable()
      Is this bucket removable?
      Returns:
      boolean flag

    • validate

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

    • getPropertyNames

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

    • getStoredPropertyNames

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

    • compareTo

      public int compareTo(Object o)
      Specified by:
      compareTo in interface Comparable

    • 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 DictionaryComponent<Bucket>
      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

    • getMatchTypeIDs

      public DOID[] getMatchTypeIDs(Expression e)
      Description copied from interface: ExpressionContext
      A child calls this method in the parent to see if the data type is appropriate for the context of the parent. Example, in the expression x == y, the Expression y asks its parent the type of x and the operator used between the two
      Specified by:
      getMatchTypeIDs in interface ExpressionContext

    • getMatchOp

      public String getMatchOp(Expression e)
      Description copied from interface: ExpressionContext
      A child calls this method in the parent to see if the data type is appropriate for the context of the parent. Example, in the expression x == y, the Expression y asks its parent the type of x and the operator used between the two
      Specified by:
      getMatchOp in interface ExpressionContext

    • isValueRequired

      public boolean isValueRequired(Expression e)
      Description copied from interface: ExpressionContext
      A child calls this method in the parent to see if it must have a value != ""
      Specified by:
      isValueRequired in interface ExpressionContext

    • getName

      public String getName()
      Get name of Bucket. Range Buckets have names like (3..10].
      Overrides:
      getName in class DictionaryComponent<Bucket>
      Returns:
      the name of the bucket.

    • init

      public Bucket init(boolean translate)
      Description copied from class: DictionaryComponent
      initialize the dictionary component to default values for name/alias. The defaults are locale sensitive, and the translated alias is also set according to the argument flag E.g. Rule newRule = ruleTable.add().init(true).
      Overrides:
      init in class DictionaryComponent<Bucket>
      Returns:
      this

    • init

      public Bucket init()
      initialize the bucket to default values. E.g. Bucket newBucket = bucketTable.add().init().
      Overrides:
      init in class DictionaryComponent<Bucket>
      Returns:
      this

    • 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 DictionaryComponent<Bucket>
      Parameters:
      key - a String containing the property name to be fetched.
      Returns:
      the value corresponding to the key: a String, String[], DictionaryComponent, DictionaryComponentTable, etc.

    • isDefaultAlias

      public boolean isDefaultAlias()
      Is this a default bucket alias? These are not translated.

    • getDiffMatchValue

      public String getDiffMatchValue()
      Overrides:
      getDiffMatchValue in class DictionaryComponent<Bucket>
      Returns:
      the value to use for matching components in tables, default is name