SparkseeNet  5.1.0
Public Member Functions | Static Public Attributes | List of all members
com.sparsity.sparksee.gdb.Sparksee Class Reference

Sparksee class. More...

Public Member Functions

boolean IsClosed ()
 Gets if Sparksee instance has been closed or not. More...
 
void Close ()
 Closes the Sparksee instance. More...
 
com.sparsity.sparksee.gdb.Database Create (System.String path, System.String alias) throws System.IO.IOException, System.ApplicationException
 Creates a new Database instance. More...
 
com.sparsity.sparksee.gdb.Database Restore (System.String path, System.String backupFile) throws System.IO.IOException, System.ApplicationException
 Restores a Database from a backup file. More...
 
com.sparsity.sparksee.gdb.Database Open (System.String path, bool readOnly) throws System.IO.IOException, System.ApplicationException
 Opens an existing Database instance. More...
 
 Sparksee (com.sparsity.sparksee.gdb.SparkseeConfig config)
 Creates a new instance. More...
 

Static Public Attributes

static System.String Version
 Sparksee version.
 

Detailed Description

Sparksee class.

All Sparksee programs must have one single Sparksee instance to manage one or more Database instances.

This class allows for the creation of new Databases or open an existing one.

Author
Sparsity Technologies http://www.sparsity-technologies.com

Constructor & Destructor Documentation

com.sparsity.sparksee.gdb.Sparksee.Sparksee ( com.sparsity.sparksee.gdb.SparkseeConfig  config)

Creates a new instance.

Parameters
config[in] Sparksee configuration.

Member Function Documentation

void com.sparsity.sparksee.gdb.Sparksee.Close ( )

Closes the Sparksee instance.

It must be called to ensure the integrity of all data.

com.sparsity.sparksee.gdb.Database com.sparsity.sparksee.gdb.Sparksee.Create ( System.String  path,
System.String  alias 
) throws System.IO.IOException, System.ApplicationException

Creates a new Database instance.

Parameters
path[in] Database storage file.
alias[in] Database alias name.
Returns
A Database instance.
Exceptions
System.IO.IOExceptionIf the given file cannot be created.
System.ApplicationExceptionnull
boolean com.sparsity.sparksee.gdb.Sparksee.IsClosed ( )

Gets if Sparksee instance has been closed or not.

See Also
Close()
Returns
TRUE if the Sparksee instance has been closed, FALSE otherwise.
com.sparsity.sparksee.gdb.Database com.sparsity.sparksee.gdb.Sparksee.Open ( System.String  path,
bool  readOnly 
) throws System.IO.IOException, System.ApplicationException

Opens an existing Database instance.

Parameters
path[in] Database storage file.
readOnly[in] If TRUE, open Database in read-only mode.
Returns
A Database instance.
Exceptions
System.IO.IOExceptionIf the given file does not exist.
System.ApplicationExceptionnull
com.sparsity.sparksee.gdb.Database com.sparsity.sparksee.gdb.Sparksee.Restore ( System.String  path,
System.String  backupFile 
) throws System.IO.IOException, System.ApplicationException

Restores a Database from a backup file.

See the Graph class Backup method.

Parameters
path[in] Database storage file.
backupFile[in] The Backup file to be restored.
Returns
A Database instance.
Exceptions
System.IO.IOExceptionIf the given file cannot be created, or the exported data file does not exists.
System.ApplicationExceptionnull