org.lcsim.conditions

Class ConditionsReader

java.lang.Object

org.lcsim.conditions.ConditionsReader

Direct Known Subclasses:

BaseClasspathConditionsReader, DirectoryConditionsReader, DummyConditionsReader, ZipConditionsReader

public abstract class ConditionsReader
extends Object

Author:

tonyj, Jeremy McCormick

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ConditionsReader.DetectorFileValidator

Field Summary

Fields

Modifier and Type	Field and Description
private static Properties	aliases
private static FileCache	cache
private static File	home

Constructor Summary

Constructors

Constructor and Description
ConditionsReader()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addAlias(String alias, String target)
abstract void	close()
(package private) static ConditionsReader	create(ConditionsManager manager, String detectorName, int run) Creates ConditionsReader to handle the specified detector and run.
(package private) static ConditionsReader	create(String detectorName, int run) Try to find the conditions associated with this detector.
static ConditionsReader	createDummy()
private static File	downloadDetectorDescription(URL url)
static List<String>	getDetectorNames() Get a list of available detectors
private static Properties	loadAliases()
abstract InputStream	open(String name, String type)
private static String	resolveAlias(String detectorName)
protected boolean	update(ConditionsManager manager, String detectorName, int run) Called by ConditionsManager.setDetector(java.lang.String, int) to tell this reader that it needs to prepare itself for reading conditions for the specified detector and run.

Methods inherited from class java.lang.Object

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

Field Detail

aliases

private static Properties aliases

home

private static final File home

cache

private static FileCache cache

Constructor Detail

ConditionsReader

public ConditionsReader()

Method Detail

update

protected boolean update(ConditionsManager manager,
             String detectorName,
             int run)
                  throws IOException

Called by ConditionsManager.setDetector(java.lang.String, int) to tell this reader that it needs to prepare itself for reading conditions for the specified detector and run.

The implementation provided by this class returns false if the specified detector name is equal to the name of the current detector known to the specified ConditionsManager, and throws IllegalArgumentException if it is not. Subclasses need to override this method if conditions might be different for different runs with the same detector.

Returns:

true if conditions for the specified detector/run may be different from conditions for the previous detector/run combination; false otherwise.

Throws:

IllegalArgumentException - if this ConditionsReader cannot handle the specified detector/run.

IOException - if the reader fails to update for any other reason.

getDetectorNames

public static List<String> getDetectorNames()

Get a list of available detectors

addAlias

public static void addAlias(String alias,
            String target)

createDummy

public static ConditionsReader createDummy()

resolveAlias

private static String resolveAlias(String detectorName)
                            throws IOException

Throws:

IOException

create

static ConditionsReader create(String detectorName,
                      int run)
                        throws ConditionsManager.ConditionsNotFoundException

Try to find the conditions associated with this detector. For more details see @link http://confluence.slac.stanford.edu/display/ilc/Conditions+database

Throws:

ConditionsManager.ConditionsNotFoundException

create

static ConditionsReader create(ConditionsManager manager,
                      String detectorName,
                      int run)
                        throws ConditionsManager.ConditionsNotFoundException

Creates ConditionsReader to handle the specified detector and run.

Throws:

ConditionsManager.ConditionsNotFoundException - if creation of the reader fails for any reason.

open

public abstract InputStream open(String name,
               String type)
                          throws IOException

Throws:

IOException

close

public abstract void close()
                    throws IOException

Throws:

IOException

loadAliases

private static Properties loadAliases()

downloadDetectorDescription

private static File downloadDetectorDescription(URL url)
                                         throws IOException

Throws:

IOException