sparksee.TraversalBFS Class Reference

Breadth-First Search implementation of Traversal. More...

Inheritance diagram for sparksee.TraversalBFS:

Inheritance graph
Collaboration diagram for sparksee.TraversalBFS:

Collaboration graph

List of all members.

Public Member Functions

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


Detailed Description

Breadth-First Search implementation of Traversal.

Starting from a source node, it visits all its neighbors at distance 1, then all its neighbors at distance 2, and so on.

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

def sparksee.TraversalBFS.__init__ (   self,
  session,
  node 
)

Creates a new instance.

Parameters:
session [in] Session to get the graph from and perform traversal.
node [in] Node to start traversal from.

def sparksee.TraversalBFS.add_node_type (   self,
  type 
)

Allows for traversing nodes of the given type.

Parameters:
type null

Reimplemented from sparksee.Traversal.

def sparksee.TraversalBFS.has_next (   self  ) 

Gets if there are more objects to be traversed.

Returns:
TRUE if there are more objects, FALSE otherwise.

Reimplemented from sparksee.Traversal.

def sparksee.TraversalBFS.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 from sparksee.Traversal.

def sparksee.TraversalBFS.add_edge_type (   self,
  type,
  dir 
)

Allows for traversing edges of the given type.

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

Reimplemented from sparksee.Traversal.

def sparksee.TraversalBFS.next (   self  ) 

Gets the next object of the traversal.

Returns:
A node or edge identifier.

Reimplemented from sparksee.Traversal.

def sparksee.TraversalBFS.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 from sparksee.Traversal.

def sparksee.TraversalBFS.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 from sparksee.Traversal.

def sparksee.TraversalBFS.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 from sparksee.Traversal.

def sparksee.TraversalBFS.add_all_edge_types (   self,
  dir 
)

Allows for traversing all edge types of the graph.

Parameters:
dir [in] Edge direction.

Reimplemented from sparksee.Traversal.

def sparksee.Traversal.is_closed (   self  )  [inherited]

Gets if Traversal has been closed or not.

See also:
close()
Returns:
TRUE if the Traversal instance has been closed, FALSE otherwise.

def sparksee.Traversal.__next__ (   self  )  [inherited]

Used in next().

Returns:
The next element

def sparksee.Traversal.close (   self  )  [inherited]

Closes the Traversal instance.

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

def sparksee.Traversal.__iter__ (   self  )  [inherited]

Gets a new TraversalIterator.

Returns:
TraversalIterator instance


Generated on Tue Jun 2 16:12:31 2015 for SparkseePython by  doxygen 1.5.6