Sparksee  5.2.0
STSSparksee Class Reference

Sparksee class. More...

Inheritance diagram for STSSparksee:
Inheritance graph
Collaboration diagram for STSSparksee:
Collaboration graph

Instance Methods

(id) - initWithConfig:
 Creates a new instance.
 
(STSDatabase *) - create:alias:
 Creates a new Database instance.
 
(STSDatabase *) - open:readOnly:
 Opens an existing Database instance.
 
(STSDatabase *) - restore:backupFile:
 Restores a Database from a backup file.
 
(void) - close
 Closes the Sparksee instance.
 
(BOOL) - isClosed
 Check if the Sparksee instance is closed.
 

Class Methods

(NSString *) + getVersion
 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

Method Documentation

- (STSDatabase*) create: (NSString *)  path
alias: (NSString *)  alias 

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
- (id) initWithConfig: (STSSparkseeConfig *)  config

Creates a new instance.

Parameters
config[in] Sparksee configuration.
- (STSDatabase*) open: (NSString *)  path
readOnly: (BOOL)  readOnly 

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
- (STSDatabase*) restore: (NSString *)  path
backupFile: (NSString *)  backupFile 

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

The documentation for this class was generated from the following file: