|
CDMA plugin API
3.1.0
CDMA core library
|
The IDictionary interface defines a direct association of a keyword and a path. More...
Inherits IModelObject.
Public Member Functions | |
| List< IKey > | getAllKeys () |
| 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 |
The IDictionary interface defines a direct association of a keyword and a path.
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.
| void org.gumtree.data.interfaces.IDictionary.addEntry | ( | String | key, |
| String | path | ||
| ) |
Add an entry of key and path.
| key | key object |
| path | String 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.
| CloneNotSupportedException | failed to clone |
| boolean org.gumtree.data.interfaces.IDictionary.containsKey | ( | String | key | ) |
| key | key object |
Return all keys referenced in the dictionary.
| List<IPath> org.gumtree.data.interfaces.IDictionary.getAllPaths | ( | IKey | key | ) |
Return all paths referenced by the key.
| key | key object |
| IPath org.gumtree.data.interfaces.IDictionary.getPath | ( | IKey | key | ) |
Get the path referenced by the key. If there are more than one paths are referenced by the path, get the default one.
| key | key object |
| void org.gumtree.data.interfaces.IDictionary.readEntries | ( | URI | uri | ) | throws FileAccessException |
Read dictionary entries from a file.
| uri | URI object |
| FileAccessException | I/O file access exception |
| void org.gumtree.data.interfaces.IDictionary.readEntries | ( | String | path | ) | throws FileAccessException |
Read dictionary entries from a file.
| path | String object |
| FileAccessException | I/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.
| key | key object |
| path | String object |
| void org.gumtree.data.interfaces.IDictionary.removeEntry | ( | String | key | ) |
Remove an entry from the dictionary.
| key | key object |