SubsystemDescription (LSST CCS - configuration database definitions 2.1.4 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 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)
`protected Serializable`	`descriptionData` Big object! see DescriptionType enum ...

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SubsystemDescription(String subsystemName, String tag, 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 Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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
`abstract Set<String>`	`getCategorySet()`
`DataFlavour`	`getDataFlavour()`
`Serializable`	`getDescriptionData()`
`long`	`getEndTimestamp()`
`abstract long`	`getId()` the technical id: zero if the object is not yet registered in database
`abstract Map<ParameterPath,? extends ParameterDescription>`	`getParamDescriptionMap()` Detailed description of parameters that can be changed
`long`	`getPreviousDescriptionID()` get the id of the previous subsystemDescription with same Name and tag.
`long`	`getStartTimestamp()`
`String`	`getSubsystemName()`
`String`	`getTag()`
`int`	`hashCode()`
`boolean`	`isReadOnly()` tells if the modifying methods can be invoked on a newly created objects.
`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)
- Constructor Detail
  - SubsystemDescription
```
protected SubsystemDescription(String subsystemName,
                               String tag,
                               Serializable descriptionData,
                               DataFlavour dataFlavour)
```
    used by subclasses
    
    Parameters:
    
    subsystemName - should not be null or empty
    
    tag - may be null or empty
    
    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.
  - getParamDescriptionMap
```
public abstract Map<ParameterPath,? extends ParameterDescription> getParamDescriptionMap()
```
    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()
```
  - 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
  - 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
  - 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 -

Class SubsystemDescription

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

descriptionData

dataFlavour

Constructor Detail

SubsystemDescription

SubsystemDescription

Method Detail

getId

getParamDescriptionMap

getCategorySet

isReadOnly

getSubsystemName

getTag

getStartTimestamp

getEndTimestamp

getDescriptionData

getDataFlavour

getPreviousDescriptionID

equals

hashCode

toString

fetch

fetch

addParameterDescriptions

addParameterDescriptions

removeParameterDescriptions

generateConfigProperties