Package oracle.rules.sdk2.dictionary

Class DictionaryObject

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
DictionaryComponent, DictionaryComponentTable, IDTable
public abstract class DictionaryObject extends Object implements Cloneable, Serializable
Base class for a RuleDictionary and its components and component tables.
See Also:

  • Method Details

    • equals

      public boolean equals(Object o)
      Handles for the same DictionaryObject are equal.
      Overrides:
      equals in class Object
      Parameters:
      o - object to test for equality
      Returns:
      true if o is a handle for the same DictionaryObject as this

    • hashCode

      public int hashCode()
      Handles for the same DictionaryObject have the same hash code
      Overrides:
      hashCode in class Object
      Returns:
      hash code

    • getAEReferences

      public abstract List<DOID> getAEReferences()
      Get DOIDs referenced by this Object and descendants. By convention, properties of type DOID and DOID[] are not considered. This basically makes this useful for finding DOIDs referenced in IDTables and in Expressions and Actions. Note that a parent contains its children but (usually) does not reference them.
      Returns:
      list of the DOIDs

    • getAEReferenceCount

      public final Map<DOID,Integer> getAEReferenceCount()
      Get the number of references for each unique DOID in all directly or indirectly contained actions and expressions

    • getAllReferences

      public abstract List<DOID> getAllReferences()
      Get all DOIDs referenced by this Object and descendants.
      Returns:
      list of the DOIDs

    • getReferences

      public List<DOID> getReferences()
      Get all DOIDs referenced by this Component and IDTable properties, but does not include contained dictionary components.
      Returns:
      list of the DOIDs

    • getExprParserReferences

      public abstract List<ExprParser> getExprParserReferences()
      Get all ExprParsers that are directly or Indirectly referenced by this dictionary Object and its descendants
      Returns:
      Collection of Expression Parsers

    • getParentObject

      public DictionaryObject getParentObject()
      Get the immediate parent object
      Returns:
      immediate DictionaryObject parent

    • getID

      public DOID getID()
      Get dictionary object ID. An ID is an identifier for the object. It is invariant across transactions. For components the ID is persistent and thus invariant across saves/loads from disk. For component tables, the ID is not persistent.
      Returns:
      ID String

    • _clearID

      public void _clearID()
      Expert Use!

      call this before setID(oracle.rules.sdk2.dictionary.DOID) to prevent setID from clearing the old id.

    • setID

      public void setID(DOID id)
      Set ID of the dictionary object. Expert Use Only! Used internally to assign constant IDs to builtin dictionary objects.
      Parameters:
      id - New ID.

    • exists

      public final boolean exists()
      obj.exists() means you can reach obj if you start with the dictionary and recursively explore all references. The RuleDictionary.update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) method actually updates a cache that exists uses to make it fast.
      Returns:
      false if this object no longer exists in the dictionary as of the last update.

    • getDictionary

      public final RuleDictionary getDictionary()
      Get the dictionary that contains this component.
      Returns:
      containing RuleDictionary

    • getParentByClass

      public DictionaryObject getParentByClass(Class pclass)
      search the parent chain for an object that correspondes to specified type.

    • getDataModel

      public DataModel getDataModel()
      Get the data model for the containing dictionary
      Returns:
      DataModel

    • getCombinedDataModel

      public CombinedDataModel getCombinedDataModel()
      get the combined data model from containing dictionary and linked dictionaries
      Returns:
      CombinedDataModel

    • getRuleSet

      public RuleSet getRuleSet()
      Get the RuleSet containing this dictionary object.
      Returns:
      containing RuleSet or null if this is not in a RuleSet or is not a RuleSet

    • validate

      public void validate(List<SDKException> errors, List<SDKWarning> warnings, int modelChangeLowerBound, int ruleChangeLowerBound)
      Validate the RuleDictionary object. Append error and warning exceptions. Errors will cause RuleDictionary.update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) to throw an exception. A dictionary with warnings but no errors can be persisted.
      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.

    • validate

      @Deprecated public void validate(List<SDKException> errors, List<SDKWarning> warnings, int modelChangeLowerBound)
      Deprecated.
      Use validate(List,List)

    • validate

      public abstract void validate(List<SDKException> errors, List<SDKWarning> warnings)
      Validate the entire dictionary object and its decendants. Not incremental.
      Parameters:
      errors - a List of error exceptions to append to.
      warnings - a List of warning exceptions to append to.
      See Also:

    • getParentComponent

      public DictionaryComponent getParentComponent()
      get parent dictionary component
      Returns:
      DictionaryComponent parent

    • getParentComponentTable

      public DictionaryComponentTable getParentComponentTable()
      get parent dictionary component table
      Returns:
      DictionaryComponentTable parent

    • getObjectType

      public String getObjectType()
      get the translated name of the type of this dictionary object.
      Returns:
      the translated name of the dictionary object (e.g. Variable, Rules, etc.)

    • getObjectPath

      public String getObjectPath()
      get the localized path to this object starting with the dictionary, e.g. Dictionary(myDic)/Rule Set(rs1)/Decision Table(myDT)
      Returns:
      localized path to this object

    • getContainedIDs

      public Set<DOID> getContainedIDs()
      Get the ID of this object and all objects that it contains, recursively.
      Returns:
      set of ID strings

    • getContainedIDs

      public Set<DOID> getContainedIDs(Set<DOID> addedIDs)

    • getWarnings

      public List<SDKWarning> getWarnings(boolean includeDescendants)
      get Warnings associated with this dictionary object or its descendants. Note that no validation is performed. Only a subset of warnings from the last RuleDictionary.update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) are returned.
      Parameters:
      includeDescendants - whether to include warnings bound to this object's descendants.
      Returns:
      list of warnings

    • getIndent

      public String getIndent()

    • isModified

      public boolean isModified()

    • getState

      public int getState()