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

java.lang.Object
  nz.ac.waikato.mcennis.rat.graph.model.ModelShell
      nz.ac.waikato.mcennis.rat.graph.algorithm.prestige.AddBasicBetweenessCentrality

All Implemented Interfaces:

java.io.Serializable, Component, Algorithm, Model

Direct Known Subclasses:

AddBetweenessCentrality

public class AddBasicBetweenessCentrality
extends ModelShell
implements Algorithm

Class for calculating Betweeness as described in Freeman 79 except that multiple geodesic paths between two actors are treated as if they are unique paths.

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

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

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

listener

Constructor Summary

AddBasicBetweenessCentrality()
Creates a new instance of AddBetweenessCentrality

Method Summary

protected void	calculateBetweeness(Graph g) Adds Betweeness properties to every actor of the given relation.
void	calculateBetweenessSD(Graph g) Calculates SD of betweeness as a graph property.
void	calculateGraphBetweeness(Graph g) Calculates mean betweeness as a graph property.
void	execute(Graph g) Implements betweeness as in Freeman79 except multiple geodesic paths of the same type are treated as independent geodesic paths.
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) Initializes this algorithm.
protected void	sumPath(int i, int j, PathSet pathSet) total sum of the number of times a node appears in a geodesic between two actors

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

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

AddBasicBetweenessCentrality

public AddBasicBetweenessCentrality()

Creates a new instance of AddBetweenessCentrality

Method Detail

execute

public void execute(Graph g)

Implements betweeness as in Freeman79 except multiple geodesic paths of the same type are treated as independent geodesic paths.
Freeman, L. "Centrality in social networks: I. Conceptual clarification." Social Networks. 1:215--239.

Specified by:

execute in interface Algorithm

Parameters:

g - graph to be modified

See Also:

nz.ac.waikato.mcennis.rat.graph.algorithm.AddBasicBetweenessCentrality#init

calculateBetweeness

protected void calculateBetweeness(Graph g)

Adds Betweeness properties to every actor of the given relation.

Parameters:

g - graph to be modified

calculateGraphBetweeness

public void calculateGraphBetweeness(Graph g)

Calculates mean betweeness as a graph property.

Parameters:

g - graph to be modified

calculateBetweenessSD

public void calculateBetweenessSD(Graph g)

Calculates SD of betweeness as a graph property.

Parameters:

g - graph to be modified

sumPath

protected void sumPath(int i,
                       int j,
                       PathSet pathSet)

total sum of the number of times a node appears in a geodesic between two actors

Parameters:

i - index fo the source actor

j - index of the destination actor

pathSet - set of all geodesic paths

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

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

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

init

public void init(java.util.Properties map)

Initializes this algorithm. Parameters are as follows:

• 'name' - (String) name of this algorithm in the application. All applications must have a unique ID so this may change. Default is 'Basic Betweeness'
• 'relation' - (String) name of the type (relation) of links to use. Default is 'Knows'
• 'actorType' - (String) name of the type (mode) of Actor to use. Default is 'User'
• 'normalize' - (Boolean) should Actor betweeness be nromalized so the sum of squares across acll actors of type relation is 1. Default is 'false'

Input - this algorithm consumes a Path object.
Output - this algorithm produces an Actor property and two Graph properties.

Specified by:

init in interface Component

Parameters:

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