SubsystemDescription (LSST Camera Control Software - configuration database definitions 2.1.1 API)

java.lang.Object
- org.lsst.ccs.config.SubsystemDescription

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ASubsystemDescription
```
@MappedSuperclass
public abstract class SubsystemDescription
extends Object
implements Serializable
```
Description for a subsystem as saved in database. The "subsystemName" and "tags" are keys (there is only one active subsystem with that name and tag, others are in historical data).
These objects contain :
- general informations : name, tag, user that created the description, version ...
- an object (saved in database as a Lob) which contains a copy of the DescriptiveNode tree
- a Set of ParameterDescriptions: objects that describe a parameter (see ParameterBase (ParameterPath + type and default value) with infos such as description, constraints, static nature ....
- a list of DeploymentDescriptora that helps identify the needed jars (todo: implement this feature)
A ConfigProfile object will reference such a description but references actual values for modifiable parameters.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected DataFlavour`	`dataFlavour` TODO: only object_tree in future releases (other formats can be provided to constructors)
`static ParameterFilter`	`DEFAULT_TREE_PARAMETER_FILTER` Default filter for parameters: gets rid of all parameters that are references to other components and considers that a parameter with name "name" is out.
`protected Serializable`	`descriptionData` Big object! see DescriptionType enum ...

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SubsystemDescription(String subsystemName, String tag, String user, String version, Serializable descriptionData, DataFlavour dataFlavour)` used by subclasses
`protected`	`SubsystemDescription(SubsystemDescription other)` creates a copy of the SubsystemDescription that is not (yet) registered to the database.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDeploymentDescriptors(DeploymentDescriptor... descriptors)` adds a list of Deployment Descriptors
`abstract void`	`addParameterDescriptions(Collection<ParameterDescription> descriptions)`
`abstract void`	`addParameterDescriptions(ParameterDescription... descriptions)` adds a list of parameter descriptions
`boolean`	`equals(Object o)` compares only the name and tag of subsystems not their content!
`ParameterDescription`	`fetch(PathObject path)` Looks for a parameter description that matches the given path
`ParameterDescription`	`fetch(String pathString)` Looks for a parameter description that matches the given path string
`void`	`generateConfigProperties(Map<String,PrintWriter> printWriters, int levelMax)` Deprecated. subsystem description should not have to handle properties
`Collection<ParameterBase>`	`getBaseParameters()` get the base parameters using the default filter.
`Collection<ParameterBase>`	`getBaseParameters(ParameterFilter filter)` gets the base parameters from a description
`abstract Set<String>`	`getCategorySet()`
`DataFlavour`	`getDataFlavour()`
`List<DeploymentDescriptor>`	`getDeployDescriptors()` The list of deployment descriptors is modifiable only for objects not yet registered in database.
`Serializable`	`getDescriptionData()`
`long`	`getEndTimestamp()`
`abstract long`	`getId()` the technical id: zero if the object is not yet registered in database
`abstract Map<String,? extends ParameterDescription>`	`getParamDescriptionSet()` Detailed description of parameters that can be changed
`Collection<ParameterDescription>`	`getPossibleDescriptions(int maxLevel)`
`Collection<ParameterDescription>`	`getPossibleDescriptions(int maxLevel, ParameterFilter filter)` Looks like the `getBaseParameters` but builds a collection of `ParameterDescription`.
`long`	`getPreviousDescriptionID()` get the id of the previous subsystemDescription with same Name and tag.
`long`	`getStartTimestamp()`
`String`	`getSubsystemName()`
`String`	`getTag()`
`DescriptiveNode`	`getTopComponentNode()` returns the base object structure that describes the subsystem description (as loaded from a text file).
`String`	`getUser()`
`String`	`getVersion()`
`int`	`hashCode()`
`boolean`	`isReadOnly()` tells if the modifying methods can be invoked on a newly created objects.
`static Collection<ParameterDescription>`	`parameterDescriptionsFromNode(DescriptiveNode node, ParameterFilter filter, int maxLevel)`
`static Collection<ParameterBase>`	`parametersFromNode(DescriptiveNode node, ParameterFilter filter)` gets the `ParameterBase` objects that describes arguments passed to the constructor linked to a node of the configuration tree.
`static void`	`populateParameterBasesFromTop(Collection<ParameterBase> list, DescriptiveNode topNode, ParameterFilter filter)` "tree-walker" to populate `ParameterBase` collection
`static void`	`populateParameterDescriptionsFromTop(Collection<ParameterDescription> list, DescriptiveNode topNode, ParameterFilter filter, int maxLevel)`
`void`	`removeDeploymentDescriptors(DeploymentDescriptor... descriptors)` removes a list of Deployment Descriptors
`abstract void`	`removeParameterDescriptions(ParameterDescription... descriptions)` removes a list of parameter descriptions
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - descriptionData
```
protected Serializable descriptionData
```
    Big object! see DescriptionType enum ... but not necessarily that big (so simply serializable Basic could be ok)
  - dataFlavour
```
protected DataFlavour dataFlavour
```
    TODO: only object_tree in future releases (other formats can be provided to constructors)
  - DEFAULT_TREE_PARAMETER_FILTER
```
public static final ParameterFilter DEFAULT_TREE_PARAMETER_FILTER
```
    Default filter for parameters: gets rid of all parameters that are references to other components and considers that a parameter with name "name" is out.
- Constructor Detail
  - SubsystemDescription
```
protected SubsystemDescription(String subsystemName,
                               String tag,
                               String user,
                               String version,
                               Serializable descriptionData,
                               DataFlavour dataFlavour)
```
    used by subclasses
    
    Parameters:
    
    subsystemName - should not be null or empty
    
    tag - may be null or empty
    
    user - user that "owns" the description
    
    version - the version
    
    descriptionData - see DataFlavour documentation
    
    dataFlavour - which type of Configuration data
  - SubsystemDescription
```
protected SubsystemDescription(SubsystemDescription other)
```
    creates a copy of the SubsystemDescription that is not (yet) registered to the database. Subclasses must fill the corresponding paramDescriptions set.
    
    Parameters:
    
    other -
- Method Detail
  - getId
```
public abstract long getId()
```
    the technical id: zero if the object is not yet registered in database
    
    Returns:
    
    the id associated with the subsystem description, as given by the underlying configuration service.
  - getParamDescriptionSet
```
public abstract Map<String,? extends ParameterDescription> getParamDescriptionSet()
```
    Detailed description of parameters that can be changed
    
    Returns:
    
    a Map of parameter descriptions by their path String
  - getCategorySet
```
public abstract Set<String> getCategorySet()
```
  - isReadOnly
```
public boolean isReadOnly()
```
    tells if the modifying methods can be invoked on a newly created objects.
    
    Returns:
    
    false if the object has been already registered in the database
  - getSubsystemName
```
public String getSubsystemName()
```
  - getTag
```
public String getTag()
```
  - getStartTimestamp
```
public long getStartTimestamp()
```
  - getEndTimestamp
```
public long getEndTimestamp()
```
  - getUser
```
public String getUser()
```
  - getVersion
```
public String getVersion()
```
  - getDescriptionData
```
public Serializable getDescriptionData()
```
  - getDataFlavour
```
public DataFlavour getDataFlavour()
```
  - getPreviousDescriptionID
```
public long getPreviousDescriptionID()
```
    get the id of the previous subsystemDescription with same Name and tag. This data is modified by the configuration facade (when replacing a subsystemDescription)
    
    Returns:
    
    0L if there is none
  - getDeployDescriptors
```
public List<DeploymentDescriptor> getDeployDescriptors()
```
    The list of deployment descriptors is modifiable only for objects not yet registered in database. use addDeploymentDescriptor and removeDeploymentDescriptors to modify the list whil the object is not registered.
    
    Returns:
    
    an unmmodifiable view of the Deployment Descriptor list
  - addDeploymentDescriptors
```
public void addDeploymentDescriptors(DeploymentDescriptor... descriptors)
```
    adds a list of Deployment Descriptors
    
    Parameters:
    
    descriptors -
    
    Throws:
    
    ImmutableStateException - if called on an object registered on the database
  - removeDeploymentDescriptors
```
public void removeDeploymentDescriptors(DeploymentDescriptor... descriptors)
```
    removes a list of Deployment Descriptors
    
    Parameters:
    
    descriptors -
    
    Throws:
    
    ImmutableStateException - if called on an object registered on the database
  - equals
```
public boolean equals(Object o)
```
    compares only the name and tag of subsystems not their content!
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o -
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fetch
```
public ParameterDescription fetch(PathObject path)
```
    Looks for a parameter description that matches the given path
    
    Parameters:
    
    path -
    
    Returns:
    
    the parameter description that matches the given path
  - fetch
```
public ParameterDescription fetch(String pathString)
```
    Looks for a parameter description that matches the given path string
    
    Parameters:
    
    pathString -
    
    Returns:
    
    the parameter description that matches the given path String
  - addParameterDescriptions
```
public abstract void addParameterDescriptions(ParameterDescription... descriptions)
```
    adds a list of parameter descriptions
    
    Parameters:
    
    descriptions -
    
    Throws:
    
    ImmutableStateException - if called on an immutable object
  - addParameterDescriptions
```
public abstract void addParameterDescriptions(Collection<ParameterDescription> descriptions)
```
  - removeParameterDescriptions
```
public abstract void removeParameterDescriptions(ParameterDescription... descriptions)
```
    removes a list of parameter descriptions
    
    Parameters:
    
    descriptions -
    
    Throws:
    
    ImmutableStateException - if called on an immutable object
  - getTopComponentNode
```
public DescriptiveNode getTopComponentNode()
```
    returns the base object structure that describes the subsystem description (as loaded from a text file). BEWARE: this data does not describe precisely ParameterDescriptions that may have been edited between creation and this request.
    
    Returns:
    
    the original descriptive node associated with the subsystem description
  - generateConfigProperties
```
public void generateConfigProperties(Map<String,PrintWriter> printWriters,
                                     int levelMax)
```
    Deprecated. subsystem description should not have to handle properties
    
    writes to properties files properties that can be edited to generate a ConfigProfile. One property file is written per category that exist in this subsystem description
    
    Parameters:
    
    printWriters -
    
    levelMax -
  - getBaseParameters
```
public Collection<ParameterBase> getBaseParameters(ParameterFilter filter)
```
    gets the base parameters from a description
    
    Parameters:
    
    filter - drops unwanted parameter bases
    
    Returns:
    
    a Collection of BaseParameter that match the given filter
  - getBaseParameters
```
public Collection<ParameterBase> getBaseParameters()
```
    get the base parameters using the default filter.
    
    Returns:
    
    a Collection of BaseParameter that match the default filter
  - parametersFromNode
```
public static Collection<ParameterBase> parametersFromNode(DescriptiveNode node,
                                                           ParameterFilter filter)
```
    gets the ParameterBase objects that describes arguments passed to the constructor linked to a node of the configuration tree.
    this code should be changed to describe also methods parameters.
    
    Parameters:
    
    node -
    
    filter -
    
    Returns:
    
    the Collection of ParameterBase built out of the descriptive node
  - populateParameterBasesFromTop
```
public static void populateParameterBasesFromTop(Collection<ParameterBase> list,
                                                 DescriptiveNode topNode,
                                                 ParameterFilter filter)
```
    "tree-walker" to populate ParameterBase collection
    
    Parameters:
    
    list -
    
    topNode -
    
    filter -
  - getPossibleDescriptions
```
public Collection<ParameterDescription> getPossibleDescriptions(int maxLevel,
                                                                ParameterFilter filter)
```
    Looks like the getBaseParameters but builds a collection of ParameterDescription. The additional data may be empty if no additional data has been specified in the original text file/
    
    Parameters:
    
    maxLevel -
    
    filter -
    
    Returns:
    
    the Collection of ParameterDescription built out of the descriptive node
  - getPossibleDescriptions
```
public Collection<ParameterDescription> getPossibleDescriptions(int maxLevel)
```
  - populateParameterDescriptionsFromTop
```
public static void populateParameterDescriptionsFromTop(Collection<ParameterDescription> list,
                                                        DescriptiveNode topNode,
                                                        ParameterFilter filter,
                                                        int maxLevel)
```
  - parameterDescriptionsFromNode
```
public static Collection<ParameterDescription> parameterDescriptionsFromNode(DescriptiveNode node,
                                                                             ParameterFilter filter,
                                                                             int maxLevel)
```

Class SubsystemDescription

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

descriptionData

dataFlavour

DEFAULT_TREE_PARAMETER_FILTER

Constructor Detail

SubsystemDescription

SubsystemDescription

Method Detail

getId

getParamDescriptionSet

getCategorySet

isReadOnly

getSubsystemName

getTag

getStartTimestamp

getEndTimestamp

getUser

getVersion

getDescriptionData

getDataFlavour

getPreviousDescriptionID

getDeployDescriptors

addDeploymentDescriptors

removeDeploymentDescriptors

equals

hashCode

toString

fetch

fetch

addParameterDescriptions

addParameterDescriptions

removeParameterDescriptions

getTopComponentNode

generateConfigProperties

getBaseParameters

getBaseParameters

parametersFromNode

populateParameterBasesFromTop

getPossibleDescriptions

getPossibleDescriptions

populateParameterDescriptionsFromTop

parameterDescriptionsFromNode