Package oracle.rules.sdk2.decisiontable

Class BucketSet

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent<T>
oracle.rules.sdk2.datamodel.ModelComponent<T>
oracle.rules.sdk2.datamodel.TypedComponent<BucketSet>
oracle.rules.sdk2.decisiontable.BucketSet
All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>
public class BucketSet extends TypedComponent<BucketSet>
A BucketSet is the set of values in a Dimension of a decision table. BucketSets have a type that must be the same as that of values that are contained in the buckets. The type must be a primitive, String, or Calendar. Note that these types are all Comparable. There are three forms of BucketSet:
  • enumerated list of values (FORM_LOV).
  • a list of value ranges (FORM_RANGE). Ranges are determined by storing their endpoint values.
  • default based on datatype (FORM_DEFAULT). Numeric and Calendar types are assumed to be range. Other types (boolean and string) are assumed to be LOV. See isRange()

A BucketSet is always associated with every Dimension in a decision table. Each DimensionNode in the Dimension takes its values from this BucketSet. To facilitate reuse of BucketSets, a BucketSet can be named and stored in the RuleDictionary data model. In addition, class Properties, class Methods, and Functions can be associated with a named BucketSet (if their types are equal). In this way, a dimension in a decision table whose dimension expression is a property, method call, or function call can automatically be assigned a BucketSet, and thus the choice lists for the DimensionNodes will be populated with the predefined buckets.

If there is no predefined BucketSet, then a local BucketSet will be built up dynamically as new buckets are entered into the DimensionNodes. If new buckets are added to a Dimension that has a predefined BucketSet, a dialog should ask the user whether the intent is to update the named BucketSet in the data model or to make a private updated copy associated with the Dimension.

A BucketSet contains Buckets in a BucketTable. A LOV BucketSet has Buckets with a single String value (if the BucketSet type is not String, the toString method (or Dates.toISO8601{Date,Time,DateTime} methods) is used to convert to String). By default, an initial Bucket with special value "otherwise" is created that is distinct from all other bucket values. This bucket matches all values that have no other bucket. The otherwise bucket may not be deleted but may be excluded. If this bucket is excluded then the semantics of "don't care" change to "match any bucket" but DON'T match a value that is not represented by a Bucket.

A RANGE BucketSet has Buckets that store the String value of the lesser-valued endpoint of the subrange (as per Comparable) . The Bucket also contains a boolean indicating whether the endpoint is included in the range (and thus excluded from the previous range). The first Bucket stores the empty string instead of the String value representing the minimum value (the minimum is never needed for comparison), its included flag is always true, and it may not be deleted. Similarly, the last Bucket stores its minimum endpoint but its maximum endpoint is not stored and is never needed.

In user choice lists and for quickly adding a new bucket to a range, a syntax that specifies one endpoint and an inequality may be used for the first and last bucket (e.g. <0, >=100). A syntax that specifies both endpoints and whether or not the endpoint is included may be used for the other buckets (e.g. [0..100) ).

See Also:

  • Field Details

  • Constructor Details

    • BucketSet

      public BucketSet(DictionaryObject parent)
      required by datamodel.BucketSet

  • Method Details

    • getFormProperty

      public TranslatedProperty getFormProperty()
      Get Form Property.
      Returns:
      TranslatedProperty

    • getForm

      public String getForm()
      Get value of Form property
      Returns:
      String

    • setForm

      public void setForm(String form)
      set the FORM to RANGE, LOV, or default based on data type.
      Parameters:
      form -

    • getFormOptions

      public String[] getFormOptions()

    • getFormSelected

      public int getFormSelected()

    • getCalendarFormProperty

      public TranslatedProperty getCalendarFormProperty()
      Get CalendarForm Property.
      Returns:
      TranslatedProperty

    • getCalendarForm

      public String getCalendarForm()
      Get Calendar Form value (Date, Time, or DateTime). Default is Date.
      Returns:
      String

    • setCalendarForm

      public void setCalendarForm(String form)

    • getCalendarFormOptions

      public String[] getCalendarFormOptions()

    • getCalendarFormSelected

      public int getCalendarFormSelected()

    • getTestExcludedBucketsProperty

      public SettableProperty<Boolean> getTestExcludedBucketsProperty()
      Get TestExcludedBuckets Property.
      Returns:
      Boolean SettableProperty

    • isTestExcludedBuckets

      public boolean isTestExcludedBuckets()
      should excluded bucket values be allowed in tests or DT condition cells?
      Returns:
      true or false

    • setTestExcludedBuckets

      public void setTestExcludedBuckets(boolean flag)
      should excluded bucket values be allowed in tests or DT condition cells?

    • getBucketTableProperty

      public TableProperty<Bucket> getBucketTableProperty()
      Get BucketTable Property.
      Returns:
      Bucket TableProperty

    • getBucketTable

      public BucketTable getBucketTable()
      Get BucketTable
      Returns:
      BucketTable of the BucketSet

    • getBuckets

      public List<Bucket> getBuckets()
      Get Buckets
      Returns:
      Buckets in the BucketSet that are not excluded from tests

    • add

      public Bucket add(String name) throws SDKException
      Add Bucket(s) by name. Name can be a value to add to a LOV, or the name of a range. If the name of a range, buckets are added (if needed) in correct order in BucketTable with (minEndpoint, included) property values as shown: 
       <v    adds (v, true)
 <=v   adds (v, false)
 >v    adds (v, false)
 >=v   adds (v, true)
 (v1..v2) adds (v1, false) and (v2, true) if v1 < v2
 [v1..v2) adds (v1, true) and (v2, true) if v1 < v2
 (v1..v2] adds (v1, false) and (v2, false) if v1 < v2
 [v1..v3] adds (v1, true) and (v3, false) if v1 <= v3
 =v       adds (v, true) and (v, false) 
 ==v      adds (v, true) and (v, false)
      Parameters:
      name - name of new bucket (value or range)
      Throws:
      SDKException - if v1 >= v2, v1 < v3, or v* cannot be parsed

    • add

      public Bucket add(String value, boolean included)
      Add Bucket to Range BucketSet in correct order in BucketTable
      Parameters:
      value - minEndpoint of range
      included - endpoint in range?
      Returns:
      null if not a range bucketset, or if value cannot be converted to a minEndpoint

    • remove

      public void remove(String name) throws SDKException
      Remove buckets by name. For LOV BucketSet, simply remove named bucket. For Range BucketSet, parse the name for one or two endpoints as in add(String) and delete buckets between two endpoints, or less than or greater than one endpoint, including the endpoints or not according to name notation.
      Parameters:
      name - of bucket or bucket range
      Throws:
      SDKException - as per add(String)

    • remove

      public void remove(Comparable rMinEndpoint, boolean rMinIncluded, Comparable rMaxEndpoint, boolean rMaxIncluded)
      remove range buckets within range
      Parameters:
      rMinEndpoint - lower end of range
      rMinIncluded - is endpoint included in range
      rMaxEndpoint - upper end of range
      rMaxIncluded - is endpoint included in range

    • getValues

      public String[] getValues()
      Get the bucket set as an array of bucket names Excluded buckets are not shown.
      Returns:
      array of bucket names (values or ranges)

    • 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 TypedComponent<BucketSet>
      Parameters:
      errors - a List of error exceptions to append to.
      warnings - a List of warning exceptions to append to.
      See Also:

    • validate

      public void validate(List<SDKException> errors, List<SDKWarning> warnings, int modelChangeLowerBound, int ruleChangeLowerBound)
      Validate a bucket set. Assume containing Dimension's datatype if none assigned. Warn if data type is not string, primitive, or calendar. Warn if there is only one bucket (internal error if no buckets). Warn if more than one otherwise bucket
      Overrides:
      validate in class DictionaryObject
      Parameters:
      errors -
      warnings -
      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.

    • isRange

      public boolean isRange()
      is the bucketset a range bucketset?
      Returns:
      true if form is range or form is default and data type is numeric, date, or calendar.

    • getPropertyNames

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

    • getStoredPropertyNames

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

    • put

      public Object put(String key, Object value)
      Description copied from class: TypedComponent
      Override hashtable put method. For property "Type" and "ListContentType" we must sync the alias and ID
      Specified by:
      put in interface Map<String,Object>
      Overrides:
      put in class TypedComponent<BucketSet>
      Parameters:
      key - a String containing the property name to be saved.
      value - a String corresponding to the key to be saved
      Returns:
      the previous value of the property

    • hasOtherwise

      public boolean hasOtherwise()
      Does the bucketset contain an otherwise bucket?

    • hasExclusions

      public boolean hasExclusions()
      does the bucketset have excluded buckets?
      Returns:
      true or false

    • isCalendarType

      public boolean isCalendarType()
      Is the type of the bucketset Calendar? This is mainly used for determining if the Calendar Form should be displayed or set

    • getRL

      public boolean getRL(StringBuilder sb, Map<Object,Object> properties)
      interpackage getRL

    • getBooleanBucketSet

      public static BucketSet getBooleanBucketSet()

    • getChoices

      public static List<Choice> getChoices(DictionaryComponent dc, DOID typeID)
      Parameters:
      dc - any dictionary component in the top level dictionary
      typeID -
      Returns:
      choices of bucketsets that are type compatible with typeID

    • isExcluded

      public boolean isExcluded(DictionaryObject context, String constant, boolean test)

    • getOtherwise

      public Bucket getOtherwise()