sparksee.Context Class Reference

Context class. More...

List of all members.

Public Member Functions

def add_edge_type
 Allows for traversing edges of the given type.
def compute
 Helper method to easily compute a context from a node.
def exclude_nodes
 Set which nodes can't be used.
def compute
 Gets the resulting collection of nodes.
def is_closed
 Gets if Context has been closed or not.
def add_all_edge_types
 Allows for traversing all edge types of the graph.
def add_node_type
 Allows for traversing nodes of the given type.
def close
 Closes the Context instance.
def __init__
 Creates a new instance.
def add_all_node_types
 Allows for traversing all node types of the graph.
def set_maximum_hops
 Sets the maximum hops restriction.
def exclude_edges
 Set which edges can't be used.


Detailed Description

Context class.

It provides a very similar functionality than the Traversal classes. The main difference is Context returns a resulting collection whereas Traversal provides an iterator behaviour.

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.Context.add_edge_type (   self,
  t,
  d 
)

Allows for traversing edges of the given type.

Parameters:
t [in] Edge type.
d [in] Edge direction.

def sparksee.Context.compute (   self,
  session,
  node,
  nodeTypes,
  edgeTypes,
  dir,
  maxhops,
  include 
)

Helper method to easily compute a context from a node.

Parameters:
session [in] Session to get the graph from and perform operation.
node [in] Node to start traversal from.
nodeTypes [in] Allowed node type list. NULL means all node types are allowed.
edgeTypes [in] Allowed edge type list. NULL means all edge types are allowed.
dir [in] Allowed direction for the allowed edge types.
maxhops [in] The maximum hops restriction. It must be positive or zero. Zero, the default value, means unlimited.
include [in] If TRUE, the resulting collection will include those nodes at distance less or equal than the given one, otherwise it will just include those nodes at distance equal than the given one. This parameter just makes sense if maxhops is different from 0; in that case it includes all nodes no matters the distance.
Returns:
Returns an Objects with the computed context of a node.

def sparksee.Context.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.

def sparksee.Context.compute (   self  ) 

Gets the resulting collection of nodes.

Returns:
The resulting collection of nodes.

def sparksee.Context.is_closed (   self  ) 

Gets if Context has been closed or not.

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

def sparksee.Context.add_all_edge_types (   self,
  d 
)

Allows for traversing all edge types of the graph.

Parameters:
d [in] Edge direction.

def sparksee.Context.add_node_type (   self,
  t 
)

Allows for traversing nodes of the given type.

Parameters:
t null

def sparksee.Context.close (   self  ) 

Closes the Context instance.

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

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

Creates a new instance.

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

def sparksee.Context.set_maximum_hops (   self,
  maxhops,
  include 
)

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.
include [in] If TRUE, the resulting collection will include those nodes at distance less or equal than the given one, otherwise it will just include those nodes at distance equal than the given one. This parameter just makes sense if maxhops is different from 0; in that case it includes all nodes no matters the distance.

def sparksee.Context.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.


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