nz.ac.waikato.mcennis.rat.graph.algorithm.visual
Class DisplayAll

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

All Implemented Interfaces:

java.io.Serializable, Component, Algorithm, Model

public class DisplayAll
extends ModelShell
implements Algorithm

Class that displays an entire graph inside a Prefuse display window. Each relation is assigned a color. Each actor is assigned a color. Properties are accessed via a side panel, where relation name and ID are displayed.

See Also:

Serialized Form

Field Summary

static float[]

CATEGORY_HUES

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

listener

Constructor Summary

DisplayAll()
create a new display algorithm with deafult properties

Method Summary

void	execute(Graph g) execute the algorithm against the given graph
static int[]	getCategoryPalette(int size, float s1, float s2, float b, float a) Stolen from BSD licensed Jung2 toolkit.
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 the algorithm.

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

CATEGORY_HUES

public static final float[] CATEGORY_HUES

Constructor Detail

DisplayAll

public DisplayAll()

create a new display algorithm with deafult properties

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

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)

Initializes the algorithm. Only accepts the name of the algorithm as a property. 'name' key with default value 'Display Graph'.

Specified by:

init in interface Component

Parameters:

map - property set to initialize the algorithm with.

getCategoryPalette

public static int[] getCategoryPalette(int size,
                                       float s1,
                                       float s2,
                                       float b,
                                       float a)

Stolen from BSD licensed Jung2 toolkit. Copyright authors of the original //TODO: Restore original BSD license to this procedure Returns a color palette of given size tries to provide colors appropriate as category labels. There are 12 basic color hues (red, orange, yellow, olive, green, cyan, blue, purple, magenta, and pink). If the size is greater than 12, these colors will be continually repeated, but with varying saturation levels.

Parameters:

size - the size of the color palette

s1 - the initial saturation to use

s2 - the final (most distant) saturation to use

b - the brightness value to use

a - the alpha value to use