org.lsst.ccs.config

Class ASubsystemDescription

java.lang.Object

org.lsst.ccs.config.SubsystemDescription

org.lsst.ccs.config.ASubsystemDescription

All Implemented Interfaces:

Serializable, Cloneable

@Entity
public class ASubsystemDescription
extends SubsystemDescription
implements Cloneable

An active subsystem Description. Can be "unregistered" (id is zero) or "registered" in the database (Id is not zero) in that case the object is immutable (more precisely only comments can be modified). Subsystem name and tag constitute a unique key in the active table.

Author:

bamade

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<ParameterPath,AParameterDescription>	paramDescriptions the set containing the parameter descriptions

Fields inherited from class org.lsst.ccs.config.SubsystemDescription

descriptionData

Constructor Summary

Constructors

Constructor and Description
ASubsystemDescription(String subsystemName, String tag, Serializable configurationData) same parameters and constraints as the superclass constructor
ASubsystemDescription(SubsystemDescription other) creates a new SubsystemDescription without information set up by the database (id, startDate)

Method Summary

Modifier and Type	Method and Description
void	addParameterDescriptions(AParameterDescription... descriptions) adds a list of parameter descriptions
void	addParameterDescriptions(Collection<ParameterDescription> descriptions)
void	addParameterDescriptions(ParameterDescription... descriptions) add Parameter descriptions: this is a public facade to the "real" method that adds only objects of type AParameterDescription So if objects are not ot this actual type new objects of the needed type are created (see AParameterDescription constructor documentation)
ASubsystemDescription	clone() clone: the contained set of parameter description is also cloned.
Set<String>	getCategorySet()
long	getId() the technical id: zero if the object is not yet registered in database
Map<ParameterPath,? extends ParameterDescription>	getParamDescriptionMap() Detailed description of parameters that can be changed
long	getStartTimestamp()
void	removeParameterDescriptions(ParameterDescription... descriptions) removes a list of parameter descriptions.

Methods inherited from class org.lsst.ccs.config.SubsystemDescription

equals, fetch, fetch, getDescriptionData, getEndTimestamp, getPreviousDescriptionID, getSubsystemName, getTag, hashCode, isReadOnly, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

paramDescriptions

protected Map<ParameterPath,AParameterDescription> paramDescriptions

the set containing the parameter descriptions

Constructor Detail

ASubsystemDescription

public ASubsystemDescription(String subsystemName,
                             String tag,
                             Serializable configurationData)

same parameters and constraints as the superclass constructor

Parameters:

subsystemName -

tag -

configurationData -

ASubsystemDescription

public ASubsystemDescription(SubsystemDescription other)

creates a new SubsystemDescription without information set up by the database (id, startDate)

Parameters:

other -

Method Detail

getId

public long getId()

Description copied from class: SubsystemDescription

the technical id: zero if the object is not yet registered in database

Specified by:

getId in class SubsystemDescription

Returns:

the id associated with the subsystem description, as given by the underlying configuration service.

getParamDescriptionMap

public Map<ParameterPath,? extends ParameterDescription> getParamDescriptionMap()

Description copied from class: SubsystemDescription

Detailed description of parameters that can be changed

Specified by:

getParamDescriptionMap in class SubsystemDescription

Returns:

a Map of parameter descriptions by their path String

getCategorySet

public Set<String> getCategorySet()

Specified by:

getCategorySet in class SubsystemDescription

getStartTimestamp

public long getStartTimestamp()

Overrides:

getStartTimestamp in class SubsystemDescription

clone

public ASubsystemDescription clone()

clone: the contained set of parameter description is also cloned. (each description is cloned)

Overrides:

clone in class Object

Returns:

a clone of the object

addParameterDescriptions

public void addParameterDescriptions(ParameterDescription... descriptions)

add Parameter descriptions: this is a public facade to the "real" method that adds only objects of type AParameterDescription So if objects are not ot this actual type new objects of the needed type are created (see AParameterDescription constructor documentation)

Specified by:

addParameterDescriptions in class SubsystemDescription

Parameters:

descriptions -

addParameterDescriptions

public void addParameterDescriptions(Collection<ParameterDescription> descriptions)

Specified by:

addParameterDescriptions in class SubsystemDescription

addParameterDescriptions

public void addParameterDescriptions(AParameterDescription... descriptions)

adds a list of parameter descriptions

Parameters:

descriptions -

Throws:

ImmutableStateException - if called on an immutable object

removeParameterDescriptions

public void removeParameterDescriptions(ParameterDescription... descriptions)

removes a list of parameter descriptions.

works with any subclass of parameterDescription (see equals method code)

Specified by:

removeParameterDescriptions in class SubsystemDescription

Parameters:

descriptions -

Throws:

ImmutableStateException - if called on an immutable object