org.lsst.ccs.config

Class Factories

java.lang.Object

org.lsst.ccs.config.Factories

public class Factories
extends Object

A set of static methods to be used on Configuration service client's side : they are hiding some implementation details to the "outside" world. To be used in conjunction with ConfigurationFacade (but these codes may be called locally without referring to a server)

Author:

bamade

Method Summary

Modifier and Type	Method and Description
static ConfigProfile	copyProfile(ConfigProfile toBeCopied, String newName, String newUserName, int newLevel, boolean toEngineering) to be used to create a copy of configuration with different name , tag, etc.
static ConfigProfile	copyProfileForRegistration(ConfigProfile toBeCopied, String newName, String userName, int newLevel, boolean getRidOfStaticParameters) Copies a configuration profile and removes parameter configurations that act on static data.
static ConfigProfile	createConfigProfile(SubsystemDescription subsystemDesc, String userName, int level, String categoryName, String configName) Creates a ConfigProfile with ParameterConfiguration where values are just copied from the Description default value.
static ParameterConfiguration	createParameterConfiguration(ParameterDescription description) factory method to create a ParameterConfiguration object.
static ParameterConfiguration	createParameterConfiguration(ParameterDescription description, String value) Factory method to create a ParameterConfiguration object.
static ParameterDescription	createParameterDescription(ParameterBase parameterBase, String description, String simpleName, String constraints, String category, int level) factory method to create a new ParameterDescription.
static ParameterDescription	createParameterDescription(ParameterDescription other) Factory method to create a new ParameterDescription from another one.
static ConfigProfile	createRawConfigProfile(SubsystemDescription subsystemDesc, String userName, int level, String category, String configName) Creates an empty ConfigProfile.
static SubsystemDescription	createRawSubsystemDescription(String subsystemName, String tag, String user, String version, Serializable configurationData, DataFlavour dataFlavour) Creates a new SubsystemDescription object without any ParameterDescription list creation.
static SubsystemDescription	createSubsystemDescription(String subsystemName, String tag, String user, String version, Serializable configurationData, DataFlavour dataFlavour, ParameterFilter filter) creates a new SubsystemDescription populated with "empty" ParameterDescriptions.
static SubsystemDescription	createSubsystemDescriptionCopy(SubsystemDescription desc) creates a new SubsystemDescription from another.
static ConfigProfile	repair(ConfigProfile oldProfile, SubsystemDescription newDescription, ConfigurationMismatchListener mismatchListener) tries to create a new ConfigProfile from an old one.
static void	tryCopyParameters(SubsystemDescription newDescription, SubsystemDescription model, DescriptionMismatchListener mismatchListener) tries to copy ParameterDescription from a model to a new subsystem description.

Methods inherited from class java.lang.Object

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

Method Detail

createRawSubsystemDescription

public static SubsystemDescription createRawSubsystemDescription(String subsystemName,
                                                                 String tag,
                                                                 String user,
                                                                 String version,
                                                                 Serializable configurationData,
                                                                 DataFlavour dataFlavour)

Creates a new SubsystemDescription object without any ParameterDescription list creation. The object is not registered in the database since it is to be populated by ParameterDescription objects.

To populate the descriptions get the base descriptions from the Subsystemdescription by calling a version of getBaseParameters or getParameterDescriptions and generate the descriptions from these bases.

Parameters:

subsystemName -

tag -

user -

version -

configurationData -

dataFlavour -

Returns:

a SubsystemDescription object without parameter descriptions

createSubsystemDescription

public static SubsystemDescription createSubsystemDescription(String subsystemName,
                                                              String tag,
                                                              String user,
                                                              String version,
                                                              Serializable configurationData,
                                                              DataFlavour dataFlavour,
                                                              ParameterFilter filter)

creates a new SubsystemDescription populated with "empty" ParameterDescriptions. The object is not in the database since the list of descriptions should be modified first.

Parameters:

subsystemName -

tag -

user -

version -

configurationData -

dataFlavour -

filter -

Returns:

a SubsystemDescription object containing the description of the parameters as described in configurationData.

createSubsystemDescriptionCopy

public static SubsystemDescription createSubsystemDescriptionCopy(SubsystemDescription desc)

creates a new SubsystemDescription from another. The other one could be active of deprecated data: this method is meant to create another subsystemdescription were only the ParameterDescription are to be changed. not that the list of ParameterDescription may be populated (if the model have some) and then that this set is to be modified (the resulting object is not yet persisted in the database).

Parameters:

desc -

Returns:

a deep copy of a the object.

createParameterDescription

public static ParameterDescription createParameterDescription(ParameterBase parameterBase,
                                                              String description,
                                                              String simpleName,
                                                              String constraints,
                                                              String category,
                                                              int level)

factory method to create a new ParameterDescription. To be used by tools such as GUI

Parameters:

parameterBase -

description -

simpleName -

constraints -

category -

level -

Returns:

a ParameterDescription object built out of the issued arguments

createParameterDescription

public static ParameterDescription createParameterDescription(ParameterDescription other)

Factory method to create a new ParameterDescription from another one.

Parameters:

other -

Returns:

a copy of other.

tryCopyParameters

public static void tryCopyParameters(SubsystemDescription newDescription,
                                     SubsystemDescription model,
                                     DescriptionMismatchListener mismatchListener)

tries to copy ParameterDescription from a model to a new subsystem description. each ParameterDescription is checked against the configData (if not compatible it is rejected and a Listener is notified).

NOT IMPLEMENTED YET

Parameters:

newDescription - a subsystem description without any ParameterDescription

model -

mismatchListener - optional code that will be warned when inconsistencies occur

createRawConfigProfile

public static ConfigProfile createRawConfigProfile(SubsystemDescription subsystemDesc,
                                                   String userName,
                                                   int level,
                                                   String category,
                                                   String configName)

Creates an empty ConfigProfile. This object is associated to a subsystem description, is specified the category of parameters it referes to and is associated a configuration name but it does not contain any ParameterConfiguration list.

Parameters:

subsystemDesc - should be read from the database

userName -

level -

category -

configName -

Returns:

an empty ConfigProfile

Throws:

IllegalArgumentException - if subsystemdescription not in database

createConfigProfile

public static ConfigProfile createConfigProfile(SubsystemDescription subsystemDesc,
                                                String userName,
                                                int level,
                                                String categoryName,
                                                String configName)

Creates a ConfigProfile with ParameterConfiguration where values are just copied from the Description default value.

Parameters:

subsystemDesc - should be already in the database

userName -

level -

categoryName -

configName -

Returns:

Throws:

IllegalArgumentException - if subsystemdescription not in database

copyProfile

public static ConfigProfile copyProfile(ConfigProfile toBeCopied,
                                        String newName,
                                        String newUserName,
                                        int newLevel,
                                        boolean toEngineering)

to be used to create a copy of configuration with different name , tag, etc. This is used mostly to go back and forth in Engineering mode: for instance start an Engineering mode with modification of parameters "on the fly"

when this is used to create an "engineering mode" profile it is mandatory that the profile to be copied is an active one (not a deprecated one)

Parameters:

toBeCopied - for the moment should be an "active" ConfigProfile (not a deprecated one)

newName -

newUserName -

newLevel -

toEngineering -

Returns:

a copy of the specified configuration profile with different name, user name and level.

copyProfileForRegistration

public static ConfigProfile copyProfileForRegistration(ConfigProfile toBeCopied,
                                                       String newName,
                                                       String userName,
                                                       int newLevel,
                                                       boolean getRidOfStaticParameters)

Copies a configuration profile and removes parameter configurations that act on static data.

Parameters:

toBeCopied -

newName -

userName -

newLevel -

getRidOfStaticParameters -

Returns:

a copy of the specified configuration profile that can be loaded at runtime

createParameterConfiguration

public static ParameterConfiguration createParameterConfiguration(ParameterDescription description,
                                                                  String value)

Factory method to create a ParameterConfiguration object. The object stands for the description parameter description and attempts to assign a new configured value to it. This factory method is to be used statically exclusively (ie not when a subsystem is running).

Parameters:

description -

value -

Returns:

a new configured value for the parameter depicted by description

createParameterConfiguration

public static ParameterConfiguration createParameterConfiguration(ParameterDescription description)

factory method to create a ParameterConfiguration object.

Parameters:

description -

Returns:

repair

public static ConfigProfile repair(ConfigProfile oldProfile,
                                   SubsystemDescription newDescription,
                                   ConfigurationMismatchListener mismatchListener)

tries to create a new ConfigProfile from an old one. The new one is matched to an active subsystemDescription

NOT IMPLEMENTED YET

Parameters:

oldProfile -

newDescription - an active subsystemDescription already registered in the databse

mismatchListener -

Returns: