Package oracle.rules.sdk2.dictionary

Class RuleDictionary

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject
oracle.rules.sdk2.dictionary.DictionaryComponent<T>
oracle.rules.sdk2.dictionary.DictionaryName<RuleDictionary>
oracle.rules.sdk2.dictionary.RuleDictionary
All Implemented Interfaces:
Serializable, Cloneable, Map<String,Object>
public class RuleDictionary extends DictionaryName<RuleDictionary>
The RuleDictionary class is used to access and modify a rule dictionary in memory. A rule dictionary contains a data model, rule sets, and links to other rule dictionaries.

RuleDictionary does not provide any concurrency properties. Multiple threads may access a single RuleDictionary instance, but each thread must use its own handle.

Transactions

A transaction consists of all changes made to DictionaryObjects in between invocations of update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>). Transactions can be undone and redone using the UndoableEdit instance returned from a call to update.

A handle can be created using the createHandle() method. An application would have a single RuleDictionary instance which was newly created or read from a persistent store. This is then shared among shared among different readers or writers by providing each with a RuleDictionary handle created from calling createHandle(). Note that both the instance and handles use the same RuleDictionary class. The changes in a transaction are stored in the local RuleDictionary handle and then moved to the shared RuleDictionary instance when update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) is called. Note:When multiple threads are modifying their handle, an SDKException will be thrown if update is called and another handle has called update since the current handle's last call to update.

It also means that an update may fail with a ConcurrentUpdateException if two updates happen nearly simultaneously. In either case, the transaction should be rolled back using rollback().

If concurrent editing is desired, it is recommended that applications implement their own concurrent editing semantics on top of the provided primitives. Take note that allowing truly concurrent editing is very difficult because users can make incompatible changes to a dictionary. In many cases, allowing exclusive access to only one writer at a time is easier to implement and easier to manage in practice.

Note that a thread that only reads from it's handle must periodically call rollback() or update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) in order to see the latest contents of the main dictionary(even though it has made no changes).

A transaction only covers updates to the main RuleDictionary instance. It does not cover saving the dictionary to a persistent store. In particular, do not save more than one in-memory rule dictionary to the same persistent store. The second save will overwrite the first.

Dictionary Links

Rule dictionaries can link to other rule dictionaries. These links allow a large dictionary to be partitioned into several smaller dictionaries. This affords reuse of a shared data model, or partitioning sensitive rules into a dictionary with stricter access control. For more information see DictionaryLink.

DictionaryObject references and removing DictionaryObjects from the Dictionary

The RuleDictionary is a container for the dictionary objects it contains, e.g., the getRuleSet(String) method returns a RuleSet object, and then RuleSet.getRuleByName(String) is a factory that returns a Rule object, and so forth.

DictionaryComponentTable implements List methods like remove. When a DictionaryObject is removed, subsequent attempts to access properties of the dictionary object will result in a RuntimeException.

Usage Examples

The following examples show how to use the RuleDictionary.

create a new rule dictionary in memory

 RuleDictionary dic = RuleDictionary.createDictionary("MyDic");

create a ruleset in the dictionary

The example assumes that multiple handles may be updating the Dictionary concurrently. Because the concurrency control is optimistic and does not use locks, the RuleDictionary users must be prepared to retry their updates. Below is a naive example of doing this, using a while(true) loop. 
 RuleDictionary.UndoableEdit undo = null;
 List warnings = new ArrayList();
 while (true) {
   RuleSet rs = dic.createEmptyRuleSet("newRuleSet");
   rs.setDescription("my favorite rules");
   try {
      undo = dic.update(warnings);
   }
   catch (ConcurrentUpdateException e) {
      dic.rollback();
      continue;
   }
   catch (SDKException e) {
      dic.rollback();
      continue;
   }
   break;
 }

Get a ruleset from the dictionary

Readers should begin with an update, commit, or rollback to ensure they see the latest dictionary updates. 
 UndoableEdit undo = dic.update(warnings); // even if we haven't modified the dictionary, update returns unresolved prior warnings...
 RuleSet rs = dic.getRuleSet("newRuleSet");
 assert rs != null;

Undo the addition of newRuleSet

 undo.undo();

The dictionary has no rulesets now

 dic.rollback(); // another way to sync up with the latest in-memory dictionary content
 RuleSet rs = dic.getRuleSet("newRuleSet");
 assert rs == null;
See Also:

  • Constructor Details

  • Method Details

    • getFTI

      public oracle.rules.sdk2.datamodel.impt.FactTypeImporter getFTI()

    • getChangeCount

      public int getChangeCount()

    • bumpChangeCount

      public void bumpChangeCount()

    • getAddedIDs

      public Set<DOID> getAddedIDs()

    • getRemovedIDs

      public Set<DOID> getRemovedIDs()

    • isCustomizationMode

      @Deprecated public boolean isCustomizationMode()
      Deprecated.
      no replacement

    • setCustomizationMode

      @Deprecated public void setCustomizationMode(boolean flag)
      Deprecated.
      no replacement

    • getPropertyNames

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

    • getStoredPropertyNames

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

    • getDictionaryFinder

      public DictionaryFinder getDictionaryFinder()
      get the finder for linked dictionaries
      Returns:
      DictionaryFinder

    • setDictionaryFinder

      public void setDictionaryFinder(DictionaryFinder finder)
      set the finder for linked dictionaries

    • getLocale

      public Locale getLocale()
      get the locale that was set for this dictionary. The locale controls nls specific behavior of any methods that return a language specific String (e.g., FunctionTemplates).

    • setLocale

      public void setLocale(Locale locale)
      set the locale. The locale controls which nls specific version of Strings and formatted numbers will be used

    • parseNumber

      public Number parseNumber(String value)
      Parse a number. If in double quotes, parse according to the dictionary Locale
      Parameters:
      value - to parse
      Returns:
      Number or null

    • formatNumber

      public String formatNumber(Number n)

    • getNumberFormat

      public NumberFormat getNumberFormat()
      Get the NumberFormat for this RuleDictionary instance. One could use this to change the decimal separator, e.g. if (dictionary.getNumberFormat() instanceof DecimalFormat) { DecimalFormat df = (DecimalFormat)dictionary.getNumberFormat(); DecimalFormatSymbols dfs = df.getDecimalFormatSymbols(); dfs.setDecimalSeparator(','); df.setDecimalFormatSymbols(dfs); }

      The number format will change when the dictionary locale is changed. Changes to decimal format symbols will be overwritten when the locale is changed.

      Returns:
      NumberFormat

    • getObjectByID

      public DictionaryObject getObjectByID(DOID id)
      Get dictionary object by its ID. Every DictionaryComponent has a persistent ID. DictionaryObjects have a temporary ID that is stable across transactions but not across save/load from file.

      If ID is global (starts with "G"), then linked dictionaries are searched as well. If ID is builtin (starts with "B"), then only the builtin dictionary is searched.

      Parameters:
      id - the ID of the DictionaryObject
      Returns:
      the Dictionary Object, or null if no object with the ID is in the dictionary

    • getContainedComponentByID

      public DictionaryComponent getContainedComponentByID(DOID id)
      Return dictionary component with given id if it exists in its parent component or table, else null. Useful if this component may have been removed from its parent in this tx
      Parameters:
      id -
      Returns:
      dictionary component, or null if no contained component with given id exists

    • _getObjectByID

      public DictionaryObject _getObjectByID(DOID id)
      lookup in local dictionary only. Most users should use #getObjectByIDbecause it will search linked dictionaries as well.
      Parameters:
      id - dictionary object id
      Returns:
      DictionaryObject with given id

    • getAliasByID

      public final String getAliasByID(DOID id)
      Get alias of DictionaryComponent by its ID. Prepends containing dictionary alias if not this. A null parameter will throw a NullPointerException.
      Parameters:
      id - String
      Returns:
      alias, or Java name if id does not map to DictionaryComponent and isJavaID, else ""

    • getAliasByID

      public final String getAliasByID(DOID id, boolean translate)
      Get (translated) alias by ID
      Parameters:
      id - of DictionaryComponent
      translate - flag
      Returns:
      alias, optionally translated, or Java name if that's all we have

    • getTranslatedAliasByID

      public final String getTranslatedAliasByID(DOID id)
      Get translated alias by ID
      Parameters:
      id - of DictionaryComponent
      Returns:
      translated alias or "" if none

    • getNameByID

      public String getNameByID(DOID id)
      Get name of DictionaryComponent by its ID. A null parameter will throw a NullPointerException.
      Parameters:
      id - String
      Returns:
      name, or "" if id does not map to DictionaryComponent

    • getFullyQualifiedNameByID

      public String getFullyQualifiedNameByID(DOID id)
      Get fully qualified name of DictionaryComponent by its ID. A null parameter will throw a NullPointerException
      Parameters:
      id - String
      Returns:
      name, or "" if id does not map to DictionaryComponent

    • readDictionary

      public static RuleDictionary readDictionary(Reader reader, DictionaryFinder finder) throws SDKException, IOException
      Read a RuleDictionary from a Reader.

      The content of the Reader should have been produced by a prior call to writeDictionary(java.io.Writer). Warning: The returned RuleDictionary has not been updated or validated, and therefore some information may be missing or incorrect. Most users should immediately invoke update(List) on the returned RuleDictionary.

      The Reader parameter should be configured to read the UTF-8 character set. For example, if the dictionary is being read from a file, a common construction would look like: 

           Reader reader = new BufferedReader( 
                       new InputStreamReader( 
                           new FileInputStream( 
                               new File(DICT_LOCATION)), "UTF-8"));

      This method does not close the Reader instance passed to it. It is the responsibility of the caller to close the Reader (typically in a finally block) to prevent a resource leak.

      Parameters:
      reader - containing a rule dictionary document
      finder - to find linked dictionaries
      Returns:
      RuleDictionary
      Throws:
      SDKException - if the dictionary can't be deserialized
      IOException - if can't read from Reader

    • convertPatternToSimpleTest

      public static void convertPatternToSimpleTest(RuleDictionary dictionary)
      Utility method to Iterate over the rule dictionary and convert any Rules having PatternTable to SimpleTest
      Parameters:
      dictionary -

    • createDictionary

      public static RuleDictionary createDictionary(String name, DictionaryFinder finder) throws SDKException
      Create a new rule dictionary.
      Parameters:
      name - dictionary name
      finder - finder for linked dictionaries
      Throws:
      SDKException

    • writeDictionary

      public void writeDictionary(Writer writer) throws SDKException, IOException
      Write a RuleDictionary to a Writer.

      Warning: Rule dictionaries containing validation warnings can be written, just as Java source files with compilation errors can be saved. It is the responsibility of user to ensure a dictionary is valid before it is deployed in an application.

      The Writer parameter should be configured to write the UTF-8 character set.

      For example, if the dictionary was to be written to the same file it was read from, a common construction would look like: 

           StringWriter swriter = new StringWriter();
     rd.writeDictionary(swriter);
     Writer writer = null;
     try {
         writer = new OutputStreamWriter(new FileOutputStream(new File(fileName)),"UTF-8");
         writer.write(swriter.toString());
     } finally {
         if (writer != null) try { writer.close(); } catch (IOException e) {}
     }

      Here we first write the dictionary to a StringWriter to ensure no SDKExceptions are thrown; If instead we first opened the File for writing and an SDKException was thrown, the file would have already been truncated on most platforms. With the above code, this will only happen if an IOException is thrown in the the call to write. If this method is to be used in production code, it is recommended that the user first makes a backup copy of the file before attempting to write to it in order to prevent losing the file if an IOException occurs.

      This method does not close the Writer instance passed to it. It is the responsibility of the caller to close the Writer (typically in a finally block) to prevent a resource leak.

      Parameters:
      writer - write the dictionary here
      Throws:
      SDKException - if the dictionary can't be serialized
      IOException - if can't write to writer

    • createHandle

      public RuleDictionary createHandle() throws SDKException
      Get a handle to access the dictionary. Every concurrent thread should have its own handle. Usually, there is only 1 concurrent thread, so this is not a frequently used method. If 2 or more concurrent threads, all but one should be read-only. A handle is a clone of the original dictionary.
      Returns:
      RuleDictionary
      Throws:
      SDKException - if the dictionary is invalid
      See Also:
      • clone()

    • getDictionaryDescription

      public String getDictionaryDescription()
      Get description of the dictionary.
      Returns:
      Description of the dictionary. "" if the dictionary does not have a description.

    • setDictionaryDescription

      public void setDictionaryDescription(String desc)
      Set description to the dictionary.
      Parameters:
      desc - description of the dictionary.

    • isTransactionInProgress

      public boolean isTransactionInProgress()
      Returns:
      true if a transaction is in progress (modifications have occurred)

    • assertNotInTransaction

      public void assertNotInTransaction()
      For internal use. Throws an IllegalStateException if a transaction is in progress.

    • update

      public UndoableEdit update(List<SDKWarning> exceptions) throws SDKException, ConcurrentUpdateException
      Update the RuleDictionary. If exceptions is not null, validation exceptions that can be tolerated in the dictionary are returned rather than thrown, and the update succeeds. The update is atomic. If exceptions are thrown, no updates are performed. Note that readers must call update() to see updates that occur after their first read.
      Parameters:
      exceptions - a List of exceptions to append to.
      Returns:
      UndoableEdit object that can be used to undo/redo the update.
      Throws:
      SDKException - if invalid and exceptions is null.
      ConcurrentUpdateException - if this dictionary version was updated by another thread.

    • _fire

      public void _fire(DictionaryChangeEvent event)

    • validate

      public void validate(List<SDKException> errors, List<SDKWarning> warnings, int modelChangeLowerBound, int ruleChangeLowerBound)
      Validate the dictionary by validating its contents. If the DataModel or DictionaryLinkTable is updated or had warnings from the previous validation, then the entire dictionary is validated. Else, only rulesets that were updated or had warnings are validated.
      Overrides:
      validate in class DictionaryObject
      Parameters:
      errors - List of errors returned
      warnings - List of warnings returned
      modelChangeLowerBound - GLB of CUNs of updated model components
      ruleChangeLowerBound - GLB of CUNs of updated rulesets

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

    • getDictionaries

      public List<RuleDictionary> getDictionaries()
      get this dictionary and all linked dictionaries. the main (builtin) dictionary is last.
      Returns:
      List of RuleDictionary

    • isPrefixLinkedNames

      public boolean isPrefixLinkedNames()

    • isLinked

      public boolean isLinked()

    • getDictionary

      public RuleDictionary getDictionary(String alias)
      Get Dictionary from all linked dictionaries by alias
      Parameters:
      alias - of dictionary
      Returns:
      RuleDictionary

    • getLinkedDictionaries

      public List<RuleDictionary> getLinkedDictionaries()
      get all linked dictionaries (recursively) but not this one. the main dictionary is last.
      Returns:
      List of RuleDictionary

    • getLinkedDictionaries

      public List<RuleDictionary> getLinkedDictionaries(boolean includeBuiltIn)
      get all linked dictionaries (recursively) but not this one.
      Parameters:
      includeBuiltIn - boolean flag to include/exclude the BuiltInDictionary
      Returns:
      List of RuleDictionaries

    • getDataModelProperty

      public DictionaryProperty<DataModel> getDataModelProperty()
      Get DataModel Property.
      Returns:
      DataModel DictionaryProperty

    • getDataModel

      public DataModel getDataModel()
      Get the datamodel from this dictionary.
      Overrides:
      getDataModel in class DictionaryObject
      Returns:
      DataModel

    • getTestModelProperty

      public DictionaryProperty<oracle.rules.sdk2.testmodel.TestModel> getTestModelProperty()
      Get TestModel Property.
      Returns:
      TestModel DictionaryProperty

    • getTestModel

      public oracle.rules.sdk2.testmodel.TestModel getTestModel()
      Get the testmodel from this dictionary.

    • getPreferencesProperty

      public DictionaryProperty<Preferences> getPreferencesProperty()
      Get Preferences Property.
      Returns:
      Preferences DictionaryProperty

    • getPreferences

      public Preferences getPreferences()
      Get the Preferences from this dictionary.

    • getCombinedDataModel

      public CombinedDataModel getCombinedDataModel()
      Get accessor for data model components in the combined dictionary DO NOT CACHE the result of this method across update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) calls.
      Overrides:
      getCombinedDataModel in class DictionaryObject
      Returns:
      CombinedDataModel

    • getCombinedTestModel

      public oracle.rules.sdk2.testmodel.CombinedTestModel getCombinedTestModel()
      Get accessor for test model components in the combined dictionary DO NOT CACHE the result of this method across update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) calls.
      Returns:
      CombinedTestModel

    • getCombinedDecisionModel

      public oracle.rules.sdk2.dmn.CombinedDecisionModel getCombinedDecisionModel()
      Get accessor for decision model components in the combined dictionary DO NOT CACHE the result of this method across update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) calls.
      Returns:
      CombinedDecisionModel

    • createEmptyRuleSet

      public RuleSet createEmptyRuleSet(String name)
      Create and return an empty RuleSet with the given name.
      Parameters:
      name - of ruleset to create
      Returns:
      new empty ruleset or null if ruleset already exists

    • getRuleSetAliases

      public List<String> getRuleSetAliases(boolean combined)
      Get a List of RuleSet Aliases that are currently stored in in the RuleDictionary.

      The list is ordered by Java String comparison.

      Parameters:
      combined - whether to get rule set aliases from linked dictionaries
      Returns:
      Array of RuleSet aliases

    • getRuleSets

      public List<RuleSet> getRuleSets(boolean combined)
      Get a List of RuleSets that are currently stored in in the RuleDictionary. If combined, then several dictionaries can contain a ruleset with the same alias. Only the first ruleset encountered is returned, so that all the returned rulesets have distinct aliases.

      The list is ordered by Java String comparison.

      Parameters:
      combined - whether to get rule sets from linked dictionaries
      Returns:
      List of RuleSets

    • getRuleSet

      public RuleSet getRuleSet(String alias)
      Get the ruleset by alias from this dictionary
      Parameters:
      alias - ruleset alias

    • getRuleSets

      public List<RuleSet> getRuleSets(String alias)
      Get the rulesets by alias from this dictionary and linked dictionaries.
      Parameters:
      alias - ruleset alias

    • getRuleSetTableProperty

      public TableProperty<RuleSet> getRuleSetTableProperty()
      Get RuleSetTable Property.
      Returns:
      RuleSet TableProperty

    • getRuleSetTable

      public RuleSetTable getRuleSetTable()
      Get the ruleset table.
      Returns:
      RuleSetTable

    • removeRuleSet

      public RuleSet removeRuleSet(String name)
      Remove ruleset by name.
      Parameters:
      name - ruleset to remove
      Returns:
      RuleSet removed

    • createDictionaryLink

      public DictionaryLink createDictionaryLink(String pkg, String name)
      Create a DictionaryLink and add it into the rule dictionary.
      Parameters:
      pkg - package of the linked dictionary
      name - name of the linked dictionary
      Returns:
      the newly created DictionaryLink

    • getDictionaryLink

      public DictionaryLink getDictionaryLink(String pkg, String name)
      Get the dictionary link by fully qualified name.
      Parameters:
      name - name

    • getDictionaryLink

      public DictionaryLink getDictionaryLink(String alias)
      Get the dictionary link by alias.
      Parameters:
      alias - dictionary link alias

    • getDictionaryLinkTableProperty

      public TableProperty<DictionaryLink> getDictionaryLinkTableProperty()
      Get DictionaryLinkTable Property.
      Returns:
      DictionaryLink TableProperty

    • getDictionaryLinkTable

      public DictionaryLinkTable getDictionaryLinkTable()
      Get the dictionary link table
      Returns:
      OptionsSetTable

    • removeDictionaryLink

      public DictionaryLink removeDictionaryLink(String alias)
      Remove dictionary link by name.
      Parameters:
      alias - of linked dictionary to remove
      Returns:
      RuleSet removed

    • getDictionaryLinkAliases

      public List<String> getDictionaryLinkAliases()
      Get a List of DictionaryLink Aliases that are currently stored in in the RuleDictionary (in-memory copy).
      Returns:
      List of DictionaryLink names

    • getDecisionModelProperty

      public DictionaryProperty<oracle.rules.sdk2.dmn.DecisionModel> getDecisionModelProperty()
      Get DecisionModel Property.
      Returns:
      DecisionModel DictionaryProperty

    • getDecisionModel

      public oracle.rules.sdk2.dmn.DecisionModel getDecisionModel()
      Get the DecisionModel table.
      Returns:
      DecisionModelTable

    • isValid

      public boolean isValid()
      is the dictionary valid?
      Returns:
      boolean result

    • dataModelRL

      public String dataModelRL() throws SDKException
      Generate the RL for the data model in this dictionary and in linked dictionaries. The RL will be contained in a rule set with the same name as the immediately containing dictionary. In order to execute a rule set from the dictionary, it is first necessary to execute the data model generated code first in the RuleSession.
      Returns:
      the RL for the data model rule set
      Throws:
      SDKException

    • ruleSetRL

      public String ruleSetRL(String alias) throws SDKException
      Generate the RL for the given rule set in this dictionary and in linked dictionaries. In order to execute a rule set from the dictionary, it is first necessary to execute the data model generated code first in the RuleSession.
      Parameters:
      alias - alias of the ruleSet for which to generate code
      Returns:
      the RL for the data model rule set
      Throws:
      SDKException

    • addDictionaryChangeListener

      public Object addDictionaryChangeListener(DictionaryChangeListener listener)
      Add a DictionaryChangeListener to receive notifications of dictionary changes via DictionaryChangeEvents.
      Parameters:
      listener - a DictionaryChangeListener
      Returns:
      always null

    • removeDictionaryChangeListener

      public Object removeDictionaryChangeListener(DictionaryChangeListener listener)
      Remove DictionaryChangeListener.
      Parameters:
      listener - a DictionaryChangeListener
      Returns:
      always null
      See Also:

    • rollback

      public void rollback()
      rollback the current update transaction. Discard any updated DictionaryObjects!

    • toDocument

      public Document toDocument() throws oracle.rules.sdk2.store.DocumentException, SDKException
      Internal use by repository
      Throws:
      oracle.rules.sdk2.store.DocumentException
      SDKException

    • initFromElement

      public void initFromElement(Element element) throws SDKException
      Internal use by repository
      Throws:
      SDKException

    • initFromElement

      public void initFromElement(Element element, boolean skipReplaceTempIDs) throws SDKException
      Internal use by repository
      Throws:
      SDKException

    • getUpdateNumber

      public int getUpdateNumber()

    • getBuiltinDictionary

      public static RuleDictionary getBuiltinDictionary()
      get builtin rule dictionary

    • _getBuiltinDictionary

      public static RuleDictionary _getBuiltinDictionary()
      get builtin rule dictionary during its initialization (expert use only)

    • getLifeCycle

      public String getLifeCycle()
      Get the dictionary life cycle
      Returns:
      the life cycle name

    • setLifeCycle

      public void setLifeCycle(String lifecycle)
      Set the dictionary life cycle
      Parameters:
      lifecycle - the life cycle

    • getLifeCycleDescription

      public String getLifeCycleDescription()
      Get the dictionary life cycle description
      Returns:
      the life cycle description

    • setLifeCycleDescription

      public void setLifeCycleDescription(String description)
      Set the dictionary life cycle description
      Parameters:
      description - the life cycle description

    • copyTo

      public void copyTo(RuleDictionary from)
      copy to this dictionary
      Parameters:
      from - dictionary to copy from

    • getResourceBundle

      public String getResourceBundle()
      Get the name of the user resource bundle for UserTranslatedPropertys. This is the first argument to ResourceBundle.getBundle(String,Locale) By convention, the name of the bundle is obtained from the dictionary name by appending 'Translations' to it
      Returns:
      name of bundle

    • setResourceBundle

      public void setResourceBundle(String name)
      Set the name of the user resource bundle for UserTranslatedPropertys. This is the first argument to ResourceBundle.getBundle(String,Locale) By convention, the name of the bundle is obtained from the dictionary name by appending 'Translations' to it Setting to "" turns off translation

    • resourceBundleChanged

      public void resourceBundleChanged()
      If the resource bundle file is changed, call this method, followed by update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>), to cause the SDK to re-read the bundle

    • getResourceBundleControl

      public ResourceBundle.Control getResourceBundleControl()
      Get the user resource bundle control for TranslatedPropertys. This is the third argument to ResourceBundle.getBundle(String,Locale,ResourceBundle.Control)
      Returns:
      name of bundle

    • setResourceBundleControl

      public void setResourceBundleControl(ResourceBundle.Control control)
      Set the user resource bundle control for TranslatedPropertys. This is the third argument to ResourceBundle.getBundle(String,Locale,ResourceBundle.Control)
      Parameters:
      control - must be serializable

    • getWarnings

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

    • getRuleSetOptions

      public String[] getRuleSetOptions()
      Get rulesets in dictionary (and linked dictionaries) as an option list
      Returns:
      String[] of ruleset names

    • getRuleSetInputTypeIDs

      public Collection<DOID> getRuleSetInputTypeIDs(String rsName)

    • getRuleSetInputTypeIDs

      public Collection<DOID> getRuleSetInputTypeIDs(String rsName, boolean activeOnly)

    • getRuleSetOutputTypeIDs

      public List<List<DOID>> getRuleSetOutputTypeIDs(String rsName)

    • getRuleSetOutputTypeIDs

      public List<List<DOID>> getRuleSetOutputTypeIDs(String rsName, boolean activeOnly)

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

    • getServiceName

      public String getServiceName()
      get name of decision service exposing this dictionary's decision functions
      Returns:
      String

    • setServiceName

      public void setServiceName(String sn)

    • getServiceNamespace

      public String getServiceNamespace()

    • setServiceNamespace

      public void setServiceNamespace(String sn)

    • getServiceConfiguration

      public String getServiceConfiguration()

    • setServiceConfiguration

      public void setServiceConfiguration(String sc)

    • processDecisionTrace

      public boolean processDecisionTrace(DecisionTrace trace)

    • processDecisionTrace

      public static boolean processDecisionTrace(DecisionTrace trace, RuleDictionary dict)

    • diff

      public DictionaryComponent.DiffSummary diff(RuleDictionary that, Object versionInfo)
      Compute the difference between this dictionary and that one, identified by versionInfo. Differences will be not be dynamically recomputed until reDiff()ed,
      Parameters:
      that - RuleDictionary
      versionInfo -
      See Also:

    • reDiff

      public void reDiff()
      Refresh diffs. Useful after a session of applyDiff from multiple versions.

    • isDiffMergeMode

      public boolean isDiffMergeMode()
      Get the mode for diff merge.
      Returns:
      true if dictionary is in diff-merge mode, or false if diff mode. diff-merge supports editing the base version and accepting changes from one or more versions. diff supports comparing the edited version with 1 prior version, and accepting/rejecting the edits.

    • setDiffMergeMode

      public void setDiffMergeMode(boolean merge)
      Set diff merge mode.
      Parameters:
      merge -
      See Also:

    • getSynopsis

      public String[][] getSynopsis()
      Get a synopsis of the dictionary contents. The synopsis is an array of pairs of strings. The first in the pair is a decision function name, and the second is a ruleset name. The decision function name may be blank (empty String).
      Returns:
      synopsis as array of pairs of Strings (String[][2])

    • getStringTranslator

      public StringTranslator getStringTranslator()
      Get translator for TranslatedProperty

    • getPropertyTranslator

      public PropertyTranslator getPropertyTranslator()
      Get translator for UserTranslatedProperty

    • isBuiltin

      public boolean isBuiltin()
      Returns:
      whether this is the builtin dictionary

    • getSaxHandler

      public static SaxHandler getSaxHandler(DictionaryFinder finder)
      Get a handler for SAX parser events. The handler may be used to parse a RuleDictionary and retrieve it using SaxHandler.getDictionary()
      Parameters:
      finder -
      Returns:
      SAX ContentHandler

    • getExporter

      public oracle.rules.sdk2.dictionary.exportimport.DictionaryExporter getExporter()
      Get the Exporter for this Dictionary
      Returns:
      Exporter instance that would support exporting from this Dictionary

    • getImporter

      public oracle.rules.sdk2.dictionary.exportimport.DictionaryImporter getImporter()
      Get the Importer for this Dictionary
      Returns:
      Importer instance that would support importing to this Dictionary

    • _update

      public void _update() throws SDKException, ConcurrentUpdateException
      Allow linked dictionaries to be updated.
      Throws:
      SDKException
      ConcurrentUpdateException

    • getMajorVersionNumber

      public int getMajorVersionNumber()
      Get major version number for software that created this dictionary. E.g. 11, 12
      Returns:

    • scanScopedVarsUsingAutoBindingContext

      public boolean scanScopedVarsUsingAutoBindingContext()

    • setScanScopedVarsUsingAutoBindingContext

      public void setScanScopedVarsUsingAutoBindingContext(boolean scanScopedVarsUsingAutoBindingContext)