nz.ac.waikato.mcennis.rat.graph.algorithm.prestige
Class OptimizedLinkBetweeness

java.lang.Object
  extended by nz.ac.waikato.mcennis.rat.graph.model.ModelShell
      extended by nz.ac.waikato.mcennis.rat.graph.algorithm.prestige.OptimizedLinkBetweeness
All Implemented Interfaces:
java.io.Serializable, Component, Algorithm, Listener, Model

public class OptimizedLinkBetweeness
extends ModelShell
implements Algorithm, Listener

Class built upon OptimizedPathBase that calculates Betweeness for links. OptimizedPathBase only records one geodesic path for each actor pair, otherwise same as the betweeness metric deefined in Freeman79.

Freeman, L. "Centrality in social networks: I. Conceptual clarification." Social Networks. 1:215--239.

See Also:
Serialized Form

Field Summary
protected  OptimizedLinkBetweenessCore core
           
protected  double maxBetweeness
           
 
Fields inherited from class nz.ac.waikato.mcennis.rat.graph.model.ModelShell
listener
 
Constructor Summary
OptimizedLinkBetweeness()
          Creates a new instance of OptimizedBetweeness
 
Method Summary
protected  void doCleanup(PathNode[] path, Graph g)
           
 void execute(Graph g)
          execute the algorithm against the given graph
 InputDescriptor[] getInputType()
          The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object.
 OutputDescriptor[] getOutputType()
          The output type describes all the different kinds of graph objects that are created during the execution of this algorithm.
 Parameter[] getParameter()
          List of all parameters this component accepts.
 Parameter getParameter(java.lang.String param)
          Returns the specific parameter identified by its key-name.
 SettableParameter[] getSettableParameter()
          Returns settable (i.e.
 SettableParameter getSettableParameter(java.lang.String param)
          Return the settable parameter namede by this key-name.
 void init(java.util.Properties map)
          Parameters to be initialized.
 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
 

Field Detail

maxBetweeness

protected double maxBetweeness

core

protected OptimizedLinkBetweenessCore core
Constructor Detail

OptimizedLinkBetweeness

public OptimizedLinkBetweeness()
Creates a new instance of OptimizedBetweeness

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

doCleanup

protected void doCleanup(PathNode[] path,
                         Graph g)

getSettableParameter

public SettableParameter[] getSettableParameter()
Description copied from interface: Component
Returns settable (i.e. editable while running) parameters. If none exist, null is returned.

Specified by:
getSettableParameter in interface Component
Returns:
array of settable parameters

getSettableParameter

public SettableParameter getSettableParameter(java.lang.String param)
Description copied from interface: Component
Return the settable parameter namede by this key-name. If this parameter is not found or is not settable, null is returned.

Specified by:
getSettableParameter in interface Component
Parameters:
param - key-name of the parameter
Returns:
named settable parameter

getInputType

public InputDescriptor[] 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:
InputDescriptor array for this component
See Also:
InputDescriptor

getOutputType

public OutputDescriptor[] 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:
OutputDescriptor array for this component
See Also:
OutputDescriptor

getParameter

public Parameter[] 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(java.util.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
Output 0 - LinkProperty

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