fr.cnes.sitools.units.dimension.helper
Class DimensionHelper

java.lang.Object
  org.restlet.engine.Helper
      fr.cnes.sitools.units.dimension.helper.DimensionHelper

Direct Known Subclasses:

SitoolsUnitConverterHelper

public class DimensionHelper
extends org.restlet.engine.Helper

Dimension helper to register all known converters

Author:

m.marseille (AKKA technologies)

Constructor Summary

DimensionHelper()
Constructor holding class name

Method Summary

SitoolsUnitConverter	getConverter(javax.measure.unit.Unit<?> u, javax.measure.unit.Unit<?> v) Get the converter for the given Unit to another unit.
java.util.List<java.lang.String>	getConverters() Gets the converters value
java.lang.String	getHelperName() Gets the helperName value
java.util.List<SitoolsUnitConverter>	getRegisteredConverters() Get the list of registered converters
java.util.List<javax.measure.unit.SystemOfUnits>	getRegisteredSystems() Gets the sys value
java.util.List<java.lang.String>	getSystems() Gets the systems value
void	registerSystem(javax.measure.unit.SystemOfUnits s) register a measure system to the dimension helper
void	registerUnitConverter(SitoolsUnitConverter conv) register a converter to the dimension helper
void	setConverters(java.util.List<java.lang.String> converters) Sets the value of converters
void	setHelperName(java.lang.String helperName) Sets the value of helperName
void	setSystems(java.util.List<java.lang.String> systems) Sets the value of systems

Methods inherited from class java.lang.Object

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

Constructor Detail

DimensionHelper

public DimensionHelper()

Constructor holding class name

Method Detail

getRegisteredConverters

public final java.util.List<SitoolsUnitConverter> getRegisteredConverters()

Get the list of registered converters

Returns:

the list

registerUnitConverter

public final void registerUnitConverter(SitoolsUnitConverter conv)

register a converter to the dimension helper

Parameters:

conv - the converter to register

registerSystem

public final void registerSystem(javax.measure.unit.SystemOfUnits s)

register a measure system to the dimension helper

Parameters:

s - the system to register

getConverter

public final SitoolsUnitConverter getConverter(javax.measure.unit.Unit<?> u,
                                               javax.measure.unit.Unit<?> v)

Get the converter for the given Unit to another unit.

Parameters:

u - the base unit

v - the target unit

Returns:

the converter registered

getConverters

public final java.util.List<java.lang.String> getConverters()

Gets the converters value

Returns:

the converters

setHelperName

public final void setHelperName(java.lang.String helperName)

Sets the value of helperName

Parameters:

helperName - the helperName to set

getHelperName

public final java.lang.String getHelperName()

Gets the helperName value

Returns:

the helperName

getSystems

public final java.util.List<java.lang.String> getSystems()

Gets the systems value

Returns:

the systems

getRegisteredSystems

public java.util.List<javax.measure.unit.SystemOfUnits> getRegisteredSystems()

Gets the sys value

Returns:

the sys

setConverters

public void setConverters(java.util.List<java.lang.String> converters)

Sets the value of converters

Parameters:

converters - the converters to set

setSystems

public void setSystems(java.util.List<java.lang.String> systems)

Sets the value of systems

Parameters:

systems - the systems to set