Classes
class	Attribute
	Attribute data class. More...

class	AttributeList
	Sparksee attribute identifier list. More...

class	AttributeListIterator
	AttributeList iterator class. More...

class	AttributeStatistics
	Attribute statistics class. More...

class	BooleanList
	Boolean list. More...

class	BooleanListIterator
	BooleanList iterator class. More...

class	Database
	Database class. More...

class	DatabaseStatistics
	Database statistics. More...

class	DefaultExport
	Default implementation for ExportManager class. More...

class	EdgeData
	Edge data class. More...

class	EdgeExport
	Stores edge exporting values. More...

class	ExportManager
	Defines how to export a graph to an external format. More...

class	Graph
	Graph class. More...

class	GraphExport
	Stores the graph exporting values. More...

class	Int32List
	Sparksee 32-bit signed integer list. More...

class	Int32ListIterator
	Int32List iterator class. More...

class	KeyValue

class	KeyValues
	Value set class. More...

class	NodeExport
	Stores the node exporting values. More...

class	Objects
	Object identifier set class. More...

class	ObjectsIterator
	ObjectsIterator class. More...

class	OIDList
	Sparksee object identifier list. More...

class	OIDListIterator
	OIDList iterator class. More...

class	Platform
	Platform class. More...

class	PlatformStatistics
	Platform data and statistics. More...

class	Query
	Query class. More...

class	QueryContext
	Query context interface. More...

class	QueryStream
	Query stream interface. More...

class	QueryStreamManager
	QueryStreamManager 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	SparkseeConfig
	Sparksee configuration class. More...

class	SparkseeProperties
	Sparksee properties file. More...

class	StringList
	String list. More...

class	StringListIterator
	StringList iterator class. More...

class	TextStream
	TextStream class. More...

class	Type
	Type data class. More...

class	TypeList
	Sparksee type identifier list. More...

class	TypeListIterator
	TypeList iterator class. More...

class	Value
	Value class. More...

class	ValueArray
	ValueArray class. More...

class	ValueList
	Value list. More...

class	ValueListIterator
	ValueList iterator class. More...

class	Values
	Value set class. More...

class	ValuesIterator
	Values iterator class. More...

Enumerations
enum	AttributeKind { Basic , Indexed , Unique }
	Attribute kind enumeration. More...

enum	Condition { Equal , GreaterEqual , GreaterThan , LessEqual , LessThan , NotEqual , Like , LikeNoCase , Between , RegExp }
	Condition operators enumeration. More...

enum	DataType { Boolean , Integer , Long , Double , Timestamp , String , Text , OID }
	Data type (domain) enumeration. More...

enum	EdgesDirection { Ingoing , Outgoing , Any }
	Edges direction enumeration. More...

enum	ExportType { Graphviz , GraphML , YGraphML , Html }
	Export type. More...

enum	LogLevel { Off , Severe , Warning , Info , Config , Fine , Debug }
	Log level enumeration. More...

enum	MissingEndpoint { IsError , Create , Ignore }
	The policy to follow whenever and edge endpoint is missing during a loading. More...

enum	NodeShape { Box , Round , Ellipse , Circle , Cylinder , TextShape , Diamond , Dot , Star , Triangle , TriangleDown , Square , Image }
	Node shape. More...

enum	ObjectType { Node , Edge }
	Object type enumeration. More...

enum	Order { Ascendent , Descendent }
	Order enumeration. More...

enum	QueryLanguage { SparkseeAlgebra , SparkseeCypher }
	The supported query languages. More...

enum	UnrecoverableError { SystemCallError , InvalidChecksum }
	Enum representing unrecoverable errors. More...

Enumeration Type Documentation

◆ AttributeKind

enum com.sparsity.sparksee.gdb.AttributeKind

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

\brief Unique attribute (indexed + unique restriction).

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

◆ Condition

enum com.sparsity.sparksee.gdb.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	\brief Equal condition (==). Null values can be used together with this condition to retrieve all objects having a null value for an attribute.
GreaterEqual	\brief Greater or equal condition (>=). Null values cannot be used together with this condition.
GreaterThan	\brief Greater than condition (>). Null values cannot be used together with this condition.
LessEqual	\brief Less or equal condition (<=). Null values cannot be used together with this condition.
LessThan	\brief Less than condition (<). Null values cannot be used together with this condition.
NotEqual	\brief 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	\brief 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	\brief 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	\brief In range operator condition ([x,y]). Null values cannot be used together with this condition.
RegExp	\brief 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.

◆ DataType

enum com.sparsity.sparksee.gdb.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	\brief 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	\brief Unicode string data type. 2048 characters maximum length.
Text	\brief Large unicode character object (CLOB) data type. TextStream
OID	Object identifier (OID) data type.

◆ EdgesDirection

enum com.sparsity.sparksee.gdb.EdgesDirection

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.

◆ ExportType

enum com.sparsity.sparksee.gdb.ExportType

Export type.

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

Enumerator
Graphviz	\brief Export to Graphviz format. This "dot" file format is the recommended export format. Graphviz home page: http://www.graphviz.org
GraphML	\brief Export to GraphML format. Deprectated! GraphML home page: http://graphml.graphdrawing.org/
YGraphML	\brief Export to YGRAPHML format. Deprectated! 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").
Html	\brief Export to HTML format. Simple html export for quick visualization of a small graph. Directly export to HTML using vis.js (https://visjs.github.io/vis-network/docs/network/index.html).

◆ LogLevel

enum com.sparsity.sparksee.gdb.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	\brief Severe log level. This is the lower log level, just errors are shown.
Warning	\brief Warning log level. Errors and warnings are shown.
Info	\brief Info log level. Errors, warnings and information messages are shown.
Config	\brief Config log level. Errors, warnings, information messages and configuration details of the different components are shown.
Fine	\brief Fine log level. This is the higher and finest public log level, everything is dumped to the log.
Debug	\brief Debug log level. This is for Sparksee development purposes and just works with debug versions of the library.

◆ MissingEndpoint

enum com.sparsity.sparksee.gdb.MissingEndpoint

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.

◆ NodeShape

enum com.sparsity.sparksee.gdb.NodeShape

Node shape.

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

Enumerator
Box	Box Shape.
Round	Round Shape.
Ellipse	Ellipse Shape.
Circle	Circle Shape.
Cylinder	Cylinder Shape.
TextShape	Plain Text Shape.
Diamond	Diamond Shape.
Dot	Dot Shape.
Star	Star Shape.
Triangle	Upwards Triangle Shape.
TriangleDown	Downwards Triangle Shape.
Square	Square Shape.
Image	Image Shape.

◆ ObjectType

enum com.sparsity.sparksee.gdb.ObjectType

Object type enumeration.

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

Enumerator
Node	Node object type.
Edge	Edge object type.

◆ Order

enum com.sparsity.sparksee.gdb.Order

Order enumeration.

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

Enumerator
Ascendent	From lower to higher.
Descendent	From higher to lower.

◆ QueryLanguage

enum com.sparsity.sparksee.gdb.QueryLanguage

The supported query languages.

Enumerator
SparkseeAlgebra	The internal Sparksee Algebra.
SparkseeCypher	The Sparksee Cypher Language inspired by the OpenCypher Query Language.

◆ UnrecoverableError

enum com.sparsity.sparksee.gdb.UnrecoverableError

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.

Classes

Enumerations