org.lcsim.conditions.readers

Class BaseClasspathConditionsReader

java.lang.Object

org.lcsim.conditions.ConditionsReader

org.lcsim.conditions.readers.BaseClasspathConditionsReader

public class BaseClasspathConditionsReader
extends ConditionsReader

This ConditionsReader finds conditions from embedded jar resources based on a resource path.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) String	_detectorName
private String	_resourcePath
(package private) int	_runNumber
(package private) String	propFileName

Constructor Summary

Constructors

Constructor and Description
BaseClasspathConditionsReader()
BaseClasspathConditionsReader(String resourcePath)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the reader.
InputStream	open(String name, String type) Open an InputStream to conditions data by name and type.
void	setResourcePath(String resourcePath) Set the base path for this reader to search for classpath resources.
boolean	update(ConditionsManager manager, String detectorName, int run) Update this reader for possibly new detector or run number.

Methods inherited from class org.lcsim.conditions.ConditionsReader

addAlias, createDummy, getDetectorNames

Methods inherited from class java.lang.Object

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

Field Detail

_resourcePath

private String _resourcePath

propFileName

String propFileName

_runNumber

int _runNumber

_detectorName

String _detectorName

Constructor Detail

BaseClasspathConditionsReader

public BaseClasspathConditionsReader()

BaseClasspathConditionsReader

public BaseClasspathConditionsReader(String resourcePath)
                              throws IOException

Throws:

IOException

Method Detail

open

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

Open an InputStream to conditions data by name and type. To be found, the conditions data must exist as a resource on the classpath like: /[resourcePath]/[name].[type] It will throw an IOException if the conditions do not exist.

Specified by:

open in class ConditionsReader

Returns:

An InputStream to the conditions data or null if does not exist.

Throws:

IOException

setResourcePath

public void setResourcePath(String resourcePath)

Set the base path for this reader to search for classpath resources.

Parameters:

resourcePath - the resource path

update

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

Update this reader for possibly new detector or run number. This reader caches the detector name and run number, and this method will return new if either is different from the cached values.

Overrides:

update in class ConditionsReader

Returns:

true if new detector or run number

Throws:

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

close

public void close()
           throws IOException

Close the reader.

Specified by:

close in class ConditionsReader

Throws:

IOException - never