org.geotools.units
Class Unit

java.lang.Object
  org.geotools.units.Unit

All Implemented Interfaces:

java.io.Serializable

Deprecated. Replaced by the Unit framework.

public abstract class Unit

extends java.lang.Object

implements java.io.Serializable

Placeholder for future Unit class. This skeleton will be removed when the real classes (from JSR-108: Units specification) will be publicly available.

IMPORTANT: future version will NOT be compatible will this one. Remind, this is a temporary class!

Version:

$Id: Unit.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Steven R. Emmerson, Bill Hibbard, Martin Desruisseaux

See Also:

Serialized Form

Field Summary

static Unit	ARC_SECOND Deprecated. Replaced by NonSI.SECOND_ANGLE.
static Unit	DAY Deprecated. Replaced by NonSI.DAY.
static Unit	DEGREE Deprecated. Replaced by NonSI.DEGREE_ANGLE.
static Unit	DIMENSIONLESS Deprecated. Convenience constant for dimensionless unit.
static Unit	DMS Deprecated. Convenience constant for "Degrees Minutes Secondes" unit.
static Unit	KILOGRAM Deprecated. Replaced by SI.KILOGRAM.
static Unit	KILOMETRE Deprecated. Replaced by SI.KILO(SI.METER).
static Unit	METRE Deprecated. Replaced by SI.METER.
static Unit	MILLISECOND Deprecated. Replaced by SI.MILLI(SI.SECOND).
static Unit	RADIAN Deprecated. Replaced by SI.RADIAN.
static Unit	SECOND Deprecated. Replaced by SI.SECOND.
static Unit	SEXAGESIMAL_DEGREE Deprecated. Convenience constant for "Degrees dot Minutes Secondes" unit.

Method Summary

abstract boolean	canConvert(Unit that) Deprecated. Indique si les unit?s this et that sont compatibles.
abstract void	convert(double[] values, Unit fromUnit) Deprecated. Effectue sur-place la conversion de mesures exprim?es selon d'autres unit?s.
abstract double	convert(double value, Unit fromUnit) Deprecated. Effectue la conversion d'une mesure exprim?e selon d'autres unit?s.
abstract void	convert(float[] values, Unit fromUnit) Deprecated. Effectue sur-place la conversion de mesures exprim?es selon d'autres unit?s.
Unit	divide(Unit that) Deprecated. Divise cette unit? par une autre unit?.
boolean	equals(java.lang.Object unit) Deprecated. Indique si deux unit?s sont ?gales et utilisent le m?me symbole.
static Unit	get(java.lang.String symbol) Deprecated. Retourne les unit?s qui correspondent au symbole sp?cifi?.
java.lang.String	getLocalizedName() Deprecated. Retourne le nom de l'unit? dans la langue de l'utilisateur.
java.lang.String	getLocalizedQuantityName() Deprecated. Retourne la quantit? que repr?sente cette unit? dans la langue de l'utilisateur.
abstract java.lang.String	getQuantityName() Deprecated. Retourne la quantit? que repr?sente cette unit?.
abstract UnitTransform	getTransform(Unit fromUnit) Deprecated. Retourne un objet qui saura convertir selon ces unit?s les valeurs exprim?es selon d'autres unit?s.
abstract int	hashCode() Deprecated. Retourne un code propre ? cette unit?.
Unit	multiply(Unit that) Deprecated. Multiplie cette unit? par une autre unit?.
Unit	pow(double power) Deprecated. ?l?ve ces unit?s ? une puissance fractionnaire.
Unit	pow(int power) Deprecated. ?l?ve ces unit?s ? une puissance enti?re.
abstract Unit	rename(java.lang.String symbol, org.geotools.units.PrefixSet prefix) Deprecated. Renvoie une unit? identique ? celle-ci, mais avec un nouveau symbole et de nouveaux pr?fix.
abstract Unit	scale(double amount) Deprecated. Cr?e une nouvelle unit? proportionnelle ? cette unit?.
abstract Unit	shift(double offset) Deprecated. Cr?e une nouvelle unit? d?cal?e par rapport ? cette unit?.
javax.units.Unit	toJSR108() Deprecated. Returns this unit as a javax.units object.
java.lang.String	toString() Deprecated. Retourne les symboles de ces unit?s, par exemple "m/s".

Methods inherited from class java.lang.Object

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

Field Detail

DIMENSIONLESS

public static final Unit DIMENSIONLESS

Deprecated.

Convenience constant for dimensionless unit.

RADIAN

public static final Unit RADIAN

Deprecated. Replaced by SI.RADIAN.

Convenience constant for base unit of angle. Not a SI unit, but provides here for convenience.

DEGREE

public static final Unit DEGREE

Deprecated. Replaced by NonSI.DEGREE_ANGLE.

Convenience constant for unit of angle. Not a SI unit, but provides here for convenience.

METRE

public static final Unit METRE

Deprecated. Replaced by SI.METER.

Convenience constant for base unit of length.

KILOMETRE

public static final Unit KILOMETRE

Deprecated. Replaced by SI.KILO(SI.METER).

Convenience constant for derived unit of length.

SECOND

public static final Unit SECOND

Deprecated. Replaced by SI.SECOND.

Convenience constant for base unit of time.

MILLISECOND

public static final Unit MILLISECOND

Deprecated. Replaced by SI.MILLI(SI.SECOND).

Convenience constant for unit of time. Not a SI unit, but provides here for convenience.

DAY

public static final Unit DAY

Deprecated. Replaced by NonSI.DAY.

Convenience constant for unit of time. Not a SI unit, but provides here for convenience.

KILOGRAM

public static final Unit KILOGRAM

Deprecated. Replaced by SI.KILOGRAM.

Convenience constant for base unit of mass.

ARC_SECOND

public static final Unit ARC_SECOND

Deprecated. Replaced by NonSI.SECOND_ANGLE.

Unit of arc-second. Used by the EPSG database.

DMS

public static final Unit DMS

Deprecated.

Convenience constant for "Degrees Minutes Secondes" unit. For example, this "unit" convert 12.5? into 123000 (i.e. the concatenation of 12?30'00"). In a strict sence, this is a formatting issue rather than an unit transformation issue. Such transformation would be better handle by the AngleFormat class. However, this "unit" appears really often in the EPSG database, and we need it for interoperability with legacy libraries.

SEXAGESIMAL_DEGREE

public static final Unit SEXAGESIMAL_DEGREE

Deprecated.

Convenience constant for "Degrees dot Minutes Secondes" unit. For example, this "unit" convert 12.5? into 12.3 (i.e. the concatenation of 12?30'00"). In a strict sence, this is a formatting issue rather than an unit transformation issue. Such transformation would be better handle by the AngleFormat class. However, this "unit" appears really often in the EPSG database, and we need it for interoperability with legacy libraries.

Method Detail

toJSR108

public final javax.units.Unit toJSR108()

Deprecated.

Returns this unit as a javax.units object.

get

public static Unit get(java.lang.String symbol)

Deprecated.

Retourne les unit?s qui correspondent au symbole sp?cifi?. Si plus d'une unit? correspond au symbole sp?cifi?, une unit? arbitraire sera choisie. Si aucune unit? n'a ?t? trouv?e, alors cette m?thode retourne null.

Parameters:

symbol - Symbole des unit?s recherch?es. Cet argument ne doit pas ?tre nul.

Returns:

Les unit?s demand?es.

rename

public abstract Unit rename(java.lang.String symbol,
                            org.geotools.units.PrefixSet prefix)

Deprecated.

Renvoie une unit? identique ? celle-ci, mais avec un nouveau symbole et de nouveaux pr?fix.

Parameters:

symbol - Nouveau symbole repr?sentant cette unit?. Si ce param?tre est nul, un symbole par d?faut sera cr??.

prefix - Liste des pr?fix autoris?s pour le symbole.

Returns:

La m?me unit?, mais avec le nouveau symbole. Peut ?tre this, mais ne sera jamais null.

getLocalizedName

public java.lang.String getLocalizedName()

Deprecated.

Retourne le nom de l'unit? dans la langue de l'utilisateur. Par exemple le symbole "m" sera traduit par "m?tre" dans la langue fran?aise. Si aucun nom n'est disponible pour l'unit? courante, retourne simplement son symbole.

getQuantityName

public abstract java.lang.String getQuantityName()

Deprecated.

Retourne la quantit? que repr?sente cette unit?. Les quantit?s sont des cha?nes de caract?res qui d?crivent le param?tre physique mesur?, comme "mass" ou "speed". Si aucune quantit? n'est d?finie pour cette unit?, retourne null.

getLocalizedQuantityName

public java.lang.String getLocalizedQuantityName()

Deprecated.

Retourne la quantit? que repr?sente cette unit? dans la langue de l'utilisateur. Les quantit?s sont des cha?nes de caract?res qui d?crivent le param?tre physique mesur?, comme "masse" ou "vitesse". Si aucune quantit? n'est d?finie pour cette unit?, retourne null.

pow

public Unit pow(int power)
         throws UnitException

Deprecated.

?l?ve ces unit?s ? une puissance enti?re. Notez que ce ne sont pas toutes les unit?s qui peuvent ?tre ?lev?es ? une puissance. Par exemple les unit?s de temp?rature en degr?s Celcius (?C), en Fahrenheit (?F) et la densit? sigma-T ne peuvent pas ?tre ?lev?es ? une puissance autre que 0 et 1. L'impl?mentation par d?faut retourne une unit? sans dimension ou this selon que power ait la valeur 0 ou 1 respectivement, et lance une exception dans tous les autres cas.

Parameters:

power - La puissance ? laquelle ?lever cette unit?.

Returns:

Les unit?s r?sultant de l'?l?vation des unit?s this ? la puissance power.

Throws:

UnitException - Si ces unit?s ne peuvent ?tre ?lev?es ? une puissance autre que 0 et 1.

See Also:

multiply(org.geotools.units.Unit), divide(org.geotools.units.Unit), scale(double), shift(double)

pow

public Unit pow(double power)
         throws UnitException

Deprecated.

?l?ve ces unit?s ? une puissance fractionnaire. Cette m?thode est utile entre autre pour prendre la racine carr?e d'un nombre, ce qui revient ? l'?lever ? la puissance ?. L'impl?mentation par d?faut appele la m?thode pow(int) pour les puissances enti?res, et lance une exception dans tous les autres cas.

Parameters:

power - La puissance ? laquelle ?lever cette unit?.

Returns:

Les unit?s r?sultant de l'?l?vation des unit?s this ? la puissance power.

Throws:

UnitException - Si ces unit?s ne peuvent ?tre ?lev?es ? une puissance autre que 0 et 1.

multiply

public Unit multiply(Unit that)
              throws UnitException

Deprecated.

Multiplie cette unit? par une autre unit?. L'impl?mentation par d?faut retourne this si that est ?gal ? une unit? sans dimension, et lance une exception dams tous les autres cas.

Parameters:

that - L'unit? par laquelle multiplier cette unit?.

Returns:

Le produit de this par that.

Throws:

UnitException - Si les unit?s this that ne peuvent pas ?tre multipli?es.

See Also:

pow(int), divide(org.geotools.units.Unit), scale(double), shift(double)

divide

public Unit divide(Unit that)
            throws UnitException

Deprecated.

Divise cette unit? par une autre unit?. L'impl?mentation par d?faut retourne this si that est ?gal ? une unit? sans dimension, et lance une exception dams tous les autres cas.

Parameters:

that - L'unit? par laquelle diviser cette unit?.

Returns:

Le quotient de this par that.

Throws:

UnitException - Si les unit?s this that ne peuvent pas ?tre divis?es.

See Also:

pow(int), multiply(org.geotools.units.Unit), scale(double), shift(double)

scale

public abstract Unit scale(double amount)

Deprecated.

Cr?e une nouvelle unit? proportionnelle ? cette unit?. Par exemple pour convertir en kilom?tres des mesures exprim?es en m?tres, il faut les diviser par 1000. On peut exprimer cette relation par le code Unit KILOMETRE=METRE.scale(1000).

Parameters:

amount - Facteur par lequel il faudra diviser les valeurs exprim?es selon ces unit?s pour obtenir des valeurs exprim?es selon les nouvelles unit?s.

Returns:

Les nouvelles unit?s.

See Also:

pow(int), multiply(org.geotools.units.Unit), divide(org.geotools.units.Unit), shift(double)

shift

public abstract Unit shift(double offset)

Deprecated.

Cr?e une nouvelle unit? d?cal?e par rapport ? cette unit?. Par exemple pour convertir des degr?s Kelvin en degr?s Celsius, il faut soustraire 273.15 aux degr?s Kelvin. On peut exprimer cette relation par le code Unit CELCIUS=KELVIN.shift(273.15).

Parameters:

offset - Constante ? soustraire aux valeurs exprim?es selon ces unit?s pour obtenir des valeurs exprim?es selon les nouvelles unit?s.

Returns:

Les nouvelles unit?s.

See Also:

pow(int), multiply(org.geotools.units.Unit), divide(org.geotools.units.Unit), scale(double)

canConvert

public abstract boolean canConvert(Unit that)

Deprecated.

Indique si les unit?s this et that sont compatibles. Si elles le sont, alors les m?thodes convert ne lanceront jamais d'exception pour ces unit?s. Toutes les classes du paquet org.geotools.units garantissent que this.canConvert(that) donnera toujours le m?me r?sultat que that.canConvert(this). Si vous ?crivez vos propres classes d?riv?es de Unit, vous devrez vous assurer que cette condition reste respect?e. Mais ?vitez d'appeller that.canConvert(this) ? l'int?rieur de cette m?thode sous peine de tomber dans une boucle sans fin.

Parameters:

that - Autre unit?s avec laquelle on veut v?rifier si ces unit?s sont compatibles.

Returns:

true Si l'on garantie que les m?thodes convert ne lanceront pas d'exceptions.

convert

public abstract double convert(double value,
                               Unit fromUnit)
                        throws UnitException

Deprecated.

Effectue la conversion d'une mesure exprim?e selon d'autres unit?s. Par exemple METRE.convert(1, FOOT) retournera 0.3048.

Parameters:

value - La valeur exprim?e selon les autres unit?s (fromUnit).

fromUnit - Les autres unit?s.

Returns:

La valeur convertie selon ces unit?s (this).

Throws:

UnitException - Si les unit?s ne sont pas compatibles.

convert

public abstract void convert(double[] values,
                             Unit fromUnit)
                      throws UnitException

Deprecated.

Effectue sur-place la conversion de mesures exprim?es selon d'autres unit?s. Les valeurs converties remplaceront les anciennes valeurs.

Parameters:

values - En entr?, les valeurs exprim?es selon les autres unit?s (fromUnit). En sortie, les valeurs exprim?es selon ces unit?s (this).

fromUnit - Les autres unit?s.

Throws:

UnitException - Si les unit?s ne sont pas compatibles. Dans ce cas, aucun ?l?ment de values n'aura ?t? modifi?.

convert

public abstract void convert(float[] values,
                             Unit fromUnit)
                      throws UnitException

Deprecated.

Effectue sur-place la conversion de mesures exprim?es selon d'autres unit?s. Les valeurs converties remplaceront les anciennes valeurs.

Parameters:

values - En entr?, les valeurs exprim?es selon les autres unit?s (fromUnit). En sortie, les valeurs exprim?es selon ces unit?s (this).

fromUnit - Les autres unit?s.

Throws:

UnitException - Si les unit?s ne sont pas compatibles. Dans ce cas, aucun ?l?ment de values n'aura ?t? modifi?.

getTransform

public abstract UnitTransform getTransform(Unit fromUnit)
                                    throws UnitException

Deprecated.

Retourne un objet qui saura convertir selon ces unit?s les valeurs exprim?es selon d'autres unit?s. Cette m?thode est avantageuse si on pr?voie fa?re plusieurs conversions, car la transformation ? utiliser est d?termin?e une fois pour toute.

Parameters:

fromUnit - Unit?s ? partir de lesquel faire les conversions.

Returns:

Une transformation des unit?s fromUnit vers les unit?s this. Cette m?thode ne retourne jamais null.

Throws:

UnitException - Si les unit?s ne sont pas compatibles.

equals

public boolean equals(java.lang.Object unit)

Deprecated.

Indique si deux unit?s sont ?gales et utilisent le m?me symbole.

hashCode

public abstract int hashCode()

Deprecated.

Retourne un code propre ? cette unit?. Le calcul de ce code ne devrait pas prendre en compte le symbole de l'unit?.

toString

public java.lang.String toString()

Deprecated.

Retourne les symboles de ces unit?s, par exemple "m/s". S'il existe un symbole particulier pour la langue de l'utilisateur, ce symbole sera retourn?.