Package gda.util.converters

Class AutoRenameableConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

java.lang.Object

gda.factory.FindableBase

gda.util.converters.AutoRenameableConverter<S,T>

All Implemented Interfaces:

Findable, IConverter<javax.measure.Quantity<S>,javax.measure.Quantity<T>>, IQuantitiesConverter<S,T>, IQuantityConverter<S,T>, IReloadableQuantitiesConverter<S,T>

public class AutoRenameableConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>
extends FindableBase
implements IReloadableQuantitiesConverter<S,T>

AutoRenameableConverter Class

Constructor Summary

Constructors

Constructor	Description
AutoRenameableConverter(String name, ConverterNameProvider provider)
AutoRenameableConverter(String name, ConverterNameProvider provider, boolean autoConversion)

Method Summary

Modifier and Type	Method	Description
javax.measure.Quantity<T>[]	calculateMoveables(javax.measure.Quantity<S>[] sources, Object[] moveables)	Calculates an array of values in units of the source given an array of quantities in units of the source
void	disableAutoConversion()
void	enableAutoConversion()
List<List<String>>	getAcceptableMoveableUnits()	Returns the units in which the targets quantities passed into ToSource can be expressed
List<String>	getAcceptableSourceUnits()
List<String>	getAcceptableTargetUnits()
List<List<String>>	getAcceptableUnits()	Returns the units in which the sources quantities passed into calculateMoveables can be expressed
String	getConverterName()
boolean	handlesStoT()
boolean	handlesTtoS()
boolean	isAutoConversion()
void	reloadConverter()	Reload its state from any resource on which it may depend e.g.
void	setAutoConversion(boolean autoConversion)
void	setConverterName(String converterName)
void	setName(String name)	Set or change the name of the object (as defined in XML).
boolean	sourceMinIsTargetMax()	Returns true is the conversion reverses the sense.
javax.measure.Quantity<S>	toSource(javax.measure.Quantity<T> target)	Calculates a value for Source given the value of the target
javax.measure.Quantity<S>[]	toSource(javax.measure.Quantity<T>[] targets, Object[] moveables)	Calculates an array of values in units of the source given an array of quantities in units of the moveables
String	toString()
javax.measure.Quantity<T>	toTarget(javax.measure.Quantity<S> source)	Calculates a value for Target given the value of the source

Methods inherited from class gda.factory.FindableBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface gda.factory.Findable

getName

Constructor Details

AutoRenameableConverter

public AutoRenameableConverter(String name,
 ConverterNameProvider provider,
 boolean autoConversion)

AutoRenameableConverter

public AutoRenameableConverter(String name,
 ConverterNameProvider provider)

Method Details

reloadConverter

public void reloadConverter()

Description copied from interface: IReloadableQuantitiesConverter

Reload its state from any resource on which it may depend e.g. re-read a lookup table.

Specified by:

reloadConverter in interface IReloadableQuantitiesConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

setName

public void setName(String name)

Description copied from interface: Findable

Set or change the name of the object (as defined in XML).

Specified by:

setName in interface Findable

Overrides:

setName in class FindableBase

Parameters:

name - the object name

getConverterName

public String getConverterName()

setConverterName

public void setConverterName(String converterName)

calculateMoveables

public javax.measure.Quantity<T>[] calculateMoveables(javax.measure.Quantity<S>[] sources,
 Object[] moveables)
                                               throws Exception

Description copied from interface: IQuantitiesConverter

Calculates an array of values in units of the source given an array of quantities in units of the source

Specified by:

calculateMoveables in interface IQuantitiesConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Parameters:

sources - Array of values in units of the sources to be converted.

moveables - Array of Moveable

Returns:

Array of calculated values in units of the moveables

Throws:

Exception

toSource

public javax.measure.Quantity<S>[] toSource(javax.measure.Quantity<T>[] targets,
 Object[] moveables)
                                     throws Exception

Description copied from interface: IQuantitiesConverter

Calculates an array of values in units of the source given an array of quantities in units of the moveables

Specified by:

toSource in interface IQuantitiesConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Parameters:

targets - Array of values in units of the moveables to be converted.

moveables - Array of Moveable

Returns:

Array of calculated values in units of the source

Throws:

Exception

getAcceptableUnits

public List<List<String>> getAcceptableUnits()

Description copied from interface: IQuantitiesConverter

Returns the units in which the sources quantities passed into calculateMoveables can be expressed

Specified by:

getAcceptableUnits in interface IQuantitiesConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Returns:

Each element of the array is an array of units that is acceptable for the corresponding source in calls to calculateMoveables

getAcceptableMoveableUnits

public List<List<String>> getAcceptableMoveableUnits()

Description copied from interface: IQuantitiesConverter

Returns the units in which the targets quantities passed into ToSource can be expressed

Specified by:

getAcceptableMoveableUnits in interface IQuantitiesConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Returns:

Each element of the array is an array of units that is acceptable for the corresponding target in calls to ToSource

toString

public String toString()

Overrides:

toString in class Object

getAcceptableSourceUnits

public List<String> getAcceptableSourceUnits()

Specified by:

getAcceptableSourceUnits in interface IQuantityConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Returns:

AcceptableSourceUnits

getAcceptableTargetUnits

public List<String> getAcceptableTargetUnits()

Specified by:

getAcceptableTargetUnits in interface IQuantityConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Returns:

AcceptableTargetUnits

toSource

public javax.measure.Quantity<S> toSource(javax.measure.Quantity<T> target)
                                   throws Exception

Description copied from interface: IConverter

Calculates a value for Source given the value of the target

Specified by:

toSource in interface IConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Parameters:

target -

Returns:

The value calculated from the value of the target *

Throws:

Exception

toTarget

public javax.measure.Quantity<T> toTarget(javax.measure.Quantity<S> source)
                                   throws Exception

Description copied from interface: IConverter

Calculates a value for Target given the value of the source

Specified by:

toTarget in interface IConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Parameters:

source -

Returns:

The value calculated from the value of the source

Throws:

Exception

sourceMinIsTargetMax

public boolean sourceMinIsTargetMax()

Description copied from interface: IConverter

Returns true is the conversion reverses the sense. So that to get the max of the source you convert the min of the target and vice versa

Specified by:

sourceMinIsTargetMax in interface IConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Returns:

true is the conversion reverses the sense.

enableAutoConversion

public void enableAutoConversion()

disableAutoConversion

public void disableAutoConversion()

isAutoConversion

public boolean isAutoConversion()

setAutoConversion

public void setAutoConversion(boolean autoConversion)

handlesStoT

public boolean handlesStoT()

Specified by:

handlesStoT in interface IQuantityConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Returns:

true if the converter converts from S to T

handlesTtoS

public boolean handlesTtoS()

Specified by:

handlesTtoS in interface IQuantityConverter<S extends javax.measure.Quantity<S>,T extends javax.measure.Quantity<T>>

Returns:

true if the converter converts from T to S