CDMA plugin API  3.1.0
CDMA core library
org.gumtree.data.interfaces.IDictionary Interface Reference

The IDictionary interface defines a direct association of a keyword and a path. More...

Inherits IModelObject.

List of all members.

Public Member Functions

List< IKeygetAllKeys ()
IPath getPath (IKey key)
List< IPath > getAllPaths (IKey key)
void addEntry (String key, String path)
void addEntry (String key, IPath path)
void readEntries (URI uri) throws FileAccessException
void readEntries (String path) throws FileAccessException
void removeEntry (String key, String path)
void removeEntry (String key)
boolean containsKey (String key)
IDictionary clone () throws CloneNotSupportedException

Detailed Description

The IDictionary interface defines a direct association of a keyword and a path.

Note:
When developing a plug-in consider using the data format engine's implementation. You should redefine this interface implementation, only in case of very specific needs.

pluginAPI A dictionary interface used in CDMA Standard Dictionary mechanism. The IGroup references a path with a key in String type and should list all available node in the IDataset. The targeted object in the path can be either a IGroup or a IDataItem.

Author:
nxi

Member Function Documentation

void org.gumtree.data.interfaces.IDictionary.addEntry ( String  key,
String  path 
)

Add an entry of key and path.

Parameters:
keykey object
pathString object
void org.gumtree.data.interfaces.IDictionary.addEntry ( String  key,
IPath  path 
)
IDictionary org.gumtree.data.interfaces.IDictionary.clone ( ) throws CloneNotSupportedException

Clone the dictionary in a new object.

Returns:
new Dictionary object
Exceptions:
CloneNotSupportedExceptionfailed to clone
Parameters:
keykey object
Returns:
true or false

Return all keys referenced in the dictionary.

Returns:
a list of String objects

Return all paths referenced by the key.

Parameters:
keykey object
Returns:
a list of String objects

Get the path referenced by the key. If there are more than one paths are referenced by the path, get the default one.

Parameters:
keykey object
Returns:
String object

Read dictionary entries from a file.

Parameters:
uriURI object
Exceptions:
FileAccessExceptionI/O file access exception

Read dictionary entries from a file.

Parameters:
pathString object
Exceptions:
FileAccessExceptionI/O file access exception
void org.gumtree.data.interfaces.IDictionary.removeEntry ( String  key,
String  path 
)

Remove a path from an entry. If there is only one path associated with the key, then remove the entry as well.

Parameters:
keykey object
pathString object

Remove an entry from the dictionary.

Parameters:
keykey object

The documentation for this interface was generated from the following file:
 All Classes Namespaces Files Functions Variables