org.lsst.ccs.startup

Class BootUtils.LocalBootObject

java.lang.Object

org.lsst.ccs.startup.BootUtils.LocalBootObject

Enclosing class:

BootUtils

public static class BootUtils.LocalBootObject
extends Object

Very important class: when an instance is created you can have :

• a descriptive Node
• the names of subsystem, configuration, tag
• the corresponding Effective Node
• a Subsystem ready to run (but not started)

Constructor Summary

Constructors

Constructor and Description
LocalBootObject(String pathName) creates a boot Object from a description file name
LocalBootObject(String fullDescription, String config) creates a boot Object from a description file name and a configuration property file.
LocalBootObject(String fullDescription, String config, String subsystemAlias)

Method Summary

Modifier and Type	Method and Description
org.lsst.ccs.description.DescriptiveNode	getDescriptiveNode() Gets the initial descriptive node, ie the DescriptiveNode that is built out of the description file only.
org.lsst.ccs.description.DescriptiveNode	getModifiedDescriptiveNode() returns the descriptive node as modified by configuration.
Object	getRunningObject(String key) Gets a reference to a component built by the description file.
Subsystem	getSubsystem()
String	getSubsystemName()
String	getTagName()

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalBootObject

public LocalBootObject(String pathName)
                throws Exception

creates a boot Object from a description file name

Parameters:

pathName -

Throws:

Exception

LocalBootObject

public LocalBootObject(String fullDescription,
                       String config)
                throws Exception

creates a boot Object from a description file name and a configuration property file. The values in the configuration file override the parameters set in the description File.

Parameters:

fullDescription -

config - can be a file name OR the config name only

Throws:

Exception

LocalBootObject

public LocalBootObject(String fullDescription,
                       String config,
                       String subsystemAlias)
                throws Exception

Throws:

Exception

Method Detail

getDescriptiveNode

public org.lsst.ccs.description.DescriptiveNode getDescriptiveNode()

Gets the initial descriptive node, ie the DescriptiveNode that is built out of the description file only.

Returns:

a DescriptiveNode object

getModifiedDescriptiveNode

public org.lsst.ccs.description.DescriptiveNode getModifiedDescriptiveNode()

returns the descriptive node as modified by configuration. (could be identical to initial DescriptiveNode)

Returns:

a DescriptiveNode object

getSubsystem

public Subsystem getSubsystem()

getSubsystemName

public String getSubsystemName()

getTagName

public String getTagName()

getRunningObject

public Object getRunningObject(String key)

Gets a reference to a component built by the description file. beware if the subsystem is not started the object may not have been completely initialized (the start() method of the subsystem invokes various initialization)

Parameters:

key - the name of the component.

Returns:

a reference to a component that fits the name "key"