ConfigProfile (LSST CCS - Toolkit (Pom) 3.1.3 API)

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

All Implemented Interfaces:

Serializable
```
@MappedSuperclass
public abstract class ConfigProfile
extends Object
implements Serializable
```
This class represents a set of parameter that have been modified for a given subsystem.
Important notice : for the moment an active configuration profile has a name and a tag. This combination is unique amongst active profile. BUT this is not the case once data of this type has been "pushed in history" :
- in history there are many versions of the same config profile
- it is not guaranteed that the same config name may be re-used for another subsystem
So these naming strategies should be re-evaluated after some experimental uses.
Author:

bamade

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ConfigProfile()`
`protected`	`ConfigProfile(String subsystemName, String tag, String categoryName, String configName)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`addParameterConfiguration(String parameterName, String value)`
`abstract void`	`addParameterConfigurations(ParameterConfiguration... parameterConfigurations)` registers a list of parameter configurations
`boolean`	`equals(Object o)`
`protected ParameterConfiguration`	`fetch(PathObject path)` Looks if the `ConfigProfile` object contains a modification for the parameter defined by the specified `PathObject`
`List<ParameterConfiguration>`	`getAllReconfigurationFailures()` after a failed repair gets all the failed Modifications
`String`	`getCategoryName()`
`String`	`getConfigName()`
`long`	`getEndTimestamp()`
`abstract long`	`getId()`
`abstract Set<? extends ParameterConfiguration>`	`getModifiedParameters()`
`String`	`getName()`
`long`	`getPreviousConfigID()` may return the id of a previous ConfigProfile (0L if none)
`String`	`getRemarks()`
`long`	`getStartTimestamp()`
`abstract SubsystemDescription`	`getSubsystemDescription()`
`String`	`getSubsystemName()`
`String`	`getTag()`
`String`	`getValueAt(ParameterPath path, long date)`
`String`	`getValueAt(String parameterPath, long date)` gives the value of a given parameter at a given date on a ConfigProfile object.
`int`	`hashCode()`
`abstract boolean`	`isDirty()`
`boolean`	`isReadOnly()`
`abstract void`	`removeParameterConfigurations(ParameterConfiguration... parameterConfigurations)` removes a list of parameter configurations
`List<String>`	`reportFailures()` lists the failures as String.
`protected abstract void`	`setId(long id)`
`void`	`setName(String name)`
`void`	`setRemarks(String remarks)` no influence on behaviour.
`protected void`	`setStartTimestamp(long startTimestamp)`
`void`	`setSubsystemName(String subsystemName)`
`abstract ParameterConfiguration`	`temporaryChangeConfigurationValue(String parameterPath, long time, String value)`
`String`	`toString()`

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

Constructor Detail

ConfigProfile
```
protected ConfigProfile()
```

ConfigProfile

protected ConfigProfile(String subsystemName,
                        String tag,
                        String categoryName,
                        String configName)

Method Detail
- getId
```
public abstract long getId()
```
- setId
```
protected abstract void setId(long id)
```
- getSubsystemDescription
```
public abstract SubsystemDescription getSubsystemDescription()
```
- getModifiedParameters
```
public abstract Set<? extends ParameterConfiguration> getModifiedParameters()
```
- temporaryChangeConfigurationValue
```
public abstract ParameterConfiguration temporaryChangeConfigurationValue(String parameterPath,
                                                                         long time,
                                                                         String value)
```
- isReadOnly
```
public boolean isReadOnly()
```
- getName
```
public String getName()
```
- setName
```
public void setName(String name)
```
- getSubsystemName
```
public String getSubsystemName()
```
- setSubsystemName
```
public void setSubsystemName(String subsystemName)
```
- getTag
```
public String getTag()
```
- getCategoryName
```
public String getCategoryName()
```
- getConfigName
```
public String getConfigName()
```
- getStartTimestamp
```
public long getStartTimestamp()
```
- setStartTimestamp
```
protected void setStartTimestamp(long startTimestamp)
```
- getEndTimestamp
```
public long getEndTimestamp()
```
- getRemarks
```
public String getRemarks()
```
- setRemarks
```
public void setRemarks(String remarks)
```
  no influence on behaviour.
  
  Parameters:
  
  remarks -
- getPreviousConfigID
```
public long getPreviousConfigID()
```
  may return the id of a previous ConfigProfile (0L if none)
  
  Returns:
  
  the id of a previous config profile
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- fetch
```
protected ParameterConfiguration fetch(PathObject path)
```
  Looks if the ConfigProfile object contains a modification for the parameter defined by the specified PathObject
  
  Parameters:
  
  path -
  
  Returns:
  
  a parameterConfiguration that matches the specified PathObject
- getAllReconfigurationFailures
```
public List<ParameterConfiguration> getAllReconfigurationFailures()
```
  after a failed repair gets all the failed Modifications
  
  Returns:
  
  a list of ParameterConfiguration that have failed to be modified.
- reportFailures
```
public List<String> reportFailures()
```
  lists the failures as String.
  
  Returns:
  
  a String representation of the configuration failures.
- addParameterConfiguration
```
public abstract void addParameterConfiguration(String parameterName,
                                               String value)
```
- addParameterConfigurations
```
public abstract void addParameterConfigurations(ParameterConfiguration... parameterConfigurations)
```
  registers a list of parameter configurations
  
  Parameters:
  
  parameterConfigurations -
  
  Throws:
  
  ImmutableStateException - if the object is already registered in database
  
  IllegalArgumentException - if levels are incompatibles
  
  IllegalArgumentException - if the corresponding parameter descriptions are not alive in the current subsystem description
- removeParameterConfigurations
```
public abstract void removeParameterConfigurations(ParameterConfiguration... parameterConfigurations)
```
  removes a list of parameter configurations
  
  Parameters:
  
  parameterConfigurations -
  
  Throws:
  
  ImmutableStateException - if operated on an object registered to the database
- getValueAt
```
public String getValueAt(String parameterPath,
                         long date)
```
  gives the value of a given parameter at a given date on a ConfigProfile object. beware : the main goal of this method is to fetch a transient parameter set during an engineering mode session. Otherwise it just returns the value of the parameter without any time stamp check (it is supposed that the ConfigProfile object was the one active at this date.
  
  Parameters:
  
  parameterPath -
  
  date -
  
  Returns:
  
  null if parameter not found
- getValueAt
```
public String getValueAt(ParameterPath path,
                         long date)
```
- isDirty
```
public abstract boolean isDirty()
```
  Returns:
  
  true if the ConfigProfile object contains unsaved changes

Class ConfigProfile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigProfile

ConfigProfile

Method Detail

getId

setId

getSubsystemDescription

getModifiedParameters

temporaryChangeConfigurationValue

isReadOnly

getName

setName

getSubsystemName

setSubsystemName

getTag

getCategoryName

getConfigName

getStartTimestamp

setStartTimestamp

getEndTimestamp

getRemarks

setRemarks

getPreviousConfigID

equals

hashCode

toString

fetch

getAllReconfigurationFailures

reportFailures

addParameterConfiguration

addParameterConfigurations

removeParameterConfigurations

getValueAt

getValueAt

isDirty