org.yamcs.xtce

Class XtceDb

java.lang.Object

org.yamcs.xtce.XtceDb

All Implemented Interfaces:

Serializable

public class XtceDb
extends Object
implements Serializable

XtceDB database It contains a SpaceSystem as defined in the Xtce schema and has lots of hashes to help find things quickly

Author:

mache

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	YAMCS_CMD_SPACESYSTEM_NAME
static String	YAMCS_CMDHIST_SPACESYSTEM_NAME
static String	YAMCS_SPACESYSTEM_NAME Namespaces system parameters

Constructor Summary

Constructors

Constructor and Description
XtceDb(SpaceSystem spaceSystem)

Method Summary

Modifier and Type	Method and Description
void	addMetaCommand(MetaCommand c) Adds a new command definition to the XTCE db.
void	addParameter(Parameter p, boolean createSpaceSystem) Adds a new parameter to the XTCE db.
void	addSpaceSystem(SpaceSystem system) Adds a new spacesystem to the XTCE db.
void	buildIndexMaps() Called after the database has been populated to build the maps for quickly finding things
boolean	containsNamespace(String namespace)
Algorithm	getAlgorithm(String qualifiedName)
Algorithm	getAlgorithm(String namespace, String name)
Algorithm	getAlgorithm(Yamcs.NamedObjectId id)
Collection<Algorithm>	getAlgorithms()
List<ContainerEntry>	getContainerEntries(SequenceContainer sc)
List<SequenceContainer>	getInheritingContainers(SequenceContainer container)
MetaCommand	getMetaCommand(String qualifiedName)
MetaCommand	getMetaCommand(String namespace, String name) Returns a command based on a name in a namespace
MetaCommand	getMetaCommand(Yamcs.NamedObjectId id)
Collection<MetaCommand>	getMetaCommands() Returns the list of MetaCommmands in the XTCE database
Set<String>	getNamespaces()
Collection<NonStandardData>	getNonStandardData()
<T extends NonStandardData<T>> T	getNonStandardDataOfType(Class<T> clazz)
Parameter	getParameter(String qualifiedName)
Parameter	getParameter(String namespace, String name)
Parameter	getParameter(Yamcs.NamedObjectId id)
List<ParameterEntry>	getParameterEntries(Parameter p)
Collection<String>	getParameterNames()
Collection<Parameter>	getParameters()
SequenceContainer	getRootSequenceContainer()
SpaceSystem	getRootSpaceSystem()
SequenceContainer	getSequenceContainer(String qualifiedName)
SequenceContainer	getSequenceContainer(String namespace, String name)
SequenceContainer	getSequenceContainer(Yamcs.NamedObjectId id)
Collection<SequenceContainer>	getSequenceContainers()
SpaceSystem	getSpaceSystem(String qualifiedName)
SpaceSystem	getSpaceSystem(String namespace, String name)
SpaceSystem	getSpaceSystem(Yamcs.NamedObjectId id)
Collection<SpaceSystem>	getSpaceSystems()
static boolean	isSystemParameter(Yamcs.NamedObjectId id)
void	print(PrintStream out)
void	setRootSequenceContainer(SequenceContainer sc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

YAMCS_SPACESYSTEM_NAME

public static final String YAMCS_SPACESYSTEM_NAME

Namespaces system parameters

See Also:

Constant Field Values

YAMCS_CMD_SPACESYSTEM_NAME

public static final String YAMCS_CMD_SPACESYSTEM_NAME

See Also:

Constant Field Values

YAMCS_CMDHIST_SPACESYSTEM_NAME

public static final String YAMCS_CMDHIST_SPACESYSTEM_NAME

See Also:

Constant Field Values

Constructor Detail

XtceDb

public XtceDb(SpaceSystem spaceSystem)

Method Detail

getSequenceContainer

public SequenceContainer getSequenceContainer(String qualifiedName)

getSequenceContainer

public SequenceContainer getSequenceContainer(String namespace,
                                              String name)

getSequenceContainer

public SequenceContainer getSequenceContainer(Yamcs.NamedObjectId id)

getParameter

public Parameter getParameter(String qualifiedName)

getParameter

public Parameter getParameter(String namespace,
                              String name)

getParameter

public Parameter getParameter(Yamcs.NamedObjectId id)

getRootSequenceContainer

public SequenceContainer getRootSequenceContainer()

setRootSequenceContainer

public void setRootSequenceContainer(SequenceContainer sc)

getAlgorithm

public Algorithm getAlgorithm(String qualifiedName)

getAlgorithm

public Algorithm getAlgorithm(String namespace,
                              String name)

getAlgorithm

public Algorithm getAlgorithm(Yamcs.NamedObjectId id)

getAlgorithms

public Collection<Algorithm> getAlgorithms()

getParameters

public Collection<Parameter> getParameters()

containsNamespace

public boolean containsNamespace(String namespace)

getNamespaces

public Set<String> getNamespaces()

getMetaCommand

public MetaCommand getMetaCommand(String qualifiedName)

getMetaCommand

public MetaCommand getMetaCommand(String namespace,
                                  String name)

Returns a command based on a name in a namespace

Parameters:

namespace -

name -

Returns:

getMetaCommand

public MetaCommand getMetaCommand(Yamcs.NamedObjectId id)

getMetaCommands

public Collection<MetaCommand> getMetaCommands()

Returns the list of MetaCommmands in the XTCE database

Returns:

getRootSpaceSystem

public SpaceSystem getRootSpaceSystem()

getSpaceSystem

public SpaceSystem getSpaceSystem(String qualifiedName)

getSpaceSystem

public SpaceSystem getSpaceSystem(String namespace,
                                  String name)

getSpaceSystem

public SpaceSystem getSpaceSystem(Yamcs.NamedObjectId id)

getSequenceContainers

public Collection<SequenceContainer> getSequenceContainers()

getParameterEntries

public List<ParameterEntry> getParameterEntries(Parameter p)

Returns:

list of ParameterEntry corresponding to a given parameter.

getContainerEntries

public List<ContainerEntry> getContainerEntries(SequenceContainer sc)

Returns:

list of ContainerEntry corresponding to a given sequence container.

getParameterNames

public Collection<String> getParameterNames()

getNonStandardDataOfType

public <T extends NonStandardData<T>> T getNonStandardDataOfType(Class<T> clazz)

getNonStandardData

public Collection<NonStandardData> getNonStandardData()

buildIndexMaps

public void buildIndexMaps()

Called after the database has been populated to build the maps for quickly finding things

getInheritingContainers

public List<SequenceContainer> getInheritingContainers(SequenceContainer container)

addParameter

public void addParameter(Parameter p,
                         boolean createSpaceSystem)

Adds a new parameter to the XTCE db. If the SpaceSystem where this parameter belongs does not exist, and createSpaceSystem is false, throws an IllegalArgumentException If the SpaceSystem where this parameter belongs exists and already contains an parameter by this name, throws and IllegalArgumentException If the SpaceSystem where this parameter belongs does not exist, and createSpaceSystem is true, the whole SpaceSystem hierarchy is created. Note that this method is used to create parameters on the fly. The parameters are not saved anywhere and they will not be available when this object is created by the XtceDbFactory.

Parameters:

p -

createSpaceSystem - - if true, create all the necessary space systems

addMetaCommand

public void addMetaCommand(MetaCommand c)

Adds a new command definition to the XTCE db.

Note that this method is used to create commands on the fly.
The commands are not saved anywhere and they will not be available when this object is created with the XtceDbFactory.

addSpaceSystem

public void addSpaceSystem(SpaceSystem system)

Adds a new spacesystem to the XTCE db. It throws an IllegalArgumentException in the following circumstances: - if a SpaceSystem with this name already exists - if system.getParent() does not return null - if the parent SpaceSystem does not exist - if the space system is not empty This method also sets the parent of the passed spacesystem to its parent object. Note that this method is used to create SpaceSystems on the fly. The SpaceSystems are not saved anywhere and they will not be available when this object is created by the XtceDbFactory.

Parameters:

system -

isSystemParameter

public static boolean isSystemParameter(Yamcs.NamedObjectId id)

print

public void print(PrintStream out)

getSpaceSystems

public Collection<SpaceSystem> getSpaceSystems()