org.lsst.ccs.framework.annotations

Class ParameterSetter<T>

java.lang.Object

org.lsst.ccs.framework.annotations.ParameterSetter<T>

public abstract class ParameterSetter<T>
extends Object

Encapsulates the logic of setting configurable parameters for a given component. It provides the validation step and the setting step, as well as intermediate steps

Author:

The LSST CCS Team

Constructor Summary

Constructors

Constructor and Description
ParameterSetter(Map<String,Method> configChangerMap, Map<String,Field> fieldsMap)

Method Summary

Modifier and Type	Method and Description
void	addConstraint(String parmName, String constraint)
void	addFinalPropForParm(String parmName, boolean isFinal)
void	addTypeForParm(String parmName, Type type)
protected void	checkAgainstConstraints(Map<String,ViewValue> parms, boolean checkFinal) Check against potential constraints defined in the subsystem description.
static <A,B,C> Function<A,C>	compose(Function<A,B> f1, Function<B,C> f2)
protected Map<String,ViewValue>	convert(Map<String,String> map) Conversion from String to object using the InputConversionEngine utility.
void	dropSubmittedChanges()
String	getConstraintFor(String parmName)
Map<String,Field>	getParameterFields()
Map<String,String>	getSubmittedChanges()
Type	getTypeForParm(String parameterName)
boolean	hasSubmittedChanges()
Map<String,String>	invokeSetParameters() Global parameter setting algorithm.
void	invokeSetSingleParameter(String parameterName, Object value, Map<String,String> currentView, boolean checkFinal)
void	invokeValidateBulkChange(Map<String,String> others, boolean checkFinal) Validation step
void	setTarget(T target)
void	submitChange(String parameterName, Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterSetter

public ParameterSetter(Map<String,Method> configChangerMap,
                       Map<String,Field> fieldsMap)

Method Detail

submitChange

public void submitChange(String parameterName,
                         Object value)

dropSubmittedChanges

public void dropSubmittedChanges()

hasSubmittedChanges

public boolean hasSubmittedChanges()

invokeValidateBulkChange

public void invokeValidateBulkChange(Map<String,String> others,
                                     boolean checkFinal)

Validation step

Parameters:

others - the other parameters that have not changed

checkFinal - true if the final property of a parameter has to be checked, false otherwise.

invokeSetSingleParameter

public void invokeSetSingleParameter(String parameterName,
                                     Object value,
                                     Map<String,String> currentView,
                                     boolean checkFinal)

invokeSetParameters

public Map<String,String> invokeSetParameters()
                                       throws BulkSettingException

Global parameter setting algorithm. It first invokes the bulk setting on the component, then invokes single setting on the remaining components.

Returns:

the name and value as String of the parameters that have been successfully set.

Throws:

BulkSettingException

getParameterFields

public Map<String,Field> getParameterFields()

setTarget

public void setTarget(T target)

addConstraint

public void addConstraint(String parmName,
                          String constraint)

addTypeForParm

public void addTypeForParm(String parmName,
                           Type type)

checkAgainstConstraints

protected void checkAgainstConstraints(Map<String,ViewValue> parms,
                                       boolean checkFinal)

Check against potential constraints defined in the subsystem description.

Parameters:

parms -

checkFinal -

convert

protected Map<String,ViewValue> convert(Map<String,String> map)

Conversion from String to object using the InputConversionEngine utility.

Parameters:

map -

Returns:

addFinalPropForParm

public void addFinalPropForParm(String parmName,
                                boolean isFinal)

getTypeForParm

public Type getTypeForParm(String parameterName)

getConstraintFor

public String getConstraintFor(String parmName)

compose

public static <A,B,C> Function<A,C> compose(Function<A,B> f1,
                                            Function<B,C> f2)

getSubmittedChanges

public Map<String,String> getSubmittedChanges()