nz.ac.waikato.mcennis.rat.scheduler
Class SchedulerFactory

java.lang.Object
  nz.ac.waikato.mcennis.rat.AbstractFactory<Scheduler>
      nz.ac.waikato.mcennis.rat.scheduler.SchedulerFactory

public class SchedulerFactory
extends AbstractFactory<Scheduler>

Class for creating a scheduler.

Field Summary

static boolean

isInitialized

Fields inherited from class nz.ac.waikato.mcennis.rat.AbstractFactory

map, properties

Method Summary

boolean	check(Properties parameters) Verify, without modifying the underlying property lists, that the given Properties object can be merged with this factory, satisfying all constraints.
Scheduler	create(Properties props) Create the given object using the settings in the Properties object.
Scheduler	create(java.lang.String name)
Scheduler	create(java.lang.String classType, Properties parameters)
Parameter	getClassParameter() Return the parameter containing the name of the default type produced by this object.
java.lang.String[]	getKnownSchedulers() Create a new Scheduler The class is created using the 'scheduler' key.
Properties	getParameter() Get all parameters associated with this object.
static void	initialization()
static SchedulerFactory	newInstance() return a reference to a singleton SchedulerFactory object.

Methods inherited from class nz.ac.waikato.mcennis.rat.AbstractFactory

addDefaultProperty, addType, check, getKnownTypes, getParameter, setDefaultProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isInitialized

public static boolean isInitialized

Method Detail

newInstance

public static SchedulerFactory newInstance()

return a reference to a singleton SchedulerFactory object.

Returns:

new reference to a singleton SchedulerFactory.

initialization

public static void initialization()

getKnownSchedulers

public java.lang.String[] getKnownSchedulers()

Create a new Scheduler The class is created using the 'scheduler' key. Currently, only the basic scheduler is implemented and is returned regardless of the value.

Parameters:

props - parameters for constructing a scheduler

Returns:

newly constructed Scheduler

create

public Scheduler create(Properties props)

Description copied from class: AbstractFactory

Create the given object using the settings in the Properties object. This function is the only global creation object, but each factory should also define a more user-friendly version consisting of a set of commonly used creation parameters as well as a version combining commonly used features with a Properties object. The property may be null. if the creation fails, the factory should log to the Logger the explanation and return null. If at all possible, the factory should provide a reasonable fail-over value rather than return null.

Specified by:

create in class AbstractFactory<Scheduler>

Parameters:

props - parameters used to control the factory.

Returns:

newly created object or null

create

public Scheduler create(java.lang.String name)

create

public Scheduler create(java.lang.String classType,
                        Properties parameters)

check

public boolean check(Properties parameters)

Description copied from class: AbstractFactory

Verify, without modifying the underlying property lists, that the given Properties object can be merged with this factory, satisfying all constraints. nulls are permitted, resulting in a check of the internal Properties object only.

Overrides:

check in class AbstractFactory<Scheduler>

Parameters:

parameters - Properties object that might be merged in

Returns:

will the merged result satisfy property constraints

getParameter

public Properties getParameter()

Description copied from class: AbstractFactory

Get all parameters associated with this object. By default, this returns a reference, not a copy

Overrides:

getParameter in class AbstractFactory<Scheduler>

Returns:

Properties object backing this factory

getClassParameter

public Parameter getClassParameter()

Description copied from class: AbstractFactory

Return the parameter containing the name of the default type produced by this object. The parameter will have exactly one value of type String. The type name of this parameter is the type that controls which class of object is produced.

Specified by:

getClassParameter in class AbstractFactory<Scheduler>

Returns:

parameter containing the default type.