nz.ac.waikato.mcennis.rat.graph.algorithm.similarity
Class GraphSimilarityByProperty

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

All Implemented Interfaces:

java.io.Serializable, Component, Algorithm, Model

public class GraphSimilarityByProperty
extends ModelShell
implements Algorithm

Calculates the similarity between two graphs by a given property.

See Also:

Serialized Form

Field Summary

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

listener

Constructor Summary

GraphSimilarityByProperty()
Create a new graph similarity algorithm with deafult parameters.

Method Summary

void	execute(Graph g) execute the algorithm against the given graph
protected DataVector	getDataVector(Property type)
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 this algorithm.
GraphSimilarityByProperty	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

GraphSimilarityByProperty

public GraphSimilarityByProperty()

Create a new graph similarity algorithm with deafult 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

getDataVector

protected DataVector getDataVector(Property type)

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 this algorithm. Deafult is 'Graph Simlarity By Property'
• byChildren: Should graphs be chosen by being children of the given graph. Default is 'true'
• pattern: Regular expression describing the graph IDs to be included in this calculation. The closest-to-root graph matching this pattern is used. Deafult is '.*'
• distanceFunction: Which distance functiuon to use. Default is 'EuclideanDistance'
• sourceProperty: Which property contains the double[] to use as source data. Default is 'Directed Triples Histogram'
• threshold: Threshold for declaring two graphs similar. Default is '0.75'
• destinationProperty: Property for storing graph similarity. This is stored as duples<GraphID,Double>. Deafult is 'Similarity'

Specified by:

init in interface Component

Parameters:

map - parameters to be loaded - may be null

prototype

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