fr.cnes.sitools.units.dimension.model
Class SitoolsDimension

java.lang.Object
  fr.cnes.sitools.units.dimension.model.SitoolsDimension

All Implemented Interfaces:

IResource, java.io.Serializable

public final class SitoolsDimension
extends java.lang.Object
implements IResource, java.io.Serializable

Class describing a dimension

Author:

m.marseille (AKKA technologies)

See Also:

Serialized Form

Constructor Summary

SitoolsDimension()
Constructor

Method Summary

java.lang.String	getDescription() Resource description
java.lang.String	getDimensionHelperName() Gets the dimensionHelperName value
java.lang.String	getId() Resource identifier
java.lang.String	getName() Resource name
java.lang.String	getParent() Gets the parent value
java.util.Map<java.lang.String,javax.measure.unit.Unit<?>>	getUnconsistency() Indicates if the dimension is consistent or not
javax.measure.unit.UnitConverter	getUnitConverter(java.lang.String u, java.lang.String v) Get the converter from two unit expressions
java.util.List<java.lang.String>	getUnitConverters() Gets the unitConverters value
java.util.List<SitoolsUnit>	getUnits() Gets the sitoolsUnits value
boolean	isConsistent() Gets the isConsistent value
boolean	isDimensionalyConsistent() Method to indicate if a dimension is consistent or not
void	setConsistent(java.lang.Boolean isConsistent) Sets the value of isConsistent
void	setDescription(java.lang.String description) Sets the value of description
void	setDimensionHelperName(java.lang.String dimensionHelperName) Sets the value of dimensionHelperName
void	setId(java.lang.String string) Set the identifier of the dimension
void	setName(java.lang.String name) Sets the value of name
void	setParent(java.lang.String parent) Sets the value of parent
void	setUnitConverters(java.util.List<java.lang.String> unitConverters) Sets the value of unitConverters
void	setUnits(java.util.List<SitoolsUnit> sitoolsUnits) Sets the value of sitoolsUnits

Methods inherited from class java.lang.Object

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

Constructor Detail

SitoolsDimension

public SitoolsDimension()

Constructor

Method Detail

setConsistent

public void setConsistent(java.lang.Boolean isConsistent)

Sets the value of isConsistent

Parameters:

isConsistent - the isConsistent to set

getUnitConverters

public java.util.List<java.lang.String> getUnitConverters()

Gets the unitConverters value

Returns:

the unitConverters

setUnitConverters

public void setUnitConverters(java.util.List<java.lang.String> unitConverters)

Sets the value of unitConverters

Parameters:

unitConverters - the unitConverters to set

getId

public java.lang.String getId()

Description copied from interface: IResource

Resource identifier

Specified by:

getId in interface IResource

Returns:

String

setName

public void setName(java.lang.String name)

Sets the value of name

Parameters:

name - the name to set

setDescription

public void setDescription(java.lang.String description)

Sets the value of description

Parameters:

description - the description to set

setDimensionHelperName

public void setDimensionHelperName(java.lang.String dimensionHelperName)

Sets the value of dimensionHelperName

Parameters:

dimensionHelperName - the dimensionHelperName to set

getName

public java.lang.String getName()

Description copied from interface: IResource

Resource name

Specified by:

getName in interface IResource

Returns:

String

getDescription

public java.lang.String getDescription()

Description copied from interface: IResource

Resource description

Specified by:

getDescription in interface IResource

Returns:

String

isDimensionalyConsistent

public boolean isDimensionalyConsistent()

Method to indicate if a dimension is consistent or not

Returns:

true if dimension is consistent

getUnconsistency

public java.util.Map<java.lang.String,javax.measure.unit.Unit<?>> getUnconsistency()

Indicates if the dimension is consistent or not

Returns:

true if basic and registered converters are sufficient to be able to convert all units in the dimension

getDimensionHelperName

public java.lang.String getDimensionHelperName()

Gets the dimensionHelperName value

Returns:

the dimensionHelperName

setId

public void setId(java.lang.String string)

Set the identifier of the dimension

Specified by:

setId in interface IResource

Parameters:

string - the identifier to set

setParent

public void setParent(java.lang.String parent)

Sets the value of parent

Parameters:

parent - the parent to set

getParent

public java.lang.String getParent()

Gets the parent value

Returns:

the parent

isConsistent

public boolean isConsistent()

Gets the isConsistent value

Returns:

the isConsistent

getUnitConverter

public javax.measure.unit.UnitConverter getUnitConverter(java.lang.String u,
                                                         java.lang.String v)

Get the converter from two unit expressions

Parameters:

u - the start unit

v - the target unit

Returns:

the associated converter

getUnits

public java.util.List<SitoolsUnit> getUnits()

Gets the sitoolsUnits value

Returns:

the sitoolsUnits

setUnits

public void setUnits(java.util.List<SitoolsUnit> sitoolsUnits)

Sets the value of sitoolsUnits

Parameters:

sitoolsUnits - the sitoolsUnits to set