oracle.rules.sdk2.repository
Class DictionaryFQN

java.lang.Object
  oracle.rules.sdk2.repository.DictionaryFQN

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DictionaryFQN>

public class DictionaryFQN
extends java.lang.Object
implements java.lang.Comparable<DictionaryFQN>, java.io.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:

Serialized Form

Field Summary

static java.lang.String

EXTENSION The extension used for rule dictionaries.

Constructor Summary

DictionaryFQN(java.lang.String pkg, java.lang.String name)
Construct a fully qualified name of a dictionary.

Method Summary

java.lang.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(java.lang.String pkg, java.lang.String name) Create a fully qualified name of a dictionary.
boolean	equals(java.lang.Object obj) Indicates whether this DictionaryFQN is equal to another object
java.lang.String	getName() Returns the name of the dictionary
java.lang.String	getPackage() Returns the dictionary package
static boolean	isNameValid(java.lang.String name) Checks if the dictionary name is valid
static boolean	isPackageValid(java.lang.String pkg) Checks if the dictionary package is valid
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, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXTENSION

public static final java.lang.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:

Constant Field Values

Constructor Detail

DictionaryFQN

public DictionaryFQN(java.lang.String pkg,
                     java.lang.String name)

Construct a fully qualified name of a dictionary.

Parameters:

pkg - the dictionary package

name - the dictionary name

Method Detail

createDictionaryFQN

public static DictionaryFQN createDictionaryFQN(java.lang.String pkg,
                                                java.lang.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 java.lang.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.

getPackage

public java.lang.String getPackage()

Returns the dictionary package

Returns:

the dictionary package

getName

public java.lang.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(java.lang.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(java.lang.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 java.lang.Comparable<DictionaryFQN>

equals

public boolean equals(java.lang.Object obj)

Indicates whether this DictionaryFQN is equal to another object

Overrides:

equals in class java.lang.Object

Returns:

true if they are equal, else false.