org.lsst.ccs.framework

Interface Configurable.Environment

All Known Implementing Classes:

ConfigurationEnvironment

Enclosing interface:

Configurable

public static interface Configurable.Environment

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

Method Summary

Modifier and Type	Method and Description
void	change(String parameterName, Object value) performs a parameter change during an engineering session
void	dropAllChanges() All unsaved changes are dropped, each parameter goes back to the value specified by the current configuration for this category.
void	dropBulkChange()
void	dropChangesForCategories(String... categories) Changes occurring for one of the mentioned categories in categories are dropped, other categories are left untouched.
ViewValue	getCheckedValueFromConfiguration(String parameterName, Object value) Deprecated. use isParameterConfigurable(String parameterName) instead
<T> LinkedHashMap<String,T>	getChildren(Class<T> classFilter) get the children of the Configurable object that are assignable to an instance of the class argument.
Object	getComponentByName(String name) request a Component from a Description by its name.
TreeBranch<String>	getComponentTree() Returns a tree of component names starting from the current component
String	getNameOfComponent()
Map.Entry<String,Object>	getParent() returns the parent of the current component
Map<String,String>	getSubmittedChanges()
Optional<Subsystem>	getSubsystem()
Boolean	isParameterConfigurable(String parameterName)
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.
Map<String,String>	printConfigurableParameters(String[] categories) returns the current values for configurable parameters of this component that belong to the given categories.
void	saveAllChanges() Saves all changes in their current configuration.
void	saveChangesForCategories(String... categories) Changes made in the specified categories are saved under the current configuration for this category, changes on parameters that belong to other categories are left unchanged.
void	saveChangesForCategoriesAs(String... taggedCategories) Changes made in the specified categories are saved under the newly specified name for this category, changes on parameters that belong to other categories are left unchanged.
void	sendSignal(Signal signal) Sends a signal starting from the current component
void	submitChange(String parameterName, Object value)

Method Detail

change

void change(String parameterName,
            Object value)

performs a parameter change during an engineering 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

submitChange

void submitChange(String parameterName,
                  Object value)

saveAllChanges

void saveAllChanges()

Saves all changes in their current configuration.

Throws:

ConfigurationServiceException

saveChangesForCategories

void saveChangesForCategories(String... categories)

Changes made in the specified categories are saved under the current configuration for this category, changes on parameters that belong to other categories are left unchanged.

Parameters:

categories - a list of categories

Throws:

ConfigurationServiceException

saveChangesForCategoriesAs

void saveChangesForCategoriesAs(String... taggedCategories)

Changes made in the specified categories are saved under the newly specified name for this category, changes on parameters that belong to other categories are left unchanged.

Parameters:

taggedCategories - a list of pairs categoryName:configurationName

Throws:

ConfigurationServiceException

dropAllChanges

void dropAllChanges()

All unsaved changes are dropped, each parameter goes back to the value specified by the current configuration for this category. The configuration context is no longer active.

dropChangesForCategories

void dropChangesForCategories(String... categories)

Changes occurring for one of the mentioned categories in categories are dropped, other categories are left untouched. The configuration context remains active.

Parameters:

categories - A list of categories

getCheckedValueFromConfiguration

@Deprecated
ViewValue getCheckedValueFromConfiguration(String parameterName,
                                                       Object value)
                                                throws Exception

Deprecated. use isParameterConfigurable(String parameterName) instead

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

isParameterConfigurable

Boolean isParameterConfigurable(String parameterName)

notifyChangeWithoutPreliminaryChecks

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.
use at your own risk!

Parameters:

parameterName -

value -

notifyChange

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.
indiscriminate use should be discouraged

Parameters:

parameterName -

value -

getComponentByName

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)

getChildren

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

get the children of the Configurable object that are assignable to an instance of the class argument.

Type Parameters:

T -

Parameters:

classFilter - if null, no class filtering is applied.

Returns:

a map of components mapped by their name.

getParent

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

String getNameOfComponent()

Returns:

the name associated with this component

getSubsystem

Optional<Subsystem> getSubsystem()

dropBulkChange

void dropBulkChange()

getComponentTree

TreeBranch<String> getComponentTree()

Returns a tree of component names starting from the current component

Returns:

sendSignal

void sendSignal(Signal signal)

Sends a signal starting from the current component

Parameters:

signal -

printConfigurableParameters

Map<String,String> printConfigurableParameters(String[] categories)

returns the current values for configurable parameters of this component that belong to the given categories.

Parameters:

categories -

Returns:

getSubmittedChanges

Map<String,String> getSubmittedChanges()