|
CDMA engine API
3.1.0
CDMA core library
|
The IDataset interface is used to handle a data source. More...
Inherits IModelObject.
Public Member Functions | |
| void | close () throws IOException |
| IGroup | getRootGroup () |
| ILogicalGroup | getLogicalRoot () |
| String | getLocation () |
| String | getTitle () |
| void | setLocation (String location) |
| void | setTitle (String title) |
| boolean | sync () throws IOException |
| void | open () throws IOException |
| void | save () throws WriterException |
| void | saveTo (String location) throws WriterException |
| void | save (IContainer container) throws WriterException |
| void | save (String parentPath, IAttribute attribute) throws WriterException |
| void | writeNcML (java.io.OutputStream os, java.lang.String uri) throws java.io.IOException |
| boolean | isOpen () |
The IDataset interface is used to handle a data source.
A IDataset is a physical storage of CDMA objects, it holds a reference of a root group, which is the root of a tree of IGroup and IDataItem. It is the entry point to access the data structure it represents.
For example in case of a data file container, the IDataset should refer to the file handle.
| void org.gumtree.data.interfaces.IDataset.close | ( | ) | throws IOException |
Close the dataset.
| IOException |
Return the location of the dataset. If it's a file it will return the path.
| ILogicalGroup org.gumtree.data.interfaces.IDataset.getLogicalRoot | ( | ) |
Return the logical root of the dataset.
Return the root group of the dataset.
Return the title of the dataset.
| boolean org.gumtree.data.interfaces.IDataset.isOpen | ( | ) |
Check if the data set is open.
| void org.gumtree.data.interfaces.IDataset.open | ( | ) | throws IOException |
Open the dataset. If it is a file should open the file, if a database enable connection, etc.
| IOException |
| void org.gumtree.data.interfaces.IDataset.save | ( | ) | throws WriterException |
Save the contents / changes of the dataset to the file.
| WriterException | failed to write |
| void org.gumtree.data.interfaces.IDataset.save | ( | IContainer | container | ) | throws WriterException |
Save the specific contents / changes of the dataset.
| WriterException | failed to write |
| void org.gumtree.data.interfaces.IDataset.save | ( | String | parentPath, |
| IAttribute | attribute | ||
| ) | throws WriterException |
Save the attribute to the specific path of the file.
| WriterException | failed to write |
| void org.gumtree.data.interfaces.IDataset.saveTo | ( | String | location | ) | throws WriterException |
Save the contents of the dataset to a new location.
| WriterException | failed to write |
| void org.gumtree.data.interfaces.IDataset.setLocation | ( | String | location | ) |
Set the location of the dataset.
| location | in String type |
| void org.gumtree.data.interfaces.IDataset.setTitle | ( | String | title | ) |
Set the title for the Dataset.
| title | a String object |
| boolean org.gumtree.data.interfaces.IDataset.sync | ( | ) | throws IOException |
Synchronize the dataset with the file reference.
| IOException |
| void org.gumtree.data.interfaces.IDataset.writeNcML | ( | java.io.OutputStream | os, |
| java.lang.String | uri | ||
| ) | throws java.io.IOException |
Write the file with NcML format.
| os | java i/o OutputStream |
| uri | a path to the file |
| java.io.IOException |