org.lsst.ccs.framework

Class Configurable.Environment

java.lang.Object

org.lsst.ccs.framework.Configurable.Environment

Enclosing interface:

Configurable

public static class Configurable.Environment
extends Object

instances of this class are created by the subsystem startup. They operate delegations on behalf of the Configurable Object. The Configurable Object can thus access its ConfigurationProxy and its ComponentLookupService

Constructor Summary

Constructors

Constructor and Description
Environment(String name, Configurable currentObject, ConfigurationProxy configurationProxy, ComponentLookupService lookupService) Creates an Environment for a Configurable object.

Method Summary

Modifier and Type	Method and Description
void	alias(String name)
void	change(String parameterName, Object value) performs a parameter change during an agineering session
void	dropConfigurationContext() drops context of parameter modification (returns to previous Configuration values)
ViewValue	getCheckedValueFromConfiguration(String parameterName, Object value) Checks if a value can be accepted by the Configuration system.
<T> LinkedHashMap<String,T>	getChildren(Class<T> classFilter) get the "children" of the current component.
LocalCommandDictionary	getCommandBuilder()
Object	getComponentByName(String name) request a Component from a Description by its name.
Map<String,Method>	getConfigMethodsOfComponent()
Dictionary	getDictionary()
String	getNameOfComponent()
Map.Entry<String,Object>	getParent() returns the parent of the current component
Object	getRelevantObject()
Optional<Subsystem>	getSubsystem()
List<Configurable>	listChildren() gets the children of this Object
void	newConfigurationContext() Deprecated. will be neutralized in 2.0 and 2.1 branches
protected void	notifyChange(String parameterName, String value) to be used by "facade" commands that may set a value the calling must have made a preliminary check with the configuration service.
void	notifyChangeWithoutPreliminaryChecks(String parameterName, Object value) to be used by "facade" commands that may set a value then notify the configuration without going through the preliminary check of the configuration service.
void	register(String configurationName) Deprecated. Use saveConfiguration(configurationName) instead
void	register(String configurationName, String tag) Deprecated.
void	saveConfiguration() Saves the current Configuration .
void	saveConfiguration(String configurationName) Saves a configuration with a new name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Environment

public Environment(String name,
                   Configurable currentObject,
                   ConfigurationProxy configurationProxy,
                   ComponentLookupService lookupService)

Creates an Environment for a Configurable object. It builds a CommandDictionary for the object and populates a map of ConfigChanger methods.

The configuration proxy provides an access to the configuration database but interactions are of delicate nature :

• the base is checked as wether the new parameter value is considered possible
• then the parameter is changed locally
• the base is notified about the change

Parameters:

name -

currentObject -

configurationProxy -

lookupService -

Method Detail

newConfigurationContext

@Deprecated
public void newConfigurationContext()

Deprecated. will be neutralized in 2.0 and 2.1 branches

Will create a new Configuration context for modifying a configuration (engineering mode)

change

public void change(String parameterName,
                   Object value)
            throws Exception

performs a parameter change during an agineering session

Parameters:

parameterName - name of parameter for the current object.

value - any object that is fit for the configuration system (see documentation)

Throws:

IllegalArgumentException - if parameter has a name unknown to the configuration

Exception - that can be thrown by the ConfigurationProxy (no connection, illegal format, constraints failure) or by the user's code (preconditions)

register

@Deprecated
public void register(String configurationName,
                                 String tag)
                          throws IOException

Deprecated.

registers a tagged configuration

Parameters:

configurationName -

tag -

Throws:

IOException

register

@Deprecated
public void register(String configurationName)
                          throws IOException

Deprecated. Use saveConfiguration(configurationName) instead

registers a new Configuration

Parameters:

configurationName -

Throws:

IOException

saveConfiguration

public void saveConfiguration()
                       throws IOException

Saves the current Configuration .

Throws:

IOException

saveConfiguration

public void saveConfiguration(String configurationName)
                       throws IOException

Saves a configuration with a new name.

Parameters:

configurationName -

Throws:

IOException

dropConfigurationContext

public void dropConfigurationContext()

drops context of parameter modification (returns to previous Configuration values)

getCheckedValueFromConfiguration

public ViewValue getCheckedValueFromConfiguration(String parameterName,
                                                  Object value)
                                           throws Exception

Checks if a value can be accepted by the Configuration system. to be used by "facade" commands that may set a value.

The returned value is an Object that represent the real value as generated by the Configuration: it is not necessarily the value passed as argument because the argument can both be a real object or its String representation (as extracted from a properties file or from a GUI interaction). This returned object contains both this real value AND its String representation.

Parameters:

parameterName -

value - can be a real Object or its String representation

Returns:

An object ViewValue that returns both an Object value and its String representation as used by the Configuration.

Throws:

Exception

notifyChangeWithoutPreliminaryChecks

public void notifyChangeWithoutPreliminaryChecks(String parameterName,
                                                 Object value)
                                          throws Exception

to be used by "facade" commands that may set a value then notify the configuration without going through the preliminary check of the configuration service.
use at your own risk!

Parameters:

parameterName -

value -

Throws:

Exception

notifyChange

protected void notifyChange(String parameterName,
                            String value)
                     throws Exception

to be used by "facade" commands that may set a value
the calling must have made a preliminary check with the configuration service.
indiscriminate use should be discouraged

Parameters:

parameterName -

value -

Throws:

Exception

getComponentByName

public Object getComponentByName(String name)

request a Component from a Description by its name.

Parameters:

name -

Returns:

A Component. beware unless you are dead sure do not assume this component is a Configurable object (any object can be aliased and so put in the dictionary)

alias

public void alias(String name)

getChildren

public <T> LinkedHashMap<String,T> getChildren(Class<T> classFilter)

get the "children" of the current component. Only the children that are "assignable to" instance of the class argument will be returned.

Type Parameters:

T -

Parameters:

classFilter -

Returns:

listChildren

public List<Configurable> listChildren()

gets the children of this Object

Returns:

getParent

public Map.Entry<String,Object> getParent()

returns the parent of the current component

Returns:

the Component (value) and its name (key) null if there is no parent.

getNameOfComponent

public String getNameOfComponent()

Returns:

the name associated with this component

getRelevantObject

public Object getRelevantObject()

Returns:

the object managed by the environment (may be different from the current Configurable when there is a Proxy

getConfigMethodsOfComponent

public Map<String,Method> getConfigMethodsOfComponent()

getCommandBuilder

public LocalCommandDictionary getCommandBuilder()

getDictionary

public Dictionary getDictionary()

getSubsystem

public Optional<Subsystem> getSubsystem()