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.

• Parameter AlgorithmClass:
  • Key for this data aquisition algorithms. Typically not changed.
  • String Object
  • max: 1
  • min: 1
  • Typically not altered
  • Default: FileReader
• Parameter Name:
  • Globally unique name for this data aquisition algorithm.
  • String Object
  • max: 1
  • min: 1
  • Default: FileReader
• Parameter Category:
  • Category of data aquisition algorithm
  • String Object
  • max: 1
  • min: 1
  • Typically not altered
  • Default: File Crawler
• Parameter Directory:
  • Directory LiveJournal FOAF's are stored in.
  • File Object
  • max: 1
  • min: 1
  • File must be a vailid directory.
  • Default: None
• Parameter Anonymizing:
  • Are user ID's to be anonymized?
  • Boolean Object
  • max: 1
  • min: 1
  • Default: true

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
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) Initializes the FileReader object.
FileReader2Pass	prototype() All Components implement the prototype pattern.
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 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)

Initializes the FileReader object. Input/Output :

• Input: None
• Output:
  • User
    • Type: Actor
    • Description: LiveJournal user
  • Knows
    • Type: Link
    • Description: Asynchronous relationship between users
  • foaf:title
    • Type: Actor Property
    • Mode: User
    • Description: String of Salutation of the user
  • foaf:phone
    • Type: Actor Property
    • Mode: User
    • Description: String of phone number of the user
  • foaf:gender
    • Type: Actor Property
    • Mode: User
    • Description: String of sex of the user
  • ya:country
    • Type: Actor Property
    • Mode: User
    • Description: String of country of the user
  • ya:city
    • Type: Actor Property
    • Mode: User
    • Description: String of the city of the user
  • foaf:dateOfBirth
    • Type: Actor Property
    • Mode: User
    • Description: String of birthday of the user
  • foaf:msnChatID
    • Type: Actor Property
    • Mode: User
    • Description: String of MSN online chat ID of the user
  • foaf:aimChatID
    • Type: Actor Property
    • Mode: User
    • Description: String of AIM online chat ID of the user
  • ya:bio
    • Type: Actor Property
    • Mode: User
    • Description: String of self-published description of the user
  • interest
    • Type: Actor Property
    • Mode: User
    • Description: String of a free-form tag declaring a hobby or an interest in a topic

Specified by:

init in interface Component

Parameters:

map - properties to load - null is permitted.

prototype

public FileReader2Pass 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

Returns:

default-parameter version of the same class as the original.