globals

Class GlobalSet

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.AbstractGlobalGroup

globals.GlobalSet

All Implemented Interfaces:

GlobalAccessible, GlobalGrouping, Cloneable, TargetDepending, ExitCleaning, Initializable, PropertySupplying, Reloadable, ResourceSupplying

Direct Known Subclasses:

ParameterSet

public class GlobalSet
extends AbstractGlobalGroup
implements ExitCleaning, Initializable, Reloadable

This class combines various Parameters to a set. On construct the provided properties should either contain a KEY_LIST pointing to a comma separated global properties list, or a 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

Modifier and Type	Class and Description
static class	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 String	DEFTIMEPARAMETER Default time name.
private Map<String,Parameter>	global The mapping of global-names to globals.
static String	KEY_DUMP The file where all parameter values should be stored on exit.
static String	KEY_FILE The key to a file containing a (long) list of all sensors.
static String	KEY_LIST The key to a comma-seperated list of all triggers.
static String	KEY_TIMEPARAMETER The name of the parameter delivering the current time.
static String	PARENCLOSE Curly bracket close.
static String	PARENOPEN Curly bracket open.
private TargetDefinition	target The last target that has been registered to this parameter set.

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
GlobalSet(Map<String,String> info) Constructs a new global set with the given properties.
GlobalSet(Map<String,String> info, List<Parameter> l)

Method Summary

Modifier and Type	Method and Description
protected void	addGlobalDependency(Parameter newbie)
void	addParameter(Parameter newbie) Adds a parameter to the parameter set.
Map<String,Object>	change(Map<String,Object> all) Changes a bunch of parameters in this cluster.
static GlobalGrouping	createInstance() Creates a parameter set with mainly astronomic parameters
static GlobalGrouping	createInstance(Collection<GlobalSet.Astronomical> ra) Creates a parameter set with mainly astronomic parameters
private static GlobalGrouping	createInstance(Map<Class<? extends Parameter>,String> cls) Creates a parameter set given a mapping of parameter classes to possible construction strings
static GlobalGrouping	createInstance(String all) Creates a parameter set from a string.A ll names are scanned as class names in the stella.parameter package.
private static List<Parameter>	createList(Map<String,String> i)
private void	crossRegister()
long	currentTimeMillis() Gets the current time as defined in the cluster.
void	exit() Performs an ordered shutdown.
Object	get(String name) Returns the parameter's value as an object or null if not found in hashtable.
Set<String>	getAllParameterNames() Returns all names of the globals this global set serves.
Collection<Parameter>	getAllParameters() Returns all globals in this set.
Parameter	getParameter(String name) Returns the global specified by the given name.
TargetDefinition	getTarget() Returns the cached target defintion.
Boolean	getTrigger(String name) Returns the value of the specified global if the parameter is a Trigger.
Number	getValue(String name) Returns the value of the specified global if the parameter is a Value.
void	init() Initializes this global set.
(package private) void	initLookup(List<Parameter> l)
void	registerTarget(TargetDefinition newtarget) Sets a target to all parameters in this set.
double	reload() All reloadable parameters itself are asked to reload themself.
Parameter	removeParameter(String name) Removes a parameter from this set.
double	rescanned(String key, String old, String newval) Called if the properties have changed and a reload is requested.
private static Class<? extends Parameter>	resolveClass(String classname) From a class name, get a class that is a subtype of Parameter
Object	rmiGet(String name) Returns the parameter's value as an object.
Set<String>	rmiGetAllParameterNames() Returns all names of the parameters this parameter set serves, tailored for rmi-access.
Object	set(String name, Object val) Sets the value of the specified parameter as in Parameter.set(java.lang.Object) method.Note that this may result in an UnsupportedOperationException to be thrown if the specified parameter does not support setting its value.
Boolean	setTrigger(String name, Boolean newval) Sets the value of the specified global.
Number	setValue(String name, Number newval) Sets the value of the specified global.
Boolean	toggleTrigger(String name) Toggles a trigger.
String	toString() Returns a multi-lined Stringrepresentation of the parameter set.

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

Field Detail

PARENOPEN

public static final String PARENOPEN

Curly bracket open.

See Also:

Constant Field Values

PARENCLOSE

public static final String PARENCLOSE

Curly bracket close.

See Also:

Constant Field Values

KEY_TIMEPARAMETER

public static final String KEY_TIMEPARAMETER

The name of the parameter delivering the current time.

See Also:

Constant Field Values

KEY_LIST

public static final String KEY_LIST

The key to a comma-seperated list of all triggers.

See Also:

Constant Field Values

KEY_FILE

public static final String KEY_FILE

The key to a file containing a (long) list of all sensors.

See Also:

Constant Field Values

KEY_DUMP

public static final String KEY_DUMP

The file where all parameter values should be stored on exit.

See Also:

Constant Field Values

DEFTIMEPARAMETER

private static final String DEFTIMEPARAMETER

Default time name.

See Also:

Constant Field Values

global

private Map<String,Parameter> global

The mapping of global-names to globals.

target

private TargetDefinition target

The last target that has been registered to this parameter set.

Constructor Detail

GlobalSet

GlobalSet(Map<String,String> info,
          List<Parameter> l)

GlobalSet

public GlobalSet(Map<String,String> info)

Constructs a new global set with the given properties. These properties are scanned for either the KEY_LIST or the 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 init() method if the provided file could successfully be parsed into a collection of proprties file names.

Method Detail

createInstance

public static final GlobalGrouping createInstance()

Creates a parameter set with mainly astronomic parameters

createInstance

public static final GlobalGrouping createInstance(Collection<GlobalSet.Astronomical> ra)

Creates a parameter set with mainly astronomic parameters

createInstance

public static final GlobalGrouping createInstance(String all)

Creates a parameter set from a string.A ll names are scanned as class names in the stella.parameter package.

resolveClass

private static Class<? extends Parameter> resolveClass(String classname)
                                                throws ClassNotFoundException

From a class name, get a class that is a subtype of Parameter

Parameters:

classname -

Returns:

Throws:

ClassNotFoundException

createInstance

private static final GlobalGrouping createInstance(Map<Class<? extends Parameter>,String> cls)

Creates a parameter set given a mapping of parameter classes to possible construction strings

init

public void init()

Initializes this global set. The argument file array is conceived as property files of globals.

Initialization includes instantiating of all the globals found in the array via the AbstractParameter.createParameter(java.util.Map<java.lang.String, java.lang.String>) factory method and registring additional globals required if they are ParameterDepending.

Specified by:

init in interface Initializable

initLookup

void initLookup(List<Parameter> l)

createList

private static List<Parameter> createList(Map<String,String> i)

crossRegister

private void crossRegister()

exit

public void exit()

Performs an ordered shutdown. All registered parameters that implement the ExitCleaning interface are cleaned. No special order is guaranteed.

Specified by:

exit in interface ExitCleaning

rescanned

public double rescanned(String key,
                        String old,
                        String newval)

Called if the properties have changed and a reload is requested. The keys considered are

• PropertySupplying.KEY_CLASS: If class changed, an illegal argument exception is thrown.
• KEY_LIST and KEY_FILE: The parameters served should not be changed here, this can be done explicetly by calling addParameter(globals.Parameter).
• All other parameters are set as strings in my properties.

Specified by:

rescanned in interface Reloadable

Overrides:

rescanned in class PropertyContainer

reload

public double reload()

All reloadable parameters itself are asked to reload themself. What is returned is an average of 1 (for total success on parameter set itself) plus the individual parameter reload efforts.

Specified by:

reload in interface Reloadable

Overrides:

reload in class PropertyContainer

registerTarget

public void registerTarget(TargetDefinition newtarget)

Sets a target to all parameters in this set. The target definition is cached for later retrieval. The star description delivered by the target definition is passed to all parameters. Any parameter that needs astrometric star data is required to extract this information by itself.

Specified by:

registerTarget in interface TargetDepending

getTarget

public TargetDefinition getTarget()

Returns the cached target defintion. If no target has been set prior to this call null is returned.

Specified by:

getTarget in interface GlobalGrouping

change

public Map<String,Object> change(Map<String,Object> all)

Changes a bunch of parameters in this cluster. The map's keys are used as references to the parameter names that should be changed, the map values reflect the new values of the parameter.

Specified by:

change in interface GlobalAccessible

Returns:

A map with values equivalent to the old parameter values.

getAllParameters

public Collection<Parameter> getAllParameters()

Returns all globals in this set. Returns the references to the globals as a Collection.

Specified by:

getAllParameters in interface GlobalAccessible

getAllParameterNames

public Set<String> getAllParameterNames()

Returns all names of the globals this global set serves. Calls the underlying HashMap.keySet()

Specified by:

getAllParameterNames in interface GlobalAccessible

rmiGetAllParameterNames

public Set<String> rmiGetAllParameterNames()
                                    throws RemoteException

Returns all names of the parameters this parameter set serves, tailored for rmi-access. Calls getAllParameterNames(), but pipes the names into an individual set because the key set of a hash map is transient.

Throws:

RemoteException

getParameter

public Parameter getParameter(String name)

Returns the global specified by the given name.

Specified by:

getParameter in interface GlobalAccessible

rmiGet

public Object rmiGet(String name)
              throws RemoteException

Returns the parameter's value as an object. This method is tailored for rmi-access. Calls get(java.lang.String).

Throws:

RemoteException

currentTimeMillis

public long currentTimeMillis()

Description copied from interface: GlobalAccessible

Gets the current time as defined in the cluster. Use instead of System.currentTimeMillis

Specified by:

currentTimeMillis in interface GlobalAccessible

get

public Object get(String name)

Returns the parameter's value as an object or null if not found in hashtable.

Specified by:

get in interface GlobalAccessible

set

public Object set(String name,
                  Object val)

Sets the value of the specified parameter as in Parameter.set(java.lang.Object) method.Note that this may result in an UnsupportedOperationException to be thrown if the specified parameter does not support setting its value.

Specified by:

set in interface GlobalAccessible

getValue

public Number getValue(String name)

Returns the value of the specified global if the parameter is a Value. If the global is a RemoteParameter, the RemoteParameter.remoteGet() method is querried, otherwise Value.getValue() is returned.

Specified by:

getValue in interface GlobalAccessible

setValue

public Number setValue(String name,
                       Number newval)

Sets the value of the specified global. Note that this may result in an UnsupportedOperationException to be thrown if the specified global does not support setting its value.

Specified by:

setValue in interface GlobalAccessible

getTrigger

public Boolean getTrigger(String name)

Returns the value of the specified global if the parameter is a Trigger. If the global is a RemoteParameter, the RemoteParameter.remoteGet() method is querried, otherwise Triggering.getTrigger() is returned.

Specified by:

getTrigger in interface GlobalAccessible

setTrigger

public Boolean setTrigger(String name,
                          Boolean newval)

Sets the value of the specified global. Note that this may result in an UnsupportedOperationException to be thrown if the specified global does not support setting its value.

Specified by:

setTrigger in interface GlobalAccessible

toggleTrigger

public Boolean toggleTrigger(String name)

Toggles a trigger. Note that this may result in an UnsupportedOperationException to be thrown if the specified global does not support setting its value.

Specified by:

toggleTrigger in interface GlobalAccessible

addParameter

public void addParameter(Parameter newbie)

Adds a parameter to the parameter set. For now, this method is intended to server device triggers, see DeviceTrigger. A device trigger is linked to a command server and gets true if the appropriate device is ready. Uses the DeviceTrigger.KEY_PING in the server's properties to derive the triggers is-alive intervall. To the triggers the appropriate servers must have been registered, the trigger must already be running.

For paramters added that are either TargetDependingParameter, WeatherDependingParameter, ErrorDependingParameter, or DriverDepending, the appropriate target etc. is registered.

Specified by:

addParameter in interface GlobalAccessible

addGlobalDependency

protected void addGlobalDependency(Parameter newbie)

Parameters:

newbie -

removeParameter

public Parameter removeParameter(String name)

Removes a parameter from this set. This only means that the parameter cannot be queried from within this set, but it may still reside in an e.g. RemoteParameter object.

Specified by:

removeParameter in interface GlobalAccessible

Returns:

The removed parameter or null if not in the table.

toString

public String toString()

Returns a multi-lined Stringrepresentation of the parameter set.

Overrides:

toString in class PropertyContainer