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

Public Member Functions
boolean	IsClosed ()
	Gets if Connectivity instance has been closed or not.

void	AddAllNodeTypes ()
	Allows connectivity through all node types of the graph.

void	Close ()
	Closes the Connectivity instance.

void	Run ()
	Runs the algorithm in order to find the connected components.

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

void	AddNodeType (int t)
	Allows connectivity through nodes of the given type.

void	SetMaterializedAttribute (System.String attributeName)
	Creates a new common attribute type for all node types in the graph in order to store, persistently, the results related to the connected components found while executing this algorithm.

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

com.sparsity.sparksee.algorithms.ConnectedComponents	GetConnectedComponents ()
	Returns the results generated by the execution of the algorithm.

Detailed Description

Connectivity class.

Any class implementing this abstract class can be used to solve a problem related to graph connectivity as finding the strongly connected components, finding the weakly connected components.

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.Connectivity.AddNodeType ( int t )

Allows connectivity through nodes of the given type.

Parameters

t null

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

Closes the Connectivity instance.

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

void com.sparsity.sparksee.algorithms.Connectivity.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.Connectivity.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.

com.sparsity.sparksee.algorithms.ConnectedComponents com.sparsity.sparksee.algorithms.Connectivity.GetConnectedComponents ( )

Returns the results generated by the execution of the algorithm.

These results contain information related to the connected components found as the number of different components, the set of nodes contained in each component or many other data.

Returns: Returns an instance of the class ConnectedComponents which contain information related to the connected components found.

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

Gets if Connectivity instance has been closed or not.

See Also: Close()

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

void com.sparsity.sparksee.algorithms.Connectivity.Run ( )

Runs the algorithm in order to find the connected components.

This method can be called only once.

void com.sparsity.sparksee.algorithms.Connectivity.SetMaterializedAttribute ( System.String attributeName )

Creates a new common attribute type for all node types in the graph in order to store, persistently, the results related to the connected components found while executing this algorithm.

Whenever the user wants to retrieve the results, even when the graph has been closed and opened again, it is only necessary to create a new instance of the class ConnectedComponents indicating the graph and the name of the common attribute type which stores the results. This instance will have all the information related to the connected components found in the moment of the execution of the algorithm that stored this data.

It is possible to run the algorithm without specifying this parameter in order to avoid materializing the results of the execution.

Parameters

attributeName [in] The name of the common attribute type for all node types in the graph which will store persistently the results generated by the execution of the algorithm.

Public Member Functions

Detailed Description

Member Function Documentation