CDMA client API  3.1.0
CDMA core library
org.gumtree.data.interfaces.IDataset Interface Reference

The IDataset interface is used to handle a data source. More...

Inherits IModelObject.

List of all members.

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 ()

Detailed Description

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.

Author:
nxi

Member Function Documentation

void org.gumtree.data.interfaces.IDataset.close ( ) throws IOException

Close the dataset.

Exceptions:
IOException

Return the location of the dataset. If it's a file it will return the path.

Returns:
String type

Return the logical root of the dataset.

Returns:
ILogicalGroup that is on top of the logical structure

Return the root group of the dataset.

Returns:
IGroup that is on top of the structure

Return the title of the dataset.

Returns:
string title

Check if the data set is open.

Returns:
true or false
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.

Exceptions:
IOException

Save the contents / changes of the dataset to the file.

Exceptions:
WriterExceptionfailed to write

Save the specific contents / changes of the dataset.

Exceptions:
WriterExceptionfailed 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.

Exceptions:
WriterExceptionfailed to write

Save the contents of the dataset to a new location.

Exceptions:
WriterExceptionfailed to write

Set the location of the dataset.

Parameters:
locationin String type

Set the title for the Dataset.

Parameters:
titlea String object
boolean org.gumtree.data.interfaces.IDataset.sync ( ) throws IOException

Synchronize the dataset with the file reference.

Returns:
true or false
Exceptions:
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.

Parameters:
osjava i/o OutputStream
uria path to the file
Exceptions:
java.io.IOException
Deprecated:
[SOLEIL][clement][2012-04-18] seems to be a plug-in dependent method

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