Package cern.accsoft.steering.aloha.plugin.disp.read.yasp

Class YaspDispersionMeasurementReader

java.lang.Object

cern.accsoft.steering.aloha.read.yasp.AbstractYaspMeasurementReader<DispersionMeasurement>

cern.accsoft.steering.aloha.plugin.disp.read.yasp.YaspDispersionMeasurementReader

All Implemented Interfaces:

AlohaBeanFactoryAware, BeanAware, MachineElementsManagerAware, DispersionMeasurementReader, MeasurementReader<DispersionMeasurement>, Reader

public class YaspDispersionMeasurementReader
extends AbstractYaspMeasurementReader<DispersionMeasurement>
implements DispersionMeasurementReader, AlohaBeanFactoryAware, MachineElementsManagerAware

this is the implementation of a reader for dispersion data out of yasp files

Constructor Summary

Constructors

Constructor	Description
YaspDispersionMeasurementReader()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()
javax.swing.filechooser.FileFilter	getFileFilter()
static boolean	isDispersionFile(java.lang.String fileName)	determines, a file of the given name is a yasp dispersion-file.
boolean	isHandling(java.util.List<java.io.File> files)
DispersionMeasurement	read(java.util.List<java.io.File> files, ModelDelegate modelDelegate, MeasurementReaderOptions options)	reads the file and returns a measurement that uses the model defined by the given model-delegate
boolean	requiresOptions()	has to tell, if this measurement reader requires options.
void	setAlohaBeanFactory(AlohaBeanFactory alohaBeanFactory)	this method is used by the AlohaBeanFactory to inject itself.
void	setMachineElementsManager(MachineElementsManager machineElementsManager)	by the use of this method the MachineElementsManager is injected if the class is configured by the AlohaBeanFactory
java.lang.String	toString()

Methods inherited from class cern.accsoft.steering.aloha.read.yasp.AbstractYaspMeasurementReader

proposedModelDefinitionUri

Methods inherited from class java.lang.Object

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

Methods inherited from interface cern.accsoft.steering.aloha.read.MeasurementReader

proposedModelDefinitionUri

Constructor Detail

YaspDispersionMeasurementReader

public YaspDispersionMeasurementReader()

Method Detail

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Reader

Returns:

a description of the files to handle

getFileFilter

public javax.swing.filechooser.FileFilter getFileFilter()

Specified by:

getFileFilter in interface Reader

Returns:

the file filter which can be used for a file-open dialog.

isHandling

public boolean isHandling(java.util.List<java.io.File> files)

Specified by:

isHandling in interface Reader

Parameters:

files - the files to test

Returns:

true if this Reader can handle all the given files, false if not

isDispersionFile

public static final boolean isDispersionFile(java.lang.String fileName)

determines, a file of the given name is a yasp dispersion-file.

Parameters:

fileName - the filename to check

Returns:

true, if it is a dispersion-file, false if not.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setMachineElementsManager

public void setMachineElementsManager(MachineElementsManager machineElementsManager)

Description copied from interface: MachineElementsManagerAware

by the use of this method the MachineElementsManager is injected if the class is configured by the AlohaBeanFactory

Specified by:

setMachineElementsManager in interface MachineElementsManagerAware

setAlohaBeanFactory

public void setAlohaBeanFactory(AlohaBeanFactory alohaBeanFactory)

Description copied from interface: AlohaBeanFactoryAware

this method is used by the AlohaBeanFactory to inject itself.

Specified by:

setAlohaBeanFactory in interface AlohaBeanFactoryAware

read

public DispersionMeasurement read(java.util.List<java.io.File> files,
                                  ModelDelegate modelDelegate,
                                  MeasurementReaderOptions options)
                           throws ReaderException

Description copied from interface: MeasurementReader

reads the file and returns a measurement that uses the model defined by the given model-delegate

Specified by:

read in interface MeasurementReader<DispersionMeasurement>

Parameters:

files - the file to read

modelDelegate - the model-delegate to use for the measurement.

options - the options for reading the files

Returns:

the measurement

Throws:

ReaderException

requiresOptions

public boolean requiresOptions()

Description copied from interface: MeasurementReader

has to tell, if this measurement reader requires options. This is useful to decide in the gui, if the user has to be asked for them or not.

Specified by:

requiresOptions in interface MeasurementReader<DispersionMeasurement>

Returns:

true if options are required, false if not