sparksee Namespace Reference

Embedded Graph Database. More...

Classes
class	Attribute
	Attribute data class. More...
class	AttributeKind
	Attribute kind enumeration. 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	CommunitiesSCD
	CommunitiesSCD class. More...
class	CommunityDetection
	CommunityDetection class. More...
class	Condition
	Condition operators enumeration. More...
class	ConnectedComponents
	ConnectedComponents class. More...
class	Connectivity
	Connectivity class. More...
class	Context
	Context class. More...
class	CSVReader
	CSVReader interface. More...
class	CSVWriter
	CSVWriter interface. More...
class	Database
	Database class. More...
class	DatabaseStatistics
	Database statistics. More...
class	DataType
	Data type (domain) enumeration. More...
class	DefaultExport
	Default implementation for ExportManager class. More...
class	DisjointCommunities
	DisjointCommunities class. More...
class	DisjointCommunityDetection
	DisjointCommunityDetection class. More...
class	EdgeData
	Edge data class. More...
class	EdgeExport
	Stores edge exporting values. More...
class	EdgesDirection
	Edges direction enumeration. More...
class	EdgeTypeExporter
	EdgeTypeExporter class. More...
class	EdgeTypeLoader
	EdgeTypeLoader class. More...
class	ExportManager
	Defines how to export a graph to an external format. More...
class	ExportType
	Export type. 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	KOpt
	KOpt class. More...
class	LogLevel
	Log level enumeration. More...
class	MissingEndpoint
	The policy to follow whenever and edge endpoint is missing during a loading. More...
class	NodeExport
	Stores the node exporting values. More...
class	NodeShape
	Node shape. More...
class	NodeTypeExporter
	NodeTypeExporter class. More...
class	NodeTypeLoader
	NodeTypeLoader class. More...
class	Objects
	Object identifier set class. More...
class	ObjectsIterator
	ObjectsIterator class. More...
class	ObjectType
	Object type enumeration. More...
class	OIDList
	Sparksee object identifier list. More...
class	OIDListIterator
	OIDList iterator class. More...
class	Order
	Order enumeration. More...
class	PageRank
	PageRank 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	QueryLanguage
	The supported query languages. More...
class	QueryStream
	Query stream interface. More...
class	RandomWalk
	RandomWalk class. More...
class	ResultSet
	ResultSet class. More...
class	ResultSetList
	ResultSet list. More...
class	ResultSetListIterator
	ResultSetList iterator class. More...
class	RowReader
	RowReader interface. More...
class	RowWriter
	RowWriter interface. More...
class	ScriptParser
	ScriptParser. More...
class	Session
	Session class. More...
class	ShortestPath
	ShortestPath class. More...
class	SinglePairShortestPath
	SinglePairShortestPath class. More...
class	SinglePairShortestPathBFS
	SinglePairShortestPathBFS class. More...
class	SinglePairShortestPathDijkstra
	SinglePairShortestPathDijkstra class. More...
class	SinglePairShortestPathDijkstraDynamicCost
	Defines how to calculate an edge weight. 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	StrongConnectivity
	StrongConnectivity class. More...
class	StrongConnectivityGabow
	This class can be used to solve the problem of finding strongly connected components in a directed graph. More...
class	TextStream
	TextStream class. More...
class	Traversal
	Traversal class. More...
class	TraversalBFS
	Breadth-First Search implementation of Traversal. More...
class	TraversalDFS
	Depth-First Search (DFS) implementation of Traversal. More...
class	Type
	Type data class. More...
class	TypeExporter
	Base TypeExporter class. More...
class	TypeExporterEvent
	Provides information about the progress of an TypeExproter instance. More...
class	TypeExporterListener
	Interface to be implemented to receive TypeExporterEvent events from a TypeExporter. More...
class	TypeList
	Sparksee type identifier list. More...
class	TypeListIterator
	TypeList iterator class. More...
class	TypeLoader
	Base TypeLoader class. More...
class	TypeLoaderEvent
	Provides information about the progress of a TypeLoader instance. More...
class	TypeLoaderListener
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...
class	WeakConnectivity
	WeakConnectivity class. More...
class	WeakConnectivityDFS
	WeakConnectivityDFS class. More...

Functions
def	load_nodes_csv (self, graph, file_name, node_type, separator, header, columns, attr_names, data_types, attr_kinds)
	Loads nodes from a CSV file. More...
def	load_edges_csv (self, graph, file_name, edge_type, tail_node_type, head_node_type, tail, head, separator, directed, header, on_missing_tail, on_missing_head, columns, attr_names, data_types, attr_kinds)
	Loads edges from a CSV file. More...

Detailed Description

Embedded Graph Database.

Interface to be implemented to receive TypeLoaderEvent events from a TypeLoader.

Check out the 'Data import' section in the SPARKSEE User Manual for more details on this.

Author

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

Function Documentation

def sparksee.load_edges_csv	(		self,
			graph,
			file_name,
			edge_type,
			tail_node_type,
			head_node_type,
			tail,
			head,
			separator,
			directed,
			header,
			on_missing_tail,
			on_missing_head,
			columns,
			attr_names,
			data_types,
			attr_kinds
	)

Loads edges from a CSV file.

nodeType[in] The type of the edge to load. If it does not exist, it creates it

Parameters

graph	[in] The graph to load the edges into
file_name	[in] The name of the file
edge_type	null
tail_node_type	[in] The type of the tail nodes. If it does not exist and onMissingTail is set to "Create", it creates it. Otherwise, an exception is thrown
head_node_type	[in] The type of the head nodes. It it does not exist and onMissingHead is set to "Create", it creates it. Otherwise, an exception is thrown
tail	[in] The tail column index. Default: 0
head	[in] The head column index. Default: 1
separator	[in] The column separator. Default: ","
directed	[in] True if this edge is directed or not. False otherwise. Default: True
header	[in] True if the CSV contains a header. False otherwise. Default: True
on_missing_tail	[in] The policy to follow when a tail is missing. Default: "IsError"
on_missing_head	[in] The policy to follow when a head is missing. Default: "IsError"
columns	[in] The list of columns to load. tail and head columns must be in this list if this list is specified. If the list is empty, all columns are loaded. Default: empty
attr_names	[in] The attribute names. If this list is empty and hasHeader is set to true, the header values are used as attribute names. Default: empty
data_types	[in] The dataTypes of the attributes if this do not already exist. If this list is empty, the method tries to infer the data type from the first non-header row. Default: empty
attr_kinds	[in] The attributeKinds of the attributes if these do not already exist. If this list is empty, the attributeKind of the created attributes are set to Basic. Default: empty

def sparksee.load_nodes_csv	(		self,
			graph,
			file_name,
			node_type,
			separator,
			header,
			columns,
			attr_names,
			data_types,
			attr_kinds
	)

Loads nodes from a CSV file.

Parameters

graph	[in] The graph to load the nodes into
file_name	[in] The name of the file
node_type	[in] The type of the node to load. If it does not exist, it creates it
separator	[in] The separator of the CSV file. Default: ","
header	[in] True if the CSV contains a header. False otherwise. Default: True
columns	[in] The list of columns to load. tail and head columns mus be in this list if this list is specified. Default: all columns
attr_names	[in] The attribute names. If this list is empty and hasHeader is set to true, the header values are used as attribute names. Default: empty
data_types	[in] The dataTypes of the attributes if this do not already exist. Default: empty If this list is empty, the method tries to infer the data type from the first non-header row
attr_kinds	[in] The attributeKinds of the attributes if these do not already exist. Default: empty If this list is empty, the attributeKind of the created attributes are set to Basic. Default: empty