nz.ac.waikato.mcennis.rat.graph.algorithm.aggregators
Class AggregateOnActor

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

All Implemented Interfaces:

java.io.Serializable, Component, Algorithm, Model

public class AggregateOnActor
extends ModelShell
implements Algorithm

Class for Aggregating the properties of an actor into a single Instance object. Each property is transformed and then aggregated. Aggregation is first performed over the values of each property, then against all properties of each actor. This aggregation is repeated across all actors of a given mode.

See Also:

Serialized Form

Field Summary

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

listener

Constructor Summary

AggregateOnActor()
Create a new algorithm utilizing default parameters.

Method Summary

void	execute(Graph g) execute the algorithm against the given graph
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: name: Name of the algorithm.
AggregateOnActor	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

Constructor Detail

AggregateOnActor

public AggregateOnActor()

Create a new algorithm utilizing default parameters.

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 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:

• name: Name of the algorithm. Default is 'Aggregate On Actor'
• actorType: Mode of the actor to compare. Default is 'tag'
• innerAggregator: function for aggregating the values of properties on an actor. Default is 'nz.ac.waikato.mcennis.rat.graph.algorithm.reusablecores.aggregator.FirstItemAggregatorFunction'.
• outerAggregator: function for aggregating across properties of an actor. Default is 'nz.ac.waikato.mcennis.rat.graph.algorithm.reusablecores.aggregator.ConcatenationAggregator'
• actorProperty: Name of the property on each actor to store results into. Default is 'Actor Instance'.

Specified by:

init in interface Component

Parameters:

map - parameters to be loaded - may be null

prototype

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