Package org.scictrl.mp.orbitcorrect.accessories

Class PropertiesReader

java.lang.Object

org.scictrl.mp.orbitcorrect.accessories.AbstractParameterReader

org.scictrl.mp.orbitcorrect.accessories.PropertiesReader

All Implemented Interfaces:

IDataBushReader

public class PropertiesReader
extends AbstractParameterReader
implements IDataBushReader

PropertiesReader is used to read input files and return the ElementList of elements in storage ring.

Author:

igor@scictrl.com

Field Summary

Fields inherited from class org.scictrl.mp.orbitcorrect.accessories.AbstractParameterReader

log, st, tok, uRL

Fields inherited from interface org.scictrl.mp.orbitcorrect.IDataBushReader

ST_FILE, ST_URL

Constructor Summary

Constructors

Constructor	Description
PropertiesReader()	Constructor.

Method Summary

Modifier and Type	Method	Description
ElementList<AbstractDataBushElement>	getList()	Returns list of instances of DataBush elements created by read() method.
void	open(File file)	open method comment.
void	open(URL url)	open method comment.
ElementList<AbstractDataBushElement>	read()	Reads input and creates DataBush elements.
ElementList<AbstractDataBushElement>	read(ElementList<AbstractDataBushElement> l)	Reads input and creates DataBush elements.

Methods inherited from class org.scictrl.mp.orbitcorrect.accessories.AbstractParameterReader

close, debugPrint, debugPrintln, getProperties, getSourceType, getURL, setProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scictrl.mp.orbitcorrect.IDataBushReader

close, getProperties, getSourceType, setProperties

Constructor Details

PropertiesReader

public PropertiesReader()

Constructor.

Method Details

getList

public ElementList<AbstractDataBushElement> getList()

Returns list of instances of DataBush elements created by read() method. Returns list of elements created by DefaultDBReader. Elements are stored in ElementList list. List is created and filled after call to read() method.

Specified by:

getList in interface IDataBushReader

Returns:

ElementList list of read elements

open

public void open(File file)
          throws DataBushException

open method comment. Openes input file.

Specified by:

open in interface IDataBushReader

Overrides:

open in class AbstractParameterReader

Parameters:

file - a File object

Throws:

DataBushException - if any.

open

public void open(URL url)
          throws DataBushException

open method comment. Openes input URL.

Specified by:

open in interface IDataBushReader

Overrides:

open in class AbstractParameterReader

Parameters:

url - a URL object

Throws:

DataBushException - if any.

read

public ElementList<AbstractDataBushElement> read()
                                          throws DataBushException

Reads input and creates DataBush elements. Input must be opened with one of ParameterReader.openInStream methods. Created elements are stored and returned in ElementList. Reads input and creates DataBush elements. Input must be opened with one of ParameterReader.openInStream methods. Created instances of DataBush elements are stored and returned in ElementList. Call read only once per new opened stream.

Specified by:

read in interface IDataBushReader

Returns:

ElementList list of created elements

Throws:

DataBushException - if any.

read

public ElementList<AbstractDataBushElement> read(ElementList<AbstractDataBushElement> l)
                                          throws DataBushException

Reads input and creates DataBush elements. Input must be opened with one of ParameterReader.openInStream methods. Created elements are stored and returned in ElementList. Reads input and creates DataBush elements. Input must be opened with one of ParameterReader.openInStream methods. Created instances of DataBush elements are stored and returned in ElementList. Call read only once per new opened stream.

Specified by:

read in interface IDataBushReader

Parameters:

l - a ElementList object

Returns:

ElementList list of created elements

Throws:

DataBushException - if any.