stella

Class ParameterSet

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.AbstractGlobalGroup

globals.GlobalSet

stella.ParameterSet

All Implemented Interfaces:

GlobalAccessible, GlobalGrouping, DriverDepending, Cloneable, EventListener, ErrorListener, ParameterClustering, TargetProviderDepending, TargetDepending, ExitCleaning, Initializable, PropertySupplying, Reloadable, ResourceSupplying

public class ParameterSet
extends GlobalSet
implements ParameterClustering, TargetProviderDepending, ErrorListener

This class combines various Parameters to a set. On construct the provided properties should either contain a GlobalSet.KEY_LIST pointing to a comma separated global properties list, or a GlobalSet.KEY_FILE which should point to a file in the users personal java configuration directory Path where the names of the properties files for all globals that comprise this global set should be listed. Each entry found is then used to generated a new Map object and pass it to the AbstractParameter.createParameter(java.util.Map<java.lang.String, java.lang.String>) factory method. Additinally to the normal global construction the global properties are scanned for the necessity to register additional globals to allow value generating capabilities of the newly generated global to unfold.

Nested Class Summary

Nested classes/interfaces inherited from class globals.GlobalSet

GlobalSet.Astronomical

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	DEFPIPEONLY The default pipe-only behaviour.
private List<Driver>	drivers The list of registered drivers.
private ErrorEvent	error The last error event that has been registered to this parameter set.
static String	KEY_PIPEONLY If pointing to true, only error events with the pipe flag are used.
private WeatherSurveying	weather The weather surveying instance registered to this parameter set.

Fields inherited from class globals.GlobalSet

KEY_DUMP, KEY_FILE, KEY_LIST, KEY_TIMEPARAMETER, PARENCLOSE, PARENOPEN

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Constructor Summary

Constructors

Constructor and Description
ParameterSet(Map<String,String> info) Constructs a new global set with the given properties.

Method Summary

Modifier and Type	Method and Description
protected void	addGlobalDependency(Parameter test)
static ParameterClustering	createParameterClustering(Map<String,String> info)
void	errorOccured(ErrorEvent ee) Receiving the error event as a listener.
ErrorEvent	getError() Returns the last error event registered.
WeatherSurveying	getWeatherSurveyor() Returns the last weather station registered to this parameter set.
boolean	registerDriver(Driver io) Registers a driver to this parameter set.
void	registerProvider(TargetProviding<?> list) Registers a collection of active targets to this cluster.
void	setCommandLauncher(CommandLaunching... launch) Registers a command launcher to this parameter set.
void	setError(ErrorEvent ee) Sets the error event for ErrorDependingParameters.
void	setWeatherSurveyor(WeatherSurveying sensors) Binds a weather surveyor to this parameter set.

Methods inherited from class globals.GlobalSet

addParameter, change, createInstance, createInstance, createInstance, currentTimeMillis, exit, get, getAllParameterNames, getAllParameters, getParameter, getTarget, getTrigger, getValue, init, registerTarget, reload, removeParameter, rescanned, rmiGet, rmiGetAllParameterNames, set, setTrigger, setValue, toggleTrigger, toString

Methods inherited from class globals.AbstractGlobalGroup

createParameterCluster, getFor

Methods inherited from class util.PropertyResources

clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, isNew, parseObject, parseObject, removeProperty, requires, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface globals.GlobalGrouping

getTarget

Methods inherited from interface globals.GlobalAccessible

addParameter, change, currentTimeMillis, get, getAllParameterNames, getAllParameters, getParameter, getTrigger, getValue, removeParameter, set, setTrigger, setValue, toggleTrigger

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Methods inherited from interface target.TargetDepending

registerTarget

Field Detail

KEY_PIPEONLY

public static final String KEY_PIPEONLY

If pointing to true, only error events with the pipe flag are used.

See Also:

Constant Field Values

DEFPIPEONLY

private static final boolean DEFPIPEONLY

The default pipe-only behaviour.

See Also:

Constant Field Values

drivers

private List<Driver> drivers

The list of registered drivers. Needed for late-adding parameters.

weather

private WeatherSurveying weather

The weather surveying instance registered to this parameter set.

error

private ErrorEvent error

The last error event that has been registered to this parameter set.

Constructor Detail

ParameterSet

public ParameterSet(Map<String,String> info)

Constructs a new global set with the given properties. These properties are scanned for either the GlobalSet.KEY_LIST or the GlobalSet.KEY_FILE for properties of the globals. Entries in the file are one properties file per line, lines starting with '#' are ignored.

This constructor calls the GlobalSet.init() method if the provided file could successfully be parsed into a collection of proprties file names.

Method Detail

createParameterClustering

public static ParameterClustering createParameterClustering(Map<String,String> info)

registerProvider

public void registerProvider(TargetProviding<?> list)

Registers a collection of active targets to this cluster. The targets are piped to all parameters served that need a target collection, i.e. that are TargetProviderDepending.

Specified by:

registerProvider in interface TargetProviderDepending

registerDriver

public boolean registerDriver(Driver io)

Registers a driver to this parameter set. It spawns a search through all parameters and registers the driver to any parameter that is driver depending.

Specified by:

registerDriver in interface DriverDepending

Returns:

True if registering at the driver was successful.

setCommandLauncher

public void setCommandLauncher(CommandLaunching... launch)

Registers a command launcher to this parameter set. It spawns a search through all parameters served and registers this command launcher to any StatusRequesting parameter found.

Specified by:

setCommandLauncher in interface ParameterClustering

setWeatherSurveyor

public void setWeatherSurveyor(WeatherSurveying sensors)

Binds a weather surveyor to this parameter set. Any parameters served that are of the SensorValue type are bound to their sensors here.

Specified by:

setWeatherSurveyor in interface ParameterClustering

getWeatherSurveyor

public WeatherSurveying getWeatherSurveyor()

Returns the last weather station registered to this parameter set.

Specified by:

getWeatherSurveyor in interface ParameterClustering

setError

public void setError(ErrorEvent ee)

Sets the error event for ErrorDependingParameters.

Specified by:

setError in interface ParameterClustering

getError

public ErrorEvent getError()

Returns the last error event registered.

Specified by:

getError in interface ParameterClustering

errorOccured

public void errorOccured(ErrorEvent ee)

Receiving the error event as a listener. Allows simple access to the ErrorDependingParameters of this cluster.
If the KEY_PIPEONLY flag is true, only error events received that have the pipe flag raised are passed to the setError(stella.ErrorEvent) method.

Specified by:

errorOccured in interface ErrorListener

addGlobalDependency

protected void addGlobalDependency(Parameter test)

Overrides:

addGlobalDependency in class GlobalSet