com.sparsity.sparksee.algorithms
Class Connectivity

java.lang.Object
  extended by com.sparsity.sparksee.algorithms.Connectivity
All Implemented Interfaces:
java.io.Closeable
Direct Known Subclasses:
StrongConnectivity, WeakConnectivity

public class Connectivity
extends java.lang.Object
implements java.io.Closeable

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 or 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

Method Summary
 void addAllNodeTypes()
          Allows connectivity through all node types of the graph.
 void addNodeType(int t)
          Allows connectivity through nodes of the given type.
 void close()
          Closes the Connectivity instance.
 void excludeEdges(Objects edges)
          Set which edges can't be used.
 void excludeNodes(Objects nodes)
          Set which nodes can't be used.
 ConnectedComponents getConnectedComponents()
          Returns the results generated by the execution of the algorithm.
 boolean isClosed()
          Gets if Connectivity instance has been closed or not.
 void run()
          Runs the algorithm in order to find the connected components.
 void setMaterializedAttribute(java.lang.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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

addAllNodeTypes

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


run

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

This method can be called only once.


excludeNodes

public void excludeNodes(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.

addNodeType

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

Parameters:
t - null

setMaterializedAttribute

public void setMaterializedAttribute(java.lang.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.

excludeEdges

public void excludeEdges(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.

isClosed

public boolean isClosed()
Gets if Connectivity instance has been closed or not.

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

close

public void close()
Closes the Connectivity instance.

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

Specified by:
close in interface java.io.Closeable

getConnectedComponents

public ConnectedComponents 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.