Sparksee  6.0.2
Gdb
Collaboration diagram for Gdb:

Files

file  common.h
 It contains common includes and definitions as well as set basic data types and enumerations.
 
file  Database.h
 It contains the definition of Database class as well as some other related classes.
 
file  Exception.h
 It contains a hierarchy of exceptions.
 
file  Export.h
 It contains the declaration of ExportManager interface and GraphExport, NodeExport, etc classes.
 
file  Graph.h
 It contains the definition of Graph class.
 
file  Graph_data.h
 It contains the definition of some Graph-related classes.
 
file  Handler.h
 It contains the definition of Handler class.
 
file  Values.h
 It contains the definition of Values class.
 
file  Objects.h
 It contains the definition of Object class.
 
file  ObjectsIterator.h
 It contains the definition of ObjectsIterator class.
 
file  Query.h
 It contains the definition of Query class.
 
file  QueryContext.h
 It contains the definition of QueryContext class.
 
file  ResultSet.h
 It contains the definition of ResultSet class.
 
file  Session.h
 It contains the definition of Session class.
 
file  Sparksee.h
 It contains the declaration of Sparksee class.
 
file  SparkseeConfig.h
 It contains the declaration of SparkseeProperties and SparkseeConfig classes.
 
file  Stream.h
 It contains the definition of stream classes.
 
file  Value.h
 It contains the definitio of Value class.
 
file  ValueArray.h
 It contains the definition of ValueArray classes.
 
file  Values.h
 It contains the definition of Values class.
 
file  ValuesIterator.h
 It contains the definition of ValuesIterator class.
 

Classes

class  PlatformStatistics
 Platform data and statistics. More...
 
class  Platform
 Platform class. More...
 
class  DatabaseStatistics
 Database statistics. More...
 
class  Database
 Database class. More...
 
class  Exception
 Exception class. More...
 
class  IOException
 IO exception class. More...
 
class  FileNotFoundException
 File not found exception class. More...
 
class  NoSuchElementException
 No such element exception class. More...
 
class  Error
 Error class. More...
 
class  SystemError
 System error class. More...
 
class  AppError
 Application error class. More...
 
class  WrongArgumentError
 Wrong argument error class. More...
 
class  IOError
 IO error class. More...
 
class  LicenseError
 License error class. More...
 
class  UnsupportedOperationError
 Unsupported operation error class. More...
 
class  QueryException
 Query exception class. More...
 
class  EncryptionError
 Wrong encryption arguments error class. More...
 
class  GraphExport
 Stores the graph exporting values. More...
 
class  NodeExport
 Stores the node exporting values. More...
 
class  EdgeExport
 Stores edge exporting values. More...
 
class  ExportManager
 Defines how to export a graph to an external format. More...
 
class  DefaultExport
 Default implementation for ExportManager class. More...
 
class  Graph
 Graph class. More...
 
class  Type
 Type data class. More...
 
class  TypeList
 Sparksee type identifier list. More...
 
class  TypeListIterator
 TypeList iterator class. More...
 
class  Attribute
 Attribute data class. More...
 
class  AttributeList
 Sparksee attribute identifier list. More...
 
class  AttributeListIterator
 AttributeList iterator class. More...
 
class  OIDList
 Sparksee object identifier list. More...
 
class  OIDListIterator
 OIDList iterator class. More...
 
class  AttributeStatistics
 Attribute statistics class. More...
 
class  EdgeData
 Edge data class. More...
 
class  StringList
 String list. More...
 
class  StringListIterator
 StringList iterator class. More...
 
class  BooleanList
 Boolean list. More...
 
class  BooleanListIterator
 BooleanList iterator class. More...
 
class  Int32List
 Sparksee 32-bit signed integer list. More...
 
class  Int32ListIterator
 Int32List iterator class. More...
 
class  Handler< T >
 Handles a reference. More...
 
class  KeyValue
 
class  KeyValues
 Value set class. More...
 
class  Objects
 Object identifier set class. More...
 
class  ObjectsIterator
 ObjectsIterator class. More...
 
class  QueryStream
 Query stream interface. More...
 
class  Query
 Query class. More...
 
class  QueryContext
 Query context interface. More...
 
class  ResultSet
 ResultSet class. More...
 
class  ResultSetList
 ResultSet list. More...
 
class  ResultSetListIterator
 ResultSetList iterator class. More...
 
class  Session
 Session class. More...
 
class  Sparksee
 Sparksee class. More...
 
class  SparkseeProperties
 Sparksee properties file. More...
 
class  SparkseeConfig
 Sparksee configuration class. More...
 
class  TextStream
 TextStream class. More...
 
class  Value
 Value class. More...
 
class  ValueList
 Value list. More...
 
class  ValueListIterator
 ValueList iterator class. More...
 
class  ValueArray
 ValueArray class. More...
 
class  Values
 Value set class. More...
 
class  ValuesIterator
 Values iterator class. More...
 

Macros

#define BEGIN_SPARKSEE_NAMESPACE   namespace sparksee {
 Begining macro for the sparksee namespace.
 
#define END_SPARKSEE_NAMESPACE   }
 Ending macro for the sparksee namespace.
 
#define BEGIN_SPARKSEE_GDB_NAMESPACE   BEGIN_SPARKSEE_NAMESPACE namespace gdb {
 Begining macro for the sparksee::gdb namespace.
 
#define END_SPARKSEE_GDB_NAMESPACE   END_SPARKSEE_NAMESPACE }
 Ending macro for the sparksee::gdb namespace.
 
#define BEGIN_SPARKSEE_IO_NAMESPACE   BEGIN_SPARKSEE_NAMESPACE namespace io {
 Begining macro for the sparksee::io namespace.
 
#define END_SPARKSEE_IO_NAMESPACE   END_SPARKSEE_NAMESPACE }
 Ending macro for the sparksee::io namespace.
 
#define BEGIN_SPARKSEE_SCRIPT_NAMESPACE   BEGIN_SPARKSEE_NAMESPACE namespace script {
 Begining macro for the sparksee::script namespace.
 
#define END_SPARKSEE_SCRIPT_NAMESPACE   END_SPARKSEE_NAMESPACE }
 Ending macro for the sparksee::script namespace.
 
#define BEGIN_SPARKSEE_ALGORITHMS_NAMESPACE   BEGIN_SPARKSEE_NAMESPACE namespace algorithms {
 Begining macro for the sparksee::algorithms namespace.
 
#define END_SPARKSEE_ALGORITHMS_NAMESPACE   END_SPARKSEE_NAMESPACE }
 Ending macro for the sparksee::algorithms namespace.
 
#define BEGIN_SPARKSEE_TEST_NAMESPACE   BEGIN_SPARKSEE_NAMESPACE namespace test {
 Begining macro for the sparksee::test namespace.
 
#define END_SPARKSEE_TEST_NAMESPACE   END_SPARKSEE_NAMESPACE }
 Ending macro for the sparksee::test namespace.
 
#define BEGIN_SPARKSEE_QUERY_STREAMS_NAMESPACE   BEGIN_SPARKSEE_NAMESPACE namespace query_streams {
 Begining macro for the sparksee::algorithms namespace.
 
#define END_SPARKSEE_QUERY_STREAMS_NAMESPACE   END_SPARKSEE_NAMESPACE }
 Ending macro for the sparksee::query_streams namespace.
 

Typedefs

typedef bool bool_t
 Boolean type.
 
typedef char char_t
 Character type.
 
typedef wchar_t uchar_t
 Unicode character type.
 
typedef signed int int32_t
 32-bit signed integer type.
 
typedef signed long long int64_t
 64-bit signed integer type.
 
typedef double double64_t
 64-bit double type.
 
typedef int32_t type_t
 Graph node or edge type type.
 
typedef int32_t attr_t
 Graph attribute type.
 
typedef int64_t oid_t
 Graph OID type.
 
typedef int32_t ColorRGB
 Color codified as RGB 32-bit int. More...
 
typedef void(* SPARKSEE_UNRECOVERABLE_ERR_CALLBACK) (UnrecoverableError error)
 Signature of callback functions to call after UnrecoverableErrors are triggered. More...
 

Enumerations

Functions

std::wostream & operator<< (std::wostream &wostrm, const enum DataType &dt)
 Easy STL printing operator redefinition. More...
 
std::wostream & operator<< (std::wostream &wostrm, const enum AttributeKind &ak)
 Easy STL printing operator redefinition. More...
 

Variables

BEGIN_SPARKSEE_GDB_NAMESPACE typedef unsigned char byte_t
 Byte type.
 

Detailed Description

Typedef Documentation

typedef int32_t ColorRGB

Color codified as RGB 32-bit int.

Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue.

typedef void(* SPARKSEE_UNRECOVERABLE_ERR_CALLBACK) (UnrecoverableError error)

Signature of callback functions to call after UnrecoverableErrors are triggered.

Parameters
Thetype of UnrecoverableError that triggered the callback

Enumeration Type Documentation

Attribute kind enumeration.

It determines the indexing-capabilities of an attribute.

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

Basic attribute (non indexed attribute).

Indexed 

Indexed attribute.

Unique 

Unique attribute (indexed + unique restriction).

Unique restriction sets two objects cannot have the same value for an attribute but NULL.

enum Condition

Condition operators enumeration.

It is mainly used in the attribute-based graph select operations.

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

Equal condition (==).

Null values can be used together with this condition to retrieve all objects having a null value for an attribute.

GreaterEqual 

Greater or equal condition (>=).

Null values cannot be used together with this condition.

GreaterThan 

Greater than condition (>).

Null values cannot be used together with this condition.

LessEqual 

Less or equal condition (<=).

Null values cannot be used together with this condition.

LessThan 

Less than condition (<).

Null values cannot be used together with this condition.

NotEqual 

Not equal condition (!=).

Null values can be used together with this condition to retrieve all objects having a non-null value for an attribute.

Like 

Substring condition.

Null values cannot be used together with this condition.

This condition can just be used together with String values. It allows for searching substrings (case sensitive). Ex:

'AAABBBCCCD' Like 'BBB'   returns TRUE
'AAABBBCCCD' Like 'bbb'   returns FALSE
'AAABBBCCCD' Like 'E'     returns FALSE
LikeNoCase 

Substring (no case sensitive) condition.

Null values cannot be used together with this condition.

This condition can just be used together with String values. It allows for searching substrings (no case sensitive). Ex:

'AAABBBCCCD' LikeNoCase 'BBB'   returns TRUE
'AAABBBCCCD' LikeNoCase 'bbb'   returns TRUE
'AAABBBCCCD' LikeNoCase 'E'     returns FALSE
Between 

In range operator condition ([x,y]).

Null values cannot be used together with this condition.

RegExp 

Regular expression condition.

Null values cannot be used together with this condition.

This condition can just be used together with String values.

Regular expression format conforms most of the POSIX Extended Regular Expressions so it is case sensitive.

See the 'Regular expressions' section in the 'SPARKSEE User Manual' for details.

enum DataType

Data type (domain) enumeration.

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

Boolean data type.

Integer 

32-bit signed integer data type.

Long 

64-bit signed integer data type.

Double 

64-bit signed double data type.

Timestamp 

Distance from Epoch (UTC) time in milliseconds precision.

It just works properly with timestamps in the range ['1970-01-01 00:00:01' UTC, '2038-01-19 03:14:07' UTC].

String 

Unicode string data type.

2048 characters maximum length.

Text 

Large unicode character object (CLOB) data type.

See also
TextStream
OID 

Object identifier (OID) data type.

Edges direction enumeration.

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

In-going edges.

Outgoing 

Out-going edges.

Any 

In-going or out-going edges.

enum ExportType

Export type.

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

Export to Graphviz format.

Graphviz home page: http://www.graphviz.org

GraphML 

Export to GraphML format.

GraphML home page: http://graphml.graphdrawing.org/

YGraphML 

Export to YGRAPHML format.

It is an GraphML format extended with a set of yWorks ("http://www.yworks.com") extensions. Thus, it allows for the visualization of the exported graph with the public yEd visualization tool ("http://www.yworks.com/products/yed").

enum LogLevel

Log level enumeration.

Log level priority order is as follows, from minimum to maximum log information: Off (log is disabled), Severe, Warning, Info, Config, Fine, Debug.

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

Disable log.

Severe 

Severe log level.

This is the lower log level, just errors are shown.

Warning 

Warning log level.

Errors and warnings are shown.

Info 

Info log level.

Errors, warnings and information messages are shown.

Config 

Config log level.

Errors, warnings, information messages and configuration details of the different components are shown.

Fine 

Fine log level.

This is the higher and finest public log level, everything is dumped to the log.

Debug 

Debug log level.

This is for Sparksee development purposes and just works with debug versions of the library.

The policy to follow whenever and edge endpoint is missing during a loading.

Enumerator
IsError 

Throw an error.

Create 

Create the endpoint.

Ignore 

Ignore the edge.

enum NodeShape

Node shape.

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

Box shape.

Round 

Round shape.

enum ObjectType

Object type enumeration.

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

Node object type.

Edge 

Edge object type.

enum Order

Order enumeration.

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

From lower to higher.

Descendent 

From higher to lower.

The supported query languages.

Enumerator
SparkseeAlgebra 

The internal Sparksee Algebra.

SparkseeCypher 

The Sparksee Cypher Language inspired by the OpenCypher Query Language.

Enum representing unrecoverable errors.

Enumerator
SystemCallError 

Error triggered due to an unrecoverable error detected during a system call in the Sparksee core.

InvalidChecksum 

Error triggered after detecting an invalid checksum during reading data from an I/O device.

Function Documentation

std::wostream& operator<< ( std::wostream &  wostrm,
const enum DataType dt 
)

Easy STL printing operator redefinition.

It allows to do: ... << sparksee::gdb::String << ...

Parameters
wostrmA widechar oputput stream
dt[in] An DataType.
Returns
Returns the widechar output stream with the DataType written.
std::wostream& operator<< ( std::wostream &  wostrm,
const enum AttributeKind ak 
)

Easy STL printing operator redefinition.

It allows to do: ... << sparksee::gdb::Basic << ...

Parameters
wostrmA widechar oputput stream
ak[in] An attribute kind.
Returns
Returns the widechar output stream with the AttributeKind written.