nz.ac.waikato.mcennis.rat.graph.algorithm.clustering
Class FindStronglyConnectedComponents

java.lang.Object
  nz.ac.waikato.mcennis.rat.graph.model.ModelShell
      nz.ac.waikato.mcennis.rat.graph.algorithm.clustering.FindStronglyConnectedComponents

All Implemented Interfaces:

java.io.Serializable, Component, Algorithm, Listener, Model

public class FindStronglyConnectedComponents
extends ModelShell
implements Algorithm, Listener

Algorithm for finding all strongly connected components in a graph. Uses Robert Tarjan's algorithm for finding components in linear time. Tarjan, R. 1972. Depth-first search and linear graph algorithms. Society of Industrial and Applied Mathematics. 1(20):146--160

See Also:

Serialized Form

Field Summary

Fields inherited from class nz.ac.waikato.mcennis.rat.graph.model.ModelShell

listener

Constructor Summary

FindStronglyConnectedComponents()

Method Summary

void	execute(Graph g) execute the algorithm against the given graph
java.util.List<IODescriptor>	getInputType() The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object.
java.util.List<IODescriptor>	getOutputType() The output type describes all the different kinds of graph objects that are created during the execution of this algorithm.
Properties	getParameter() List of all parameters this component accepts.
Parameter	getParameter(java.lang.String param) Returns the specific parameter identified by its key-name.
void	init(Properties map) Parameters to be initialized.
FindStronglyConnectedComponents	prototype() All Components implement the prototype pattern.
void	publishChange(Model m, int type, int argument) Recieve and update of the given type.

Methods inherited from class nz.ac.waikato.mcennis.rat.graph.model.ModelShell

addListener, fireChange

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nz.ac.waikato.mcennis.rat.graph.model.Model

addListener

Constructor Detail

FindStronglyConnectedComponents

public FindStronglyConnectedComponents()

Method Detail

execute

public void execute(Graph g)

Description copied from interface: Algorithm

execute the algorithm against the given graph

Specified by:

execute in interface Algorithm

Parameters:

g - graph to be modified

getInputType

public java.util.List<IODescriptor> getInputType()

Description copied from interface: Component

The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object. This result is only guaranteed to be fixed if structural parameters are not modified. This is an empty array if there is no input.

Specified by:

getInputType in interface Component

Returns:

IODescriptor array for this component

See Also:

IODescriptor

getOutputType

public java.util.List<IODescriptor> getOutputType()

Description copied from interface: Component

The output type describes all the different kinds of graph objects that are created during the execution of this algorithm. The result is only guaranteed to be fixed if structural parameters are not modified. This is an empty array if there is no output.

Specified by:

getOutputType in interface Component

Returns:

IODescriptor array for this component

See Also:

IODescriptor

getParameter

public Properties getParameter()

Description copied from interface: Component

List of all parameters this component accepts. Each parameter also has a distinct key-name used when initializing the object using the init method. If there are no parameters, null is returned.

Specified by:

getParameter in interface Component

Returns:

read-only array of Parameters

getParameter

public Parameter getParameter(java.lang.String param)

Description copied from interface: Component

Returns the specific parameter identified by its key-name. If no parameter is found with this key-name, null is returned.

Specified by:

getParameter in interface Component

Parameters:

param - key-name of the parameter

Returns:

named parameter

init

public void init(Properties map)

Parameters to be initialized. Subclasses should override if they provide any additional parameters or require additional inputs.

1. 'name' - Name of this instance of the algorithm. Default is ''.
2. 'relation' - type (relation) of link to calculate over. Default 'Knows'.
3. 'actorType' - type (mode) of actor to calculate over. Deafult 'User'.
4. 'graphClass' - graph class used to create subgraphs
5. 'graphIDprefix' - prefix used for graphIDs.

Input 0 - Link
Output 0 - Graph

Specified by:

init in interface Component

Parameters:

map - map of the given properties naming parameters and their values in a string

publishChange

public void publishChange(Model m,
                          int type,
                          int argument)

Description copied from interface: Listener

Recieve and update of the given type.

Specified by:

publishChange in interface Listener

Parameters:

m - model that changed

type - type of change that has occured

prototype

public FindStronglyConnectedComponents prototype()

Description copied from interface: Component

All Components implement the prototype pattern. The new parameter has no common resources to the original that are not static resources o the class.

Specified by:

prototype in interface Component

Specified by:

prototype in interface Algorithm

Returns:

default-parameter version of the same class as the original.