Class DisjointCommunityDetection

java.lang.Object
com.sparsity.sparksee.algorithms.CommunityDetection
com.sparsity.sparksee.algorithms.DisjointCommunityDetection
All Implemented Interfaces:
Closeable, AutoCloseable
Direct Known Subclasses:
CommunitiesSCD
public class DisjointCommunityDetection extends CommunityDetection
DisjointCommunityDetection 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 Details

    • run

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

      This method can be called only once.

      Overrides:
      run in class CommunityDetection

    • 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.

      Overrides:
      excludeNodes in class CommunityDetection
      Parameters:
      nodes - [in] A set of node identifiers that must be kept intact until the destruction of the class.

    • addAllEdgeTypes

      public void addAllEdgeTypes()
      Allows connectivity through all edge types of the graph.

      The edges can be used in Any direction.

    • getCommunities

      public DisjointCommunities getCommunities()
      Returns the results generated by the execution of the algorithm.

      These results contain information related to the disjoint communities 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 DisjointCommunities which contain information related to the disjoint communities found.

    • addEdgeType

      public void addEdgeType(int type)
      Allows connectivity through edges of the given type.

      The edges can be used in Any direction.

      Parameters:
      type - [in] Edge type.

    • addNodeType

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

      Overrides:
      addNodeType in class CommunityDetection
      Parameters:
      type - null

    • 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.

      Overrides:
      excludeEdges in class CommunityDetection
      Parameters:
      edges - [in] A set of edge identifiers that must be kept intact until the destruction of the class.

    • setMaterializedAttribute

      public void setMaterializedAttribute(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 disjoint communities 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 DisjointCommunities 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 disjoint communities 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.

    • includeNodes

      public void includeNodes(Objects nodes)
      Set additional nodes that can be used.

      This will replace any previously specified set of include nodes. Using this optional method adds valid nodes to the nodes of any node type explicitly set as a valid type. Should only be used to include specific small sets of nodes because it's less efficient than just using a node type.

      Overrides:
      includeNodes in class CommunityDetection
      Parameters:
      nodes - [in] A set of node identifiers that must be kept intact until the destruction of the class.

    • addAllNodeTypes

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

      Overrides:
      addAllNodeTypes in class CommunityDetection

    • includeEdges

      public void includeEdges(Objects edges)
      Set additional edges that can be used.

      This will replace any previously specified set of include edges. Using this optional method adds valid edges to the edges of any edge type explicitly set as a valid type. Should only be used to include specific small sets of edges because it's less efficient than just using an edge type. For any edge to be used, both nodes must be also valid.

      Overrides:
      includeEdges in class CommunityDetection
      Parameters:
      edges - [in] A set of edge identifiers that must be kept intact until the destruction of the class.