Sparksee  5.2.0
STSScriptParser Class Reference

ScriptParser. More...

Inheritance diagram for STSScriptParser:
Inheritance graph
Collaboration diagram for STSScriptParser:
Collaboration graph

Instance Methods

(id) - init
 Constructor.
 
(void) - setOutputLog:
 Sets the output log.
 
(void) - setErrorLog:
 Sets the error log.
 
(BOOL) - parse:execute:localeStr:
 Parses the given input file.
 

Class Methods

(void) + generateSchemaScript:db:
 Writes an script with the schema definition for the given database.
 

Detailed Description

ScriptParser.

The ScriptParser can create schemas and load data from a set of commands in a sparksee script.

A SPARKSEE script contains an ordered list of commands. ScriptParser will execute each one of them in order. Commands may create schemas, define nodes and edges, and load data into a previous defined SPARKSEE schema.

Check out the 'Scripting' chapter in the SPARKSEE User Manual for a comprehensive explanation on the grammar of the SPARKSEE commands and how they work.

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

Method Documentation

+ (void) generateSchemaScript: (NSString *)  path
db: (STSDatabase *)  db 

Writes an script with the schema definition for the given database.

Parameters
path[in] Filename of the script to be writen.
db[in] Database.
Exceptions
System.IO.IOExceptionIf bad things happen opening or writing the file.
- (BOOL) parse: (NSString *)  path
execute: (BOOL)  execute
localeStr: (NSString *)  localeStr 

Parses the given input file.

Parameters
path[in] Input file path.
execute[in] If TRUE the script is executed, if FALSE it is just parsed.
localeStr[in] The locale string for reading the input file. See CSVReader.
Returns
TRUE if ok, FALSE in case of error.
Exceptions
System.IO.IOExceptionIf bad things happen opening the file.
- (void) setErrorLog: (NSString *)  path

Sets the error log.

If not set, error log corresponds to standard error output.

Parameters
path[in] Path of the error log.
Exceptions
System.IO.IOExceptionIf bad things happen opening the file.
- (void) setOutputLog: (NSString *)  path

Sets the output log.

If not set, output log corresponds to standard output.

Parameters
path[in] Path of the output log.
Exceptions
System.IO.IOExceptionIf bad things happen opening the file.

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