Package oracle.rules.sdk2.dictionary

Interface DictionaryFinder

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractDictionaryFinder, DecisionPointDictionaryFinder
public interface DictionaryFinder extends Serializable
A RuleDictionary uses a DictionaryFinder to access linked dictionaries. The RuleDictionary implementation will call the findDictionary(String,String) method very often (at least once per RuleDictionary.update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>)). Therefore, the findDictionary implementation MUST CACHE the last returned RuleDictionary, and continue to return the cached value unless the underlying RuleDictionary file or edit buffer changes. Change detection is up to the implementation. If it is cheap, findDictionary can poll the underlying file or edit buffer. If the underlying file or edit buffer supports change notification, then the dictionary finder should register to receive change notifications and clear the cache. In an editing environment with several editors open on different dictionaries, findDictionary(java.lang.String, java.lang.String) should load its RuleDictionary from the editor's RuleDictionary using RuleDictionary.createHandle()). This way, editors will be able to see each others changes in a coordinated way. Implementations of DictionaryFinder should extend AbstractDictionaryFinder, implementing findDictionaryWithThisFinder and override other methods as necessary to support use with DictionaryLoader.
See Also:

  • Field Details

  • Method Details

    • findDictionary

      RuleDictionary findDictionary(String pkg, String name)
      Find a dictionary given a fully qualified package name and a name within the package.
      Parameters:
      pkg - fully qualified package name, e.g. foo.bar
      name - unqualified name, e.g. MyDic
      Returns:
      RuleDictionary

    • findDictionary

      RuleDictionary findDictionary(DictionaryFQN fqn)
      Find a dictionary given a fully qualified name
      Parameters:
      fqn - DictionaryFQN
      Returns:
      RuleDictionary

    • findDictionary

      RuleDictionary findDictionary(String path)
      Find a dictionary given a logical, system independent path.
      Parameters:
      path - the path used to find the dictionary
      Returns:
      RuleDictionary

    • close

      void close()
      Close this finder to release held resources.