nz.ac.waikato.mcennis.rat.scheduler
Interface Scheduler

All Superinterfaces:

Listener, Model, ParsedObject

All Known Implementing Classes:

ActorCrossValidationScheduler, BasicScheduler, GraphCrossValidationScheduler, LinkCrossValidationScheduler, StatisticalCheckScheduler

public interface Scheduler
extends ParsedObject, Model, Listener

Interface for a blackboard-style scheduler. It is created by a XML configuration language and executes the dataaquisition layer first, followed by each algorithm in order. Scheudler implementations that differ from this assumption must explicitly state so in their documentation.

Field Summary

static int	ALGORITHM_DONE
static int	DONE
static int	INITIALIZE
static int	SET_ALGORITHM
static int	SET_ALGORITHM_COUNT
static int	SET_ALGORITHM_PROGRESS
static int	SET_GRAPH_COUNT
static int	SET_GRAPH_PROGRESS
static int	START Set of message types for listeners of this scheduler

Method Summary

void	cancel() Cancel execution and return immediately
Graph	get() Return the graph produced and altered by the data aquisition and algorithms.
Properties	getParameter() Return a machine-readable description of the parameters this scheduler has.
void	init(Properties props) Initiliaize this scheduler with the following parameters.
void	load(Algorithm algorithm, GraphQuery graphQuery) set an algorithm to be executed.
void	load(DataAquisition loader) set the data-aquisition component to be executed
void	load(java.io.InputStream config) load this scheduler using the given XML file.
Scheduler	prototype()
void	set(Graph g) Set the graph that will serve as the data structure to be executed against
void	start() Begin execution

Methods inherited from interface nz.ac.waikato.mcennis.rat.graph.model.Model

addListener

Methods inherited from interface nz.ac.waikato.mcennis.rat.graph.model.Listener

publishChange

Field Detail

START

static final int START

Set of message types for listeners of this scheduler

See Also:

Constant Field Values

INITIALIZE

static final int INITIALIZE

See Also:

Constant Field Values

SET_ALGORITHM

static final int SET_ALGORITHM

See Also:

Constant Field Values

SET_GRAPH_COUNT

static final int SET_GRAPH_COUNT

See Also:

Constant Field Values

SET_ALGORITHM_COUNT

static final int SET_ALGORITHM_COUNT

See Also:

Constant Field Values

SET_ALGORITHM_PROGRESS

static final int SET_ALGORITHM_PROGRESS

See Also:

Constant Field Values

SET_GRAPH_PROGRESS

static final int SET_GRAPH_PROGRESS

See Also:

Constant Field Values

ALGORITHM_DONE

static final int ALGORITHM_DONE

See Also:

Constant Field Values

DONE

static final int DONE

See Also:

Constant Field Values

Method Detail

load

void load(DataAquisition loader)

set the data-aquisition component to be executed

Parameters:

loader - acquisition method.

load

void load(Algorithm algorithm,
          GraphQuery graphQuery)

set an algorithm to be executed.

Parameters:

algorithm - array of algorithms to execute against the graph

set

void set(Graph g)

Set the graph that will serve as the data structure to be executed against

Parameters:

g - graph that will be the data structure

get

Graph get()

Return the graph produced and altered by the data aquisition and algorithms.

Returns:

graph associated with this scheduler

load

void load(java.io.InputStream config)
          throws java.io.IOException,
                 java.lang.Exception

load this scheduler using the given XML file.

Parameters:

config -

Throws:

java.io.IOException

java.lang.Exception

start

void start()

Begin execution

cancel

void cancel()

Cancel execution and return immediately

init

void init(Properties props)

Initiliaize this scheduler with the following parameters. Called by SchedulerFactory.

Parameters:

props -

getParameter

Properties getParameter()

Return a machine-readable description of the parameters this scheduler has.

Returns:

parameters for this scheduler.

prototype

Scheduler prototype()