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

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

All Implemented Interfaces:

java.io.Serializable, Component, Algorithm, Model

public class AddDegreeGraphProperties
extends ModelShell
implements Algorithm

Add basic degree-based properties for actors and graphs.

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

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

listener

Constructor Summary

AddDegreeGraphProperties()
Creates a new instance of AddDegreeGraphProperties

Method Summary

void	calculateAbsoluteDensity(Graph g) Calculate the density of the graph using the absolute value of all link strengths
void	calculateDensity(Graph g) Calculate the density of the graph
void	calculateInDegree(Graph g) Calculate the in-degree of each node.
void	calculateOutDegree(Graph g) Calculate the out-degree of each node.
void	execute(Graph g) execute the algorithm against the given graph
protected Actor[]	getActor(Graph g)
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 for initialization of this algorithm 'name' - name of this isntance.

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

AddDegreeGraphProperties

public AddDegreeGraphProperties()

Creates a new instance of AddDegreeGraphProperties

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

calculateInDegree

public void calculateInDegree(Graph g)

Calculate the in-degree of each node.

Parameters:

g - the graph to be modified

calculateOutDegree

public void calculateOutDegree(Graph g)

Calculate the out-degree of each node.

Parameters:

g - the graph to be modified

calculateAbsoluteDensity

public void calculateAbsoluteDensity(Graph g)

Calculate the density of the graph using the absolute value of all link strengths

Parameters:

g - the graph to be modified

calculateDensity

public void calculateDensity(Graph g)

Calculate the density of the graph

Parameters:

g - the graph to be modified

getActor

protected Actor[] getActor(Graph g)

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()

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

init

public void init(java.util.Properties map)

Parameters for initialization of this algorithm

1. 'name' - name of this isntance. Default is 'Degree Graph 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 - Link
Output 1 - Actor Property
Output 2 - Actor Property
Output 3 - Graph Property
Output 4 - Graph Property

Specified by:

init in interface Component

Parameters:

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