org.lcsim.conditions

Class ConditionsManager

java.lang.Object

org.lcsim.conditions.ConditionsManager

Direct Known Subclasses:

ConditionsManagerImplementation

public abstract class ConditionsManager
extends Object

The conditions manager is the main interface to the conditions system. The conditions manager allows conditions to be stored in a hierarchical structure, but places no restrictions on the type of data provided. The conditions manager makes no assumptions about how the data is stored or retrieved.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConditionsManager.ConditionsNotFoundException Thrown if conditions associated with a given detector can not be found.
static class	ConditionsManager.ConditionsSetNotFoundException Thrown if specific set of conditions can not be found.

Field Summary

Fields

Modifier and Type	Field and Description
private static ConditionsManager	theConditionsManager

Constructor Summary

Constructors

Constructor and Description
ConditionsManager()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addConditionsListener(ConditionsListener listener) Add a listener to be notified about changes to ANY conditions.
static ConditionsManager	defaultInstance() Get the default (shared) condition manager implementation.
abstract <T> CachedConditions<T>	getCachedConditions(Class<T> type, String name) Access conditions converted to a java object using a conditions converter.
abstract ConditionsSet	getConditions(String name) Get the conditions associated with the given name.
abstract String	getDetector() Get the current detector name
abstract RawConditions	getRawConditions(String name) Get an input stream to directly read raw conditions from the database.
abstract int	getRun() Get the current run number.
static boolean	isSetup() Return true if there is a conditions manager installed.
abstract void	registerConditionsConverter(ConditionsConverter conv) Adds a conditions converter.
abstract void	removeConditionsConverter(ConditionsConverter conv) Removes a conditions converter.
abstract void	removeConditionsListener(ConditionsListener listener) Remove a global change listener.
static void	setDefaultConditionsManager(ConditionsManager manager)
abstract void	setDetector(String name, int run) Normally called automatically by the framework to set the detector name and run number,
abstract void	setRun(int run) Set the current run number.

Methods inherited from class java.lang.Object

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

Field Detail

theConditionsManager

private static ConditionsManager theConditionsManager

Constructor Detail

ConditionsManager

public ConditionsManager()

Method Detail

defaultInstance

public static ConditionsManager defaultInstance()

Get the default (shared) condition manager implementation.

Returns:

The default conditions manager.

setDefaultConditionsManager

public static void setDefaultConditionsManager(ConditionsManager manager)

isSetup

public static boolean isSetup()

Return true if there is a conditions manager installed.

Returns:

true if conditions managed is setup

setDetector

public abstract void setDetector(String name,
               int run)
                          throws ConditionsManager.ConditionsNotFoundException

Normally called automatically by the framework to set the detector name and run number,

Parameters:

name - The current detector name.

run - The current run number.

Throws:

ConditionsManager.ConditionsNotFoundException - If the conditions associated with this detector/run number can not be found.

setRun

public abstract void setRun(int run)
                     throws ConditionsManager.ConditionsNotFoundException

Set the current run number. Normally called automatically by the framework.

Parameters:

run - The current run number

Throws:

ConditionsManager.ConditionsNotFoundException - If the conditions associated with the specified run number can not be found.

getDetector

public abstract String getDetector()

Get the current detector name

Returns:

The detector name.

getRun

public abstract int getRun()

Get the current run number.

Returns:

The run number.

getConditions

public abstract ConditionsSet getConditions(String name)
                                     throws ConditionsManager.ConditionsSetNotFoundException

Get the conditions associated with the given name.

Parameters:

name - The name of the conditions to search for.

Returns:

The requested conditions.

Throws:

ConditionsManager.ConditionsSetNotFoundException - If the named conditions can not be found.

getCachedConditions

public abstract <T> CachedConditions<T> getCachedConditions(Class<T> type,
                                          String name)
                                                 throws ConditionsManager.ConditionsSetNotFoundException

Access conditions converted to a java object using a conditions converter. The conditions are cached so that they do not need to be re-read each time the same object is requested.

Parameters:

type - The type of conditions requested (used to select an appropriate conditions converter).

name - The name of the conditions requested.

Returns:

The converted conditions.

Throws:

ConditionsManager.ConditionsSetNotFoundException - If the specified conditions can not be found.

getRawConditions

public abstract RawConditions getRawConditions(String name)
                                        throws ConditionsManager.ConditionsSetNotFoundException

Get an input stream to directly read raw conditions from the database. The database makes no assumptions about the format of the data when this method is used.

Parameters:

name - The name of the conditions requested.

Returns:

The input stream from which the data can be read. The called should close thsi input stream when they have finished using it.

Throws:

ConditionsManager.ConditionsSetNotFoundException - If the requested conditions can not be found.

registerConditionsConverter

public abstract void registerConditionsConverter(ConditionsConverter conv)

Adds a conditions converter. A conditions converter can be used to convert data requested by the user into a specific Java object.

Parameters:

conv - The converter to add.

removeConditionsConverter

public abstract void removeConditionsConverter(ConditionsConverter conv)

Removes a conditions converter.

Parameters:

conv - The converter to remove.

addConditionsListener

public abstract void addConditionsListener(ConditionsListener listener)

Add a listener to be notified about changes to ANY conditions.

Parameters:

listener - The listener to add.

removeConditionsListener

public abstract void removeConditionsListener(ConditionsListener listener)

Remove a global change listener.

Parameters:

listener - The listener to remove.