nz.ac.waikato.mcennis.rat.graph.algorithm
Class GeodesicProperties

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

All Implemented Interfaces:

java.io.Serializable, Component, Algorithm, Model

public class GeodesicProperties
extends ModelShell
implements Algorithm

Calculates properties of a node: (In/Out) Eccentricity - Wasserman and Faust p111 - modified for directional links
Diameter - Wasserman and Faust p111. Modified to be longest non-infinite geodesic path, eliminating infinite diameters.
Wasserman, S., and K. Faust. 1997. Social Network Analysis. New York: Cambridge University Press.

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

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

listener

Constructor Summary

GeodesicProperties()
Creates a new instance of AddGeodesicProperties

Method Summary

protected void	addDiameter(Graph g) Diamter defined as the longest geodesic path.
protected void	addInEccentricity(Graph g, ActorQuery mode)
protected void	addOutEccentricity(Graph g, ActorQuery mode)
void	execute(Graph g) Calculates properties of a node: (In/Out) Eccentricity - Wasserman and Faust p111 - modified for directional links Diameter - Wasserman and Faust p111.
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 for initialization of this algorithm 'name' - name of this isntance.
GeodesicProperties	prototype() All Components implement the prototype pattern.

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

GeodesicProperties

public GeodesicProperties()

Creates a new instance of AddGeodesicProperties

Method Detail

execute

public void execute(Graph g)

Calculates properties of a node: (In/Out) Eccentricity - Wasserman and Faust p111 - modified for directional links
Diameter - Wasserman and Faust p111. Modified to be longest non-infinite geodesic path, eliminating infinite diameters.
Wasserman, S., and K. Faust. 1997. Social Network Analysis. New York: Cambridge University Press.

Specified by:

execute in interface Algorithm

Parameters:

g - graph to be modified

addInEccentricity

protected void addInEccentricity(Graph g,
                                 ActorQuery mode)

addOutEccentricity

protected void addOutEccentricity(Graph g,
                                  ActorQuery mode)

addDiameter

protected void addDiameter(Graph g)

Diamter defined as the longest geodesic path. Avoids problems of infinite or undefined diamters if some actors are poorly connected.

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 for initialization of this algorithm

1. 'name' - name of this isntance. Default is 'Geodesic Properties'.
2. 'relation' - type (relation) of link to use. Default is 'Knows'.
3. 'actorType' - type (mode) of actor to use. Default is 'User'.

Input 1 - Path
Output 1 - Actor Property
Output 2 - Actor Property
Output 3 - Graph Property

Specified by:

init in interface Component

Parameters:

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

prototype

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