DexNet 4.7.0
Public Member Functions | Static Public Attributes
com::sparsity::dex::gdb::Dex Class Reference

Dex class. More...

List of all members.

Public Member Functions

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

Static Public Attributes

static System.String Version
 Dex version.

Detailed Description

Dex class.

All Dex programs must have one single Dex 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::dex::gdb::Dex::Dex ( com.sparsity.dex.gdb.DexConfig  config)

Creates a new instance.

Parameters:
config[in] Dex configuration.

Member Function Documentation

void com::sparsity::dex::gdb::Dex::Close ( )

Closes the Dex instance.

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

com.sparsity.dex.gdb.Database com::sparsity::dex::gdb::Dex::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::dex::gdb::Dex::IsClosed ( )

Gets if Dex instance has been closed or not.

See also:
Close()
Returns:
TRUE if the Dex instance has been closed, FALSE otherwise.
com.sparsity.dex.gdb.Database com::sparsity::dex::gdb::Dex::Open ( System.String  path,
bool  read 
) throws System.IO.IOException, System.ApplicationException

Opens an existing Database instance.

Parameters:
path[in] Database storage file.
read[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.dex.gdb.Database com::sparsity::dex::gdb::Dex::Restore ( System.String  path,
System.String  backupFile 
) throws System.IO.IOException, System.ApplicationException

Restores a Database from a backup file.

See Graph::Backup.

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