Oracle Fusion Middleware Java API Reference for Oracle Business Rules
11g Release 1 (11.1.1.7)

E10663-11

oracle.rules.sdk2.decisiontable
Class Bucket

java.lang.Object
  extended by oracle.rules.sdk2.dictionary.DictionaryObject
      extended by oracle.rules.sdk2.dictionary.DictionaryComponent
          extended by oracle.rules.sdk2.datamodel.ModelComponent
              extended by oracle.rules.sdk2.decisiontable.Bucket
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, java.util.Map<java.lang.String,java.lang.Object>

public class Bucket
extends ModelComponent
implements java.lang.Comparable

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:

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:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent
DictionaryComponent.Diff, DictionaryComponent.DiffType
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Field Summary
 
Fields inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent
PROP_ACCESS, PROP_ACTION_SELECTED, PROP_ACTION_TABLE, PROP_ACTIVE, PROP_ADVANCED_MODE, PROP_AGGREGATE, PROP_AGGREGATE_TABLE, PROP_ALIAS, PROP_ALLOW_GAPS, PROP_ALWAYS_SELECTED, PROP_ARRAY, PROP_ARRAY_COMPONENT_TYPE, PROP_ARRAY_COMPONENT_TYPE_ID, PROP_ARRAY_FACT_TYPE_TABLE, PROP_AUTO_CONFLICT_RESOLUTION, PROP_AUTO_PATTERN_PROPERTY, PROP_BODY, PROP_BUCKET_ID_TABLE, PROP_BUCKET_SET, PROP_BUCKET_SET_ID, PROP_BUCKET_SET_TABLE, PROP_BUCKET_TABLE, PROP_CALENDAR_FORM, PROP_CHECK_RULE_FLOW, PROP_CHILD_DIMENSION_NODES, PROP_CONFLICT, PROP_CONFLICT_POLICY, PROP_CONNECTIVE, PROP_CONSTANT, PROP_CONSTRUCTOR, PROP_CONSTRUCTOR_TABLE, PROP_CREATION_UPDATE_NUMBER, PROP_CURSOR_POSITION, PROP_CUSTOM_BINDING, PROP_CUSTOMIZABLE, PROP_CUSTOMIZABLE_TEMPLATE, PROP_DATA_MODEL, PROP_DATA_SOURCE, PROP_DECISION_FUNCTION, PROP_DECISION_FUNCTION_INPUT_TABLE, PROP_DECISION_FUNCTION_OUTPUT_TABLE, PROP_DECISION_FUNCTION_RULESET_TABLE, PROP_DECISION_FUNCTION_TABLE, PROP_DESCRIPTION, PROP_DICTIONARY_LINK_TABLE, PROP_DIMENSION_NODE_TABLE, PROP_DIMENSION_TABLE, PROP_DT_ACTION_NODE_TABLE, PROP_DT_ACTION_PARAMETER_NAME, PROP_DTACTION_TABLE, PROP_DTRULE_TABLE, PROP_EFFECTIVE_END_DATE, PROP_EFFECTIVE_START_DATE, PROP_ENUM, PROP_ENUM_BUCKET_SET, PROP_ENUM_BUCKET_SET_ID, PROP_ENUM_TYPE, PROP_EXCEPTION_IDS, PROP_EXCEPTIONS, PROP_EXCLUDED, PROP_EXPRESSION, PROP_EXPRESSION_TABLE, PROP_FACT_PATH, PROP_FACT_PATH_IDS, PROP_FACT_TYPE, PROP_FACT_TYPE_ID, PROP_FACT_TYPE_TABLE, PROP_FIELD_TABLE, PROP_FINAL, PROP_FORM, PROP_FORMAL_PARAMETER_TABLE, PROP_FUNCTION, PROP_FUNCTION_ID, PROP_FUNCTION_SIGNATURE, PROP_FUNCTION_TABLE, PROP_GENERATED_FROM, PROP_ID, PROP_INCLUDED, PROP_INTERFACE, PROP_INTERFACE_IDS, PROP_INTERFACES, PROP_IS_ABSTRACT, PROP_IS_CONSTANT, PROP_IS_ENUM, PROP_IS_FINAL, PROP_IS_JAXB2, PROP_IS_PRIMARY_KEY, PROP_IS_STATIC, PROP_IS_TOPLEVEL_VIEW_OBJECT, PROP_LEFT, PROP_LIFECYCLE, PROP_LIFECYCLE_DESCRIPTION, PROP_LIST, PROP_LIST_CONTENT_TYPE, PROP_LIST_CONTENT_TYPE_ID, PROP_LOCAL, PROP_LOGICAL, PROP_METHOD_TABLE, PROP_MODIFIERS, PROP_NAME, PROP_NAMESPACE, PROP_NESTED_TABLE, PROP_NO_CONFLICT, PROP_NODE_NAME, PROP_OPERATOR, PROP_OPERATOR_ID, PROP_ORDER_RULES_BY_BUCKET, PROP_OTHERWISE, PROP_OUTPUT_TYPES, PROP_OVERLOADED_PARAMETER_TABLE, PROP_OVERRIDDEN_BY, PROP_OVERRIDE, PROP_PACKAGE, PROP_PARAMETER_ALIAS, PROP_PARAMETER_ID, PROP_PARAMETER_LIST, PROP_PARAMETER_NAME, PROP_PARAMETER_REQUIRED, PROP_PARAMETER_TYPE_IDS, PROP_PARAMETER_TYPES, PROP_PARENT_DIMENSION_NODE, PROP_PATTERN_TABLE, PROP_PREFIX_LINKED_NAMES, PROP_PRIORITY, PROP_PRIVATE_BUCKET_SET, PROP_PROPERTIES, PROP_PROPERTY_TABLE, PROP_READABLE, PROP_REF_ID, PROP_REPORT_BYUSE_NAMES, PROP_REPORT_PATTERNS, PROP_RESOLVED_TARGET, PROP_RESOLVED_VALUE, PROP_RESOURCE_BUNDLE, PROP_RETURN_TYPE, PROP_RIGHT, PROP_RIGHT_SEPARATOR, PROP_RULE_FIRING_LIMIT, PROP_RULE_FIRING_LIMIT_ERROR, PROP_RULE_REPORT_TABLE, PROP_RULE_SET_TABLE, PROP_RULE_SHEET_TABLE, PROP_RULE_TABLE, PROP_RULESET, PROP_RUN_AFTER, PROP_RUN_BEFORE, PROP_SERVICE_CONFIGURATION, PROP_SERVICE_NAME, PROP_SERVICE_NAMESPACE, PROP_SHARED_BUCKET_SET, PROP_SHARED_BUCKET_SET_ID, PROP_SHOW_CONSTANTS, PROP_SHOW_FUNCTIONS, PROP_SHOW_VARIABLES, PROP_SIMPLE_TEST_TABLE, PROP_SOURCE, PROP_STATELESS, PROP_STATIC, PROP_SUPER_CLASS, PROP_SUPER_CLASS_ID, PROP_SUPPORT_XPATH, PROP_SUPPORTS_XPATH_ENABLED, PROP_SYSTEM, PROP_TARGET, PROP_TARGET_PACKAGE, PROP_TEST_FORM, PROP_TIMESTAMP, PROP_TOKEN_UNDER_CURSOR, PROP_TRANSLATED_ALIAS, PROP_TRANSLATED_DESCRIPTION, PROP_TRANSLATED_PARAMETER_LIST, PROP_TRANSLATED_VARIABLE, PROP_TREE, PROP_TREE_MODE, PROP_TYPE, PROP_TYPE_ID, PROP_TYPE_IDS, PROP_TYPES, PROP_UNSAVED_TRANSLATED_ALIAS, PROP_UNSAVED_TRANSLATED_DESCRIPTION, PROP_UPDATE_NUMBER, PROP_UPDATE_TIME, PROP_VALIDATION_UPDATE_NUMBER, PROP_VALUE, PROP_VALUES, PROP_VARIABLE, PROP_VARIABLE_TABLE, PROP_VERSION, PROP_VISIBILITY_FILTER, PROP_VISIBILITY_FILTER_ENABLED, PROP_VISIBLE, PROP_WEB_SERVICE, PROP_WRITABLE, PROP_XML_NAME
 
Method Summary
 int compareTo(java.lang.Object o)
           
 java.lang.String getAlias(boolean translate)
          Get alias of DictionaryComponent.
 SettableProperty<java.lang.Boolean> getExcludedProperty()
          Get Excluded Property.
 Expression getExpression()
          Get the Expression associated with the bucket.
 DictionaryProperty<Expression> getExpressionProperty()
          Get Expression Property
 SettableProperty<java.lang.Boolean> getIncludedProperty()
          Get Included Property.
 java.lang.String getName()
          Get name of Bucket.
 SettableProperty<java.lang.Boolean> getOtherwiseProperty()
          Get Otherwise Property.
 Bucket init()
          initialize the bucket to default values.
 Bucket init(boolean translate)
          initialize the dictionary component to default values for name/alias.
 boolean isExcluded()
          Is this bucket excluded from the bucket set?
 boolean isIncluded()
          Is Endpoint Included
 boolean isOtherwise()
          Is this the special "otherwise" bucket?
 boolean isRange()
           
 boolean isRemovable()
          Is this bucket removable?
 void setExcluded(boolean flag)
          Set whether or not to exclude this bucket
 void setIncluded(boolean included)
          Set Endpoint Included flag
 
Methods inherited from class oracle.rules.sdk2.datamodel.ModelComponent
getParent, getParentTable, getVisibleProperty, isVisible, setVisible
 
Methods inherited from class oracle.rules.sdk2.dictionary.DictionaryComponent
clear, containsKey, containsValue, entrySet, get, getAlias, getAlias, getAlias, getAliasProperty, getAllReferences, getCustom, getDependents, getDescription, getDescription, getDescriptionProperty, getDiff, getDiffProperties, getDiffs, getFullyQualifiedAlias, getFullyQualifiedName, getIndex, getIndex, getNameProperty, getNext, getObjectPath, getOptions, getPrevious, getProperties, getProperty, getReferences, getSelected, getTranslatedAlias, getTranslatedAlias, getTranslatedDescription, hasDiff, isAliasDistinct, isEmpty, isFullyQualifiedName, isNameDistinct, isSystemProperty, isUnsavedTranslatedAlias, isUnsavedTranslatedDescription, keySet, put, putAll, remove, setAlias, setAlias, setCustom, setDescription, setDescription, setName, setTranslatedAlias, setTranslatedDescription, size, validate, validate, values
 
Methods inherited from class oracle.rules.sdk2.dictionary.DictionaryObject
equals, exists, getAEReferences, getCombinedDataModel, getContainedIDs, getContainedIDs, getDataModel, getDictionary, getID, getIndent, getLevel, getObjectType, getParentByClass, getParentComponent, getParentComponentTable, getParentObject, getRuleSet, getState, getWarnings, hashCode, isModified, validate
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Method Detail

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<java.lang.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<java.lang.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<java.lang.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

compareTo

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

getName

public java.lang.String getName()
Get name of Bucket. Range Buckets have names like (3..10].

Overrides:
getName in class DictionaryComponent
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
Returns:
this

init

public Bucket init()
initialize the bucket to default values. E.g. Bucket newBucket = bucketTable.add().init().

Overrides:
init in class DictionaryComponent
Returns:
this

getAlias

public java.lang.String getAlias(boolean translate)
Description copied from class: DictionaryComponent
Get alias of DictionaryComponent.

Overrides:
getAlias in class DictionaryComponent
Parameters:
translate - whether to get the translated alias
Returns:
translated alias of the dictionary component, or alias if translation does not exist

Oracle Fusion Middleware Java API Reference for Oracle Business Rules
11g Release 1 (11.1.1.7)

E10663-11

Copyright © 2013, Oracle and/or its affiliates. All rights reserved.