nz.ac.waikato.mcennis.rat.dataAquisition
Class FileReader2Pass

java.lang.Object
  nz.ac.waikato.mcennis.rat.graph.model.ModelShell
      nz.ac.waikato.mcennis.rat.dataAquisition.FileReader2Pass

All Implemented Interfaces:

Component, DataAquisition, Model

public class FileReader2Pass
extends ModelShell
implements DataAquisition

Reads a directory of FOAF descriptions as defined by the FOAF parser (the LiveJournal specific dialect) in two passes. The first pass determines which users are present in the directory. The second pass only creates an actor if the users are present, not just references.

See the output descriptors for the description of the graph created.

Field Summary

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

listener

Constructor Summary

FileReader2Pass()
Creates a new instance of MakeRecommendation2Pass

Method Summary

void	cancel() FIXME: write cancel operation
Graph	get() Obtain a reference to the graph this object holds
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 this object using the parameters.
void	set(Graph g) Set the graph to be populated by this object
void	start() Begin executing the data aquisition module

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

FileReader2Pass

public FileReader2Pass()

Creates a new instance of MakeRecommendation2Pass

Method Detail

start

public void start()

Description copied from interface: DataAquisition

Begin executing the data aquisition module

Specified by:

start in interface DataAquisition

set

public void set(Graph g)

Description copied from interface: DataAquisition

Set the graph to be populated by this object

Specified by:

set in interface DataAquisition

Parameters:

g - graph to be created for analysis

get

public Graph get()

Description copied from interface: DataAquisition

Obtain a reference to the graph this object holds

Specified by:

get in interface DataAquisition

Returns:

graph created by this object

cancel

public void cancel()

FIXME: write cancel operation

Specified by:

cancel in interface DataAquisition

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 this object using the parameters. Also creates the input and output descriptors
parameter[0]
Key-name:'name'
Type:java.lang.String
Structural: true
Description: Name of this component.

parameter[1]
Key-name:'foafDirectory'
Type:java.lang.String
Structural: true
Description: Directory where the FOAF xml files are located

parameter[2]
Key-name:'pageDirectory'
Type:java.lang.String
Structural: true
Description: Directory where the web-page files are located
FIXME: page parsing not currently implemented

parameter[3]
Key-name:'anonymizing'
Type:java.lang.Boolean
Structural: true
Description: Should users be anonymized.

parameter[4]
Key-name:'actorClass'
Type:java.lang.String
Structural: true
Description: Class of the actor that should be used to produce users described by the FOAF files.

parameter[5]
Key-name:'actorType'
Type:java.lang.String
Structural: true
Description: The name of the 'mode' (type name) used to describe users described by the FOAF files.

parameter[6]
Key-name:'linkClass'
Type:java.lang.String
Structural: true
Description: class of links created by FOAF 'Knows' links.

parameter[7]
Key-name:'linkType'
Type:java.lang.String
Structural: true
Description: Relation (arc type, edge type) created by FOAF 'Knows' links

parameter[8]
Key-name:'propertyClass'
Type:java.lang.String
Structural: true
Description: Class for the property objects created

Specified by:

init in interface Component

Parameters:

map - the key-value pairs to initialize this component