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

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

All Implemented Interfaces:

java.io.Serializable, Component, Algorithm, Model

public class NormanGirvanEdgeBetweenessClustering
extends ModelShell
implements Algorithm

Class implementing NormanGirvan edge betweeness clustering. This differs from traditional edge betweeness clustering by recalculating edge-betweeness after every edge is removed. Girvan, M. and M. Newman. 2002. "Community structure in social and biological networks." Proceedings of the National Academy of Science. 99(12):7821-6.

See Also:

Serialized Form

Field Summary

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

listener

Constructor Summary

NormanGirvanEdgeBetweenessClustering()

Method Summary

protected void	calculateBetweeness(Graph root, Duples<java.lang.Double,Link>[] orderedBetweeness)
void	execute(Graph g) execute the algorithm against the given graph
protected Graph	getGraph(Graph g, java.util.HashSet<Actor> component, java.lang.String prefix)
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.
NormanGirvanEdgeBetweenessClustering	prototype() All Components implement the prototype pattern.
protected void	splitGraph(Graph base, java.lang.String prefix)

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

NormanGirvanEdgeBetweenessClustering

public NormanGirvanEdgeBetweenessClustering()

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

splitGraph

protected void splitGraph(Graph base,
                          java.lang.String prefix)

calculateBetweeness

protected void calculateBetweeness(Graph root,
                                   Duples<java.lang.Double,Link>[] orderedBetweeness)

getGraph

protected Graph getGraph(Graph g,
                         java.util.HashSet<Actor> component,
                         java.lang.String prefix)

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. 'normalize' - boolean for whether or not to normalize prestige vectors. Default 'false'.

Input 0 - Link
NOTE - subclasses define the ouput - see subclasses for output information

Specified by:

init in interface Component

Parameters:

map - parameters to be loaded - may be null.

prototype

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