org.deegree.model.csct.units
Class Prefix

java.lang.Object
  org.deegree.model.csct.units.Prefix

All Implemented Interfaces:

Serializable, Comparable

final class Prefix
extends Object
implements Comparable, Serializable

Repr�sentation d'un pr�fix du syst�me m�trique. Un objet Prefix peut par exemple repr�senter des "centi" (symbole "c") comme dans "centim�tres" (symbole "cm"). La description du paquet javax.units donne une liste des pr�fix standards du syst�me SI.

Note: this class has a natural ordering that is inconsistent with equals. La m�thode compareTo(java.lang.Object) ne compare que le champ amount, tandis que la m�thode equals(java.lang.Object) compare tous les champs (name, symbol et amount).

Version:

1.0

Author:

Martin Desruisseaux

Field Summary

double	amount Quantit� repr�sent� par ce pr�fix.
String	name Nom neutre du pr�fix.
(package private) static WeakHashSet	pool Banque des objets qui ont �t� pr�c�demment cr��s et enregistr�s par un appel � la m�thode intern().
String	symbol Symbole du pr�fix.

Constructor Summary

Prefix(double amount)
Construit un pr�fix temporaire.

Method Summary

int	compareTo(Object object) Compare deux pr�fix.
boolean	equals(Object object) Indique si ce pr�fix est identique � l'objet sp�cifi�.
String	getLocalizedName() Retourne le nom du pr�fix dans la langue de l'utilisateur.
static Prefix	getPrefix(String name, String symbol, double amount) Construit un nouveau pr�fix.
int	hashCode() Retourne un code repr�sentant ce pr�fix.
String	toString() Retourne le symbole du pr�fix.

Methods inherited from class java.lang.Object

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

Field Detail

pool

static final WeakHashSet pool

Banque des objets qui ont �t� pr�c�demment cr��s et enregistr�s par un appel � la m�thode intern().

name

public final String name

Nom neutre du pr�fix. Le syst�me SI d�finit plusieurs noms de pr�fix, parmi lesquels on trouve "milli", "centi" et "kilo". Certaines unit�s (notamment des unit�s du type ) pourront combiner leurs noms avec un nom de pr�fix. Par exemple le pr�fix "centi" (symbole "c") pourra �tre combin� avec les unit�s "m�tres" (symbole "m") pour former les "centim�tres" (symbole "cm"). La cha�ne name peut �tre vide, mais ne sera jamais nulle. Notez enfin que name est "language-neutral". Pour obtenir un nom dans la langue de l'utilisateur, utilisez la m�thode getLocalizedName().

symbol

public final String symbol

Symbole du pr�fix. La plupart des symboles de pr�fix n'ont qu'une seule lettre. Il s'agit la plupart du temps de la premi�re lettre de name, parfois en majuscule. Les majuscules et minuscules sont significatifs et tr�s importants. Par exemple le symbole "m" est pour "milli" tandis que le symbole "M" est pour "mega".

amount

public final double amount

Quantit� repr�sent� par ce pr�fix. Pour les pr�fix SI, cette quantit� est toujours une puissance de 10. Par exemple pour les "kilo" (symbole 'k'), la quantit� amount est 1000. Cette quantit� ne sera jamais NaN ni infinie.

Constructor Detail

Prefix

Prefix(double amount)

Construit un pr�fix temporaire. Ce constructeur ne sert qu'� effectuer des recherches dans une liste de pr�fix par PrefixSet.

Method Detail

getPrefix

public static Prefix getPrefix(String name,
                               String symbol,
                               double amount)

Construit un nouveau pr�fix.

Parameters:

name - Nom du pr�fix (par exemple "centi" comme dans "centim�tres").

symbol - Symbole du pr�fix (par exemple "c" pour "centim�tres").

amount - Quantit� repr�sent� par ce pr�fix (par exemple 0.01 pour "c").

getLocalizedName

public String getLocalizedName()

Retourne le nom du pr�fix dans la langue de l'utilisateur. Par exemple le pr�fix "deci" est �crit "d�ci" en fran�ais.

toString

public String toString()

Retourne le symbole du pr�fix. Cette m�thode retourne syst�matiquement le champ symbol.

Overrides:

toString in class Object

compareTo

public int compareTo(Object object)

Compare deux pr�fix. Cette m�thode compare les quantit�s amount de fa�on � permettre un classement des pr�fix en ordre croissant de quantit�. Contrairement � la m�thode equals(java.lang.Object), compareTo ne compare pas les noms et symboles des pr�fix. Ainsi, deux pr�fix repr�sentant la m�me quantit� mais avec des symboles diff�rents seront consid�r�s �gaux par compareTo.

Specified by:

compareTo in interface Comparable

equals

public boolean equals(Object object)

Indique si ce pr�fix est identique � l'objet sp�cifi�. Cette m�thode retourne true si object est aussi un objet Prefix et si les deux pr�fix ont les m�mes nom et symbole et repr�sentent la m�me quantit� amount.

Overrides:

equals in class Object

hashCode

public int hashCode()

Retourne un code repr�sentant ce pr�fix.

Overrides:

hashCode in class Object