Inheritance diagram for com.sparsity.sparksee.algorithms.Traversal:

Public Member Functions
void	AddNodeType (int type)
	Allows for traversing nodes of the given type.

bool	HasNext ()
	Gets if there are more objects to be traversed.

void	ExcludeNodes (com.sparsity.sparksee.gdb.Objects nodes)
	Set which nodes can't be used.

void	SetMaximumHops (int maxhops)
	Sets the maximum hops restriction.

void	AddAllEdgeTypes (com.sparsity.sparksee.gdb.EdgesDirection dir)
	Allows for traversing all edge types of the graph.

int	GetCurrentDepth ()
	Returns the depth of the current node.

boolean	IsClosed ()
	Gets if Traversal instance has been closed or not.

void	AddAllNodeTypes ()
	Allows for traversing all node types of the graph.

void	Close ()
	Closes the Traversal instance.

void	AddEdgeType (int type, com.sparsity.sparksee.gdb.EdgesDirection dir)
	Allows for traversing edges of the given type.

long	Next ()
	Gets the next object of the traversal.

void	ExcludeEdges (com.sparsity.sparksee.gdb.Objects edges)
	Set which edges can't be used.

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

void com.sparsity.sparksee.algorithms.Traversal.AddAllEdgeTypes ( com.sparsity.sparksee.gdb.EdgesDirection dir )

Allows for traversing all edge types of the graph.

Parameters

dir	[in] Edge direction.

void com.sparsity.sparksee.algorithms.Traversal.AddEdgeType	(	int	type,
		com.sparsity.sparksee.gdb.EdgesDirection	dir
	)

Allows for traversing edges of the given type.

Parameters

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

void com.sparsity.sparksee.algorithms.Traversal.AddNodeType ( int type )

Allows for traversing nodes of the given type.

Parameters

type	The node type to add

void com.sparsity.sparksee.algorithms.Traversal.Close ( )

Closes the Traversal instance.

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

void com.sparsity.sparksee.algorithms.Traversal.ExcludeEdges ( com.sparsity.sparksee.gdb.Objects 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.

void com.sparsity.sparksee.algorithms.Traversal.ExcludeNodes ( com.sparsity.sparksee.gdb.Objects 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.

int com.sparsity.sparksee.algorithms.Traversal.GetCurrentDepth ( )

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.

bool com.sparsity.sparksee.algorithms.Traversal.HasNext ( )

Gets if there are more objects to be traversed.

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

boolean com.sparsity.sparksee.algorithms.Traversal.IsClosed ( )

Gets if Traversal instance has been closed or not.

See Also: Close()

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

long com.sparsity.sparksee.algorithms.Traversal.Next ( )

Gets the next object of the traversal.

Returns: A node or edge identifier.

void com.sparsity.sparksee.algorithms.Traversal.SetMaximumHops ( int 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.

Public Member Functions

Detailed Description

Member Function Documentation