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

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

All Implemented Interfaces:

java.io.Serializable, Component, Algorithm, Model

public class AddMusicReferences
extends ModelShell
implements Algorithm

Class that takes interest links, determines which are artists, then creates an artist actor and links the user to this artist.

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

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

listener

Constructor Summary

AddMusicReferences()
Creates a new instance of AddMusicReferences

Method Summary

void	execute(Graph g) Takes interest links, determines which are artists, then creates an artist actor and links the user to this artist.
ArtistDecider	getDecider() Returns the decider that will be used to identify artists from non-artists.
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 object.
void	setDecider(ArtistDecider d) Sets the decider that this object uses.

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

AddMusicReferences

public AddMusicReferences()

Creates a new instance of AddMusicReferences

Method Detail

setDecider

public void setDecider(ArtistDecider d)

Sets the decider that this object uses.

Parameters:

d - chosen decider

getDecider

public ArtistDecider getDecider()

Returns the decider that will be used to identify artists from non-artists.

Returns:

decider for this object

execute

public void execute(Graph g)

Takes interest links, determines which are artists, then creates an artist actor and links the user to this artist.

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)

Parameters for initialization of this object.

1. 'name' - Name of this instance of the algorithm. Default is 'Music References'.
2. 'relation' - type (relation) of the link to be created. Default is 'Given'.
3. 'actorSourceType' - type (mode) of actor to pull interests from. Default is 'User'.
4. 'actorDestinationType' - type (mode) of actor (artist) to create. Default is 'Artist'.
5. 'propertyType' - name of the property on 'actorSourceType' that defines interests to be analyzed. Default is 'interest'.
6. 'deciderType' - class of decider to create. Default is 'basic'.
7. 'deciderLocation' - location of list of artists. Default is '/tmp/artist.txt'
8. 'actorDestinationClass' - class of actor to create. Default is 'Basic'

NOTE: properties are also fed to Decider Factory
@see nz.ac.waikato.mcennis.rat.graph.artist.decider.DeciderFactory

Input 1 - Actor Property
Output 1 - Actor
Output 2 - Link

Specified by:

init in interface Component

Parameters:

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