|
CDMA client API
3.1.0
CDMA core library
|
IExtendedDictionary interface is the logical representation of a IDataset. More...
Inherits IExtendedDictionary.
Public Member Functions | |
| ExtendedDictionary (IFactory factory, String keyFile, String mapFile) | |
| void | addEntry (String keyName, String entryPath) |
| void | addEntry (String keyName, IPath path) |
| boolean | containsKey (String keyName) |
| List< IKey > | getAllKeys () |
| List< IPath > | getAllPaths (IKey key) |
| IPath | getPath (IKey key) |
| void | readEntries (URI uri) throws FileAccessException |
| void | readEntries (String filePath) throws FileAccessException |
| void | readEntries () throws FileAccessException |
| void | removeEntry (String keyName, String path) |
| void | removeEntry (String keyName) |
| IDictionary | clone () throws CloneNotSupportedException |
| ExtendedDictionary | getDictionary (IKey key) |
| String | getVersionNum () |
| String | getView () |
| ExternalClassLoader | getClassLoader () |
| String | getFactoryName () |
| String | getKeyFilePath () |
| String | getMappingFilePath () |
Protected Member Functions | |
| ExtendedDictionary (IFactory factory, String keyFile, String mapFile, String experiment) | |
IExtendedDictionary interface is the logical representation of a IDataset.
It defines how data is logically structured and permits a standardized browsing what ever the plug-in, the data source format or its structure is.
The dictionary is compound of two element a key file that defines the representation of the dataset and a mapping file that associates Association of objects is the following:
- IKey and IPath for a IDataItem,
- IKey and IExtendedDictionary for a ILogicalGroup.
| org.gumtree.data.dictionary.impl.ExtendedDictionary.ExtendedDictionary | ( | IFactory | factory, |
| String | keyFile, | ||
| String | mapFile | ||
| ) |
| org.gumtree.data.dictionary.impl.ExtendedDictionary.ExtendedDictionary | ( | IFactory | factory, |
| String | keyFile, | ||
| String | mapFile, | ||
| String | experiment | ||
| ) | [protected] |
| void org.gumtree.data.dictionary.impl.ExtendedDictionary.addEntry | ( | String | keyName, |
| String | entryPath | ||
| ) |
| void org.gumtree.data.dictionary.impl.ExtendedDictionary.addEntry | ( | String | keyName, |
| IPath | path | ||
| ) |
| IDictionary org.gumtree.data.dictionary.impl.ExtendedDictionary.clone | ( | ) | throws CloneNotSupportedException |
| boolean org.gumtree.data.dictionary.impl.ExtendedDictionary.containsKey | ( | String | keyName | ) |
| List<IPath> org.gumtree.data.dictionary.impl.ExtendedDictionary.getAllPaths | ( | IKey | key | ) |
| ExternalClassLoader org.gumtree.data.dictionary.impl.ExtendedDictionary.getClassLoader | ( | ) |
Get the plug-in implementation of a IClassLoader so invocations of external code are made possible.
Get a sub part of this dictionary that corresponds to a key.
| IKey | object |
Return the path to reach the key dictionary file
Return the path to reach the mapping dictionary file
Get the version number (in 3 digits default implementation) that is plug-in dependent. This version corresponds of the dictionary defining the path. It permits to distinguish various generation of IDataset for a same institutes. Moreover it's required to select the right class when using a IClassLoader invocation.
Get the view name matching this dictionary
| void org.gumtree.data.dictionary.impl.ExtendedDictionary.readEntries | ( | URI | uri | ) | throws FileAccessException |
| void org.gumtree.data.dictionary.impl.ExtendedDictionary.readEntries | ( | String | filePath | ) | throws FileAccessException |
Read all keys stored in the XML dictionary file
| void org.gumtree.data.dictionary.impl.ExtendedDictionary.removeEntry | ( | String | keyName, |
| String | path | ||
| ) |
| void org.gumtree.data.dictionary.impl.ExtendedDictionary.removeEntry | ( | String | keyName | ) |