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

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

All Implemented Interfaces:

Component, DataAquisition, Model

public class CrawlLiveJournal
extends ModelShell
implements DataAquisition

This class enables parsing and spidering of the LiveJournal site. FIXME: There are still some basic components that are needed to be generalized - the class will need to be modified before it can be used in a new situation.

Field Summary

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

listener

Constructor Summary

CrawlLiveJournal()
Creates a new instance of CrawlLiveJournal

Method Summary

void	cancel() Cancel the run at the end of the next user.
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) parameter[0] Key-name:'name' Type:java.lang.String Structural: true Description: Name of this component.
void	set(Graph g) Set the graph to be populated by this object
void	start() Creates the crawler and proxies and starts spidering FOAF descriptions.

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

CrawlLiveJournal

public CrawlLiveJournal()

Creates a new instance of CrawlLiveJournal

Method Detail

start

public void start()

Creates the crawler and proxies and starts spidering FOAF descriptions. FIXME: Not using initialization parameters FIXME: Not using a cusomizable Graph type and class

Specified by:

start in interface DataAquisition

cancel

public void cancel()

Cancel the run at the end of the next user. FIXME: currently unimplemented

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)

parameter[0]
Key-name:'name'
Type:java.lang.String
Structural: true
Description: Name of this component.

parameter[1]
Key-name:'pageCrawl'
Type:java.lang.Boolean
Structural: true
Description: Should blogs and other web pages be parsed.

parameter[2]
Key-name:'urlPrefix'
Type:java.lang.String
Structural: true
Description: Prefix used with usernames for parsing FOAF pages.

parameter[3]
Key-name:'urlSuffix'
Type:java.lang.String
Structural: true
Description: Suffix used with usernames for parsing FOAF pages.

parameter[4]
Key-name:'foafDirectory'
Type:java.lang.String
Structural: true
Description: Directory where FOAF pages should be stored.

parameter[5]
Key-name:'pageDirectory'
Type:java.lang.String
Structural: true
Description: Directory where web pages should be stored.

parameter[6]
Key-name:'stopCount'
Type:java.lang.Integer
Structural: true
Description: number of pages to crawl before spidering should cease.

parameter[7]
Key-name:'proxyUser'
Type:java.lang.String
Structural: true
Description: username to use with a proxy.

parameter[8]
Key-name:'proxyPassword'
Type:java.lang.String
Structural: true
Description: password to use with a proxy.

Specified by:

init in interface Component

Parameters:

map - key-value pairs used to initialize this component

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