sparksee.Traversal Class Reference

Traversal class. More...

Inheritance diagram for sparksee.Traversal:

Public Member Functions
	exclude_nodes (self, nodes)
	Set which nodes can't be used.
	has_next (self)
	Gets if there are more objects to be traversed.
	__iter__ (self)
	Gets a new TraversalIterator.
	add_all_edge_types (self, dir)
	Allows for traversing all edge types of the graph.
	exclude_edges (self, edges)
	Set which edges can't be used.
	__next__ (self)
	Return the next item from the container.
	add_edge_type (self, type, dir)
	Allows for traversing edges of the given type.
	get_current_depth (self)
	Returns the depth of the current node.
	add_node_type (self, type)
	Allows for traversing nodes of the given type.
	next (self)
	Gets the next object of the traversal.
	close (self)
	Closes the Traversal instance.
	add_all_node_types (self)
	Allows for traversing all node types of the graph.
	set_maximum_hops (self, maxhops)
	Sets the maximum hops restriction.
	is_closed (self)
	Gets if Traversal has been closed or not.

Detailed Description

Traversal class.

Any class implementing this abstract class can be used to traverse a graph.

Once the instance has been created and the allowed node and edge types has been set, it can be used as an iterator, retrieving the next object identifier of the traversal until there are no more.

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

Author

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

Member Function Documentation

__iter__()

sparksee.Traversal.__iter__

(

self

)

Gets a new TraversalIterator.

Returns

TraversalIterator instance

__next__()

sparksee.Traversal.__next__

(

self

)

Return the next item from the container.

If there are no further items, raise the StopIteration exception.

Returns

The next element

add_all_edge_types()

sparksee.Traversal.add_all_edge_types	(		self,
			dir )

Allows for traversing all edge types of the graph.

Parameters

dir	[in] Edge direction.

Reimplemented in sparksee.RandomWalk, sparksee.TraversalBFS, and sparksee.TraversalDFS.

add_edge_type()

sparksee.Traversal.add_edge_type	(		self,
			type,
			dir )

Allows for traversing edges of the given type.

Parameters

type	[in] Edge type.
dir	[in] Edge direction.

Reimplemented in sparksee.RandomWalk, sparksee.TraversalBFS, and sparksee.TraversalDFS.

add_node_type()

sparksee.Traversal.add_node_type	(		self,
			type )

Allows for traversing nodes of the given type.

Parameters

type	The node type to add

Reimplemented in sparksee.RandomWalk, sparksee.TraversalBFS, and sparksee.TraversalDFS.

close()

sparksee.Traversal.close

(

self

)

Closes the Traversal instance.

It must be called to ensure the integrity of all data.

exclude_edges()

sparksee.Traversal.exclude_edges	(		self,
			edges )

Set which edges can't be used.

This will replace any previously specified set of excluded edges. Should only be used to exclude the usage of specific edges from allowed edge types because it's less efficient than not allowing an edge type.

Parameters

edges

[in] A set of edge identifiers that must be kept intact until the destruction of the class.

Reimplemented in sparksee.RandomWalk, sparksee.TraversalBFS, and sparksee.TraversalDFS.

exclude_nodes()

sparksee.Traversal.exclude_nodes	(		self,
			nodes )

Set which nodes can't be used.

This will replace any previously specified set of excluded nodes. Should only be used to exclude the usage of specific nodes from allowed node types because it's less efficient than not allowing a node type.

Parameters

nodes

[in] A set of node identifiers that must be kept intact until the destruction of the class.

Reimplemented in sparksee.RandomWalk, sparksee.TraversalBFS, and sparksee.TraversalDFS.

get_current_depth()

sparksee.Traversal.get_current_depth

(

self

)

Returns the depth of the current node.

That is, it returns the depth of the node returned in the last call to Next().

Returns

The depth of the current node.

Reimplemented in sparksee.RandomWalk, sparksee.TraversalBFS, and sparksee.TraversalDFS.

has_next()

sparksee.Traversal.has_next

(

self

)

Gets if there are more objects to be traversed.

Returns

TRUE if there are more objects, FALSE otherwise.

Reimplemented in sparksee.RandomWalk, sparksee.TraversalBFS, and sparksee.TraversalDFS.

is_closed()

sparksee.Traversal.is_closed

(

self

)

Gets if Traversal has been closed or not.

See also

close()

Returns

TRUE if the Traversal instance has been closed, FALSE otherwise.

next()

sparksee.Traversal.next

(

self

)

Gets the next object of the traversal.

Returns

A node or edge identifier.

Reimplemented in sparksee.RandomWalk, sparksee.TraversalBFS, and sparksee.TraversalDFS.

set_maximum_hops()

sparksee.Traversal.set_maximum_hops	(		self,
			maxhops )

Sets the maximum hops restriction.

All paths longer than the maximum hops restriction will be ignored.

Parameters

maxhops

[in] The maximum hops restriction. It must be positive or zero. Zero, the default value, means unlimited.

Reimplemented in sparksee.RandomWalk, sparksee.TraversalBFS, and sparksee.TraversalDFS.