Package oracle.rules.sdk2.repository

Class DictionaryFQN

java.lang.Object
oracle.rules.sdk2.repository.DictionaryFQN
All Implemented Interfaces:
Serializable, Comparable<DictionaryFQN>
public class DictionaryFQN extends Object implements Comparable<DictionaryFQN>, Serializable
The fully qualified name of a rule dictionary. It consists of the following properties:
  • a dictionary package and
  • a dictionary name.
The fully qualified dictionary name is used to store and retrieve a dictionary from a rule repository.

Each property must be a Unicode identifier as defined by the isUnicodeIdentifierStart and isUnicodeIdentifierPart methods in java.lang.Character.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    EXTENSION
    The extension used for rule dictionaries.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DictionaryFQN(String pkg, String name)
    Construct a fully qualified name of a dictionary.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    asPath()
    Returns the relative path representation of this fully qualified name.
    int
    compareTo(DictionaryFQN fqn)
    Compares this DictionaryFQN with the specified DictionaryFQN.
    static DictionaryFQN
    createDictionaryFQN(String pkg, String name)
    Create a fully qualified name of a dictionary.
    boolean
    equals(Object obj)
    Indicates whether this DictionaryFQN is equal to another object
    String
    getName()
    Returns the name of the dictionary
    String
    getPackage()
    Returns the dictionary package
    int
    hashCode()
    Returns the hash code for this fully qualified name.
    static boolean
    isNameValid(String name)
    Checks if the dictionary name is valid
    static boolean
    isPackageValid(String pkg)
    Checks if the dictionary package is valid
    String
    toString()
    Returns the string representation of this fully qualified name in the form package.name.
    void
    validateForAccess()
    Check validity of this fully qualified name for dictionary access.
    void
    validateForGetNames()
    Check validity of this fully qualified name for use with getNames.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • EXTENSION

      public static final String EXTENSION
      The extension used for rule dictionaries. This is used in constructing the relative path used to identify a dictionary in a repository.
      See Also:

  • Constructor Details

    • DictionaryFQN

      public DictionaryFQN(String pkg, String name)
      Construct a fully qualified name of a dictionary.
      Parameters:
      pkg - the dictionary package
      name - the dictionary name

  • Method Details

    • createDictionaryFQN

      public static DictionaryFQN createDictionaryFQN(String pkg, String name)
      Create a fully qualified name of a dictionary.
      Parameters:
      pkg - the dictionary package
      name - the dictionary name
      Returns:
      the fully qualified name.

    • asPath

      public String asPath()
      Returns the relative path representation of this fully qualified name. The path includes the extension ".rules" which is appended to the dictionary name. This represents the expected relative path of the dictionary in a file system or other hierarchical store.
      Returns:
      the relative path representation of this fully qualified name.

    • toString

      public String toString()
      Returns the string representation of this fully qualified name in the form package.name. The package may also contain multiple components separated by '.'.
      Overrides:
      toString in class Object
      Returns:
      the string representation

    • getPackage

      public String getPackage()
      Returns the dictionary package
      Returns:
      the dictionary package

    • getName

      public String getName()
      Returns the name of the dictionary
      Returns:
      the dictionary name

    • validateForAccess

      public void validateForAccess() throws InvalidFQNException
      Check validity of this fully qualified name for dictionary access.
      Throws:
      InvalidFQNException - if this fully qualified name is invalid

    • validateForGetNames

      public void validateForGetNames() throws InvalidFQNException
      Check validity of this fully qualified name for use with getNames.
      Throws:
      InvalidFQNException - if this fully qualified name is invalid

    • isPackageValid

      public static boolean isPackageValid(String pkg)
      Checks if the dictionary package is valid
      Parameters:
      pkg - the dictionary package to validate
      Returns:
      true if the dictionary package is valid, otherwise false

    • isNameValid

      public static boolean isNameValid(String name)
      Checks if the dictionary name is valid
      Parameters:
      name - the dictionary name to validate
      Returns:
      true if the dictionary name is valid, otherwise false

    • compareTo

      public int compareTo(DictionaryFQN fqn)
      Compares this DictionaryFQN with the specified DictionaryFQN. The value returned is the Comparable result of the String representations for each.
      Specified by:
      compareTo in interface Comparable<DictionaryFQN>

    • hashCode

      public int hashCode()
      Returns the hash code for this fully qualified name.
      Overrides:
      hashCode in class Object
      Returns:
      the hash code for this fully qualified name.

    • equals

      public boolean equals(Object obj)
      Indicates whether this DictionaryFQN is equal to another object
      Overrides:
      equals in class Object
      Returns:
      true if they are equal, else false.