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

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

All Implemented Interfaces:

java.io.Serializable, Component, Algorithm, Model

public class AddMusicRecommendations
extends ModelShell
implements Algorithm

Creates derived user->artist links from knows, interest, and music links. NOTE: Adheres to direction in links - music from unequal links not made bidirectional FIXME: does not include code for including betweeness scores in calculations.

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

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

listener

Constructor Summary

AddMusicRecommendations()
Creates a new instance of AddMusicRecommendations

Method Summary

double	calculateArtistWeight(Link knows, Link[] interest, Link[] music) Helper function that calculates artist weights based on shared links
void	execute(Graph g) Build a set of music recommendations based on existing links
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 initializing 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

AddMusicRecommendations

public AddMusicRecommendations()

Creates a new instance of AddMusicRecommendations

Method Detail

execute

public void execute(Graph g)

Build a set of music recommendations based on existing links

Specified by:

execute in interface Algorithm

Parameters:

g - graph to be modified

calculateArtistWeight

public double calculateArtistWeight(Link knows,
                                    Link[] interest,
                                    Link[] music)

Helper function that calculates artist weights based on shared links

Parameters:

knows - link to actor whose recommendations are to be extracted

interest - set of all interest links from the person to recommend music for

music - set of all music links from the person to recommend music for.

Returns:

recommendation strength for any music this friend listens to

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 initializing this algorithm

1. 'name' - name of this isntance. Default is 'Basic Music Recommendation'.
2. 'relation' - type (relation) of link to create. Default is 'Derived'.
3. 'actorType' - type (mode) of actor to use. Default is 'User'.
4. 'groundTruthType' - type (relation) of link representing given musical tastes. Default is 'Given'.
5. 'sourceType1' - type (relation) of link representing degree of shared interests. Default is 'Interest'
6. 'sourceType2' - type (relation) of link representing degree of shared music. Deafult is 'Music'.
7. 'adjustorPropertyType' - name of property defining prestige or centrality for actors. Default is'Knows Betweeness'
8. 'evaluation' - should the system supress 'Derived' links matching 'Given' links. Default is 'false'.
9. 'sourceType1Weight' - weight of 'sourceType1' links. Deafult '1.0'.
10. 'sourceType2Weight' - weight of 'sourceType2' links. Deafult '1.0'.

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

Specified by:

init in interface Component

Parameters:

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