org.lsst.ccs.localdb.configdb.model

Class ParameterDescription

java.lang.Object

org.lsst.ccs.localdb.configdb.model.ParameterDescription

All Implemented Interfaces:

Serializable, Comparable<PathObject>, PathObject

Direct Known Subclasses:

AParameterDescription

@MappedSuperclass
public abstract class ParameterDescription
extends Object
implements Serializable, PathObject

The base class for all Parameter descriptions

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description possible details.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParameterDescription()
protected	ParameterDescription(ParameterBase parameterBase) builds a default Description out of a ParameterBase which is described in the original setup.
protected	ParameterDescription(ParameterDescription other) copy constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) equals is special: it works with any Path Object!
String	getCategory()
String	getCodeName()
String	getComponentName()
String	getDefaultValue()
String	getDescription()
abstract long	getId()
int	getLevel()
ParameterBase	getParameterBase()
String	getParameterName()
ParameterPath	getPath()
String	getSimpleName()
String	getTypeName()
int	hashCode()
boolean	isReadOnly()
void	setCategory(String category)
void	setDescription(String description) this data is not essential to the logic so it is modifiable anyway.
protected abstract void	setId(long id)
void	setLevel(int level)
protected void	setParameterBase(ParameterBase parameterBase)
void	setSimpleName(String simpleName)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.localdb.configdb.model.PathObject

compareTo

Field Detail

description

protected String description

possible details. Immutable in Ghost data

Constructor Detail

ParameterDescription

protected ParameterDescription()

ParameterDescription

protected ParameterDescription(ParameterBase parameterBase)

builds a default Description out of a ParameterBase which is described in the original setup.

Parameters:

parameterBase -

ParameterDescription

protected ParameterDescription(ParameterDescription other)

copy constructor. Beware: the id is copied so do not use to make a new Parameterdescription that is to be registered later.

Parameters:

other -

Method Detail

getId

public abstract long getId()

setId

protected abstract void setId(long id)

isReadOnly

public boolean isReadOnly()

getParameterBase

public ParameterBase getParameterBase()

setParameterBase

protected void setParameterBase(ParameterBase parameterBase)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

this data is not essential to the logic so it is modifiable anyway.

Parameters:

description -

getSimpleName

public String getSimpleName()

setSimpleName

public void setSimpleName(String simpleName)

getCategory

public String getCategory()

setCategory

public void setCategory(String category)

getLevel

public int getLevel()

setLevel

public void setLevel(int level)

equals

public boolean equals(Object o)

equals is special: it works with any Path Object!

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

getComponentName

public String getComponentName()

getCodeName

public String getCodeName()

getParameterName

public String getParameterName()

getDefaultValue

public String getDefaultValue()

getPath

public ParameterPath getPath()

Specified by:

getPath in interface PathObject

getTypeName

public String getTypeName()