com.sparsity.sparksee.algorithms
Class CommunityDetection

java.lang.Object
  extended by com.sparsity.sparksee.algorithms.CommunityDetection
All Implemented Interfaces:
java.io.Closeable
Direct Known Subclasses:
DisjointCommunityDetection

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

CommunityDetection 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

Method Summary
 void addAllNodeTypes()
          Allows connectivity through all node types of the graph.
 void addNodeType(int type)
          Allows connectivity through nodes of the given type.
 void close()
          Closes the CommunityDetection instance.
 void excludeEdges(Objects edges)
          Set which edges can't be used.
 void excludeNodes(Objects nodes)
          Set which nodes can't be used.
 boolean isClosed()
          Gets if CommunityDetection instance has been closed or not.
 void run()
          Runs the algorithm in order to find the connected components.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

addNodeType

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

Parameters:
type - null

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.

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 CommunityDetection instance has been closed or not.

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

close

public void close()
Closes the CommunityDetection instance.

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

Specified by:
close in interface java.io.Closeable