Cegid XRP Ultimate  |  
I3   Actualisé le 06/10/2022
XLinks - ETL
Thème "Mathématiques et nombres"

Méthode "divide(Object, Object)"
Méthode "divide(Object, Object, int)"
Méthode "isInteger(Object)"
Méthode "isNumber(Object)"
Méthode "multiply(Object, Object, Object...)"
Méthode "round(Object, int)"
Méthode "subtract(Object, Object, Object...)"

   Ensemble des méthodes et macros disponibles dans le thème "Nombres".

Méthode "divide(Object, Object)"

Signature
BigDecimal divide(Object dividend, Object divisor)

Description
Divise un nombre par un autre. La précision du résultat est à 20 décimales.

Exemple :
BigDecimal result = xtNumber.divide(2, 3);
report("Return value for the divide method (2/3) : [$1]", result); // Return value for the divide method (2/3) : [0.66666666666666666667]
try {
   result = xtNumber.divide(2, 0);    // ERROR ==> BigInteger divide by zero
} catch(ArithmeticException e) {
   report("ArithmeticException - Can't divide by 0");    // Display this message
}

Paramètres
Object value - Valeur à diviser.
Object divisor - Diviseur.

Résultats
BigDecimal - Résultat de la division, avec une précision à 20 décimales.

Exceptions
ArithmeticException - Si le diviseur est 0.

Depuis
1.0

Méthode "divide(Object, Object, int)"

Signature
BigDecimal divide(Object dividend, Object divisor, int scale)

Description
Divise un nombre par un autre. Il est possible de spécifier la précision du résultat souhaité.
Exemple :
BigDecimal result = xtNumber.divide(2, 3, 5);
report("Return value for the divide method (2/3) : [$1]", result); // Return value for the divide method (2/3) : [0.66667]
try {
   result = xtNumber.divide(2, 0, 5);    // ERROR ==> BigInteger divide by zero
} catch(ArithmeticException e) {
   report("ArithmeticException - Can't divide by 0");    // Display this message
}

Paramètres
Object value - Valeur à diviser.
Object divisor - Diviseur.
int scale - Précision du résultat. La précision minimale est 0 (si on spécifie une valeur négative, la précision est forcée à 0).

Résultats
BigDecimal - Résultat de la division, avec la précision demandée.

Exceptions
ArithmeticException - Si le diviseur est 0.

Depuis
1.0

Méthode "isInteger(Object)"

Signature
boolean isInteger(Object value)

Description
Teste si un objet est un entier. Dans le cas où on souhaite tester une chaîne de caractères, celle-ci doit respecter le format suivant :
   - Aucun caractère espace.
   - Aucun séparateur de milliers.
   - Le séparateur de décimales doit être le caractère point.
   - Le caractère "e", en majuscule ou minuscule, peut être utilisé pour signifier un exposant (facultatif).

Exemple :
report("1 is an integer ? [$1]", xtNumber.isInteger(1));    // True
report("1.0 is an integer ? [$1]", xtNumber.isInteger(1.0));    // True
report("1.5 is an integer ? [$1]", xtNumber.isInteger(1.5));    // False
report("1.0 is an integer ? [$1]", xtNumber.isInteger("1.0"));    // True
report("1,0 is an integer ? [$1]", xtNumber.isInteger("1,0"));    // False
report(" 1.0 is an integer ? [$1]", xtNumber.isInteger(" 1.0"));    // False, value with space
report("1000.0 is an integer ? [$1]", xtNumber.isInteger("1000.0"));    // True
report("1,000.0 is an integer ? [$1]", xtNumber.isInteger("1,000.0"));    //False

Paramètres
Object value - Objet à tester.

Résultats
boolean - Vrai (true), si l'objet est un entier.

Depuis
1.0

Méthode "isNumber(Object)"

Signature
boolean isNumber(Object value)

Description
Teste si un objet est un nombre. Dans le cas où on souhaite tester une chaîne de caractères, celle-ci doit respecter le format suivant :
   - Aucun caractère espace.
   - Aucun séparateur de milliers.
   - Le séparateur de décimales doit être le caractère point.
   - Le caractère "e", en majuscule ou minuscule, peut être utilisé pour signifier un exposant (facultatif).

Exemple :
report("1 is an integer ? [$1]", xtNumber.isNumber(1));    // True
report("1.0 is an integer ? [$1]", xtNumber.isNumber(1.0));    // True
report("1.5 is an integer ? [$1]", xtNumber.isNumber(1.5));    // True
report("1.5 is a number ? [$1]", xtNumber.isNumber("1.5"));    // True
report(" 1.5 is a number ? [$1]", xtNumber.isNumber(" 1.5"));    // False, value with space
report("1,5 is a number ? [$1]", xtNumber.isNumber("1,5"));    //False
report("1000 is a number ? [$1]", xtNumber.isNumber("1000"));    // True
report("1,000 is a number ? [$1]", xtNumber.isNumber("1,000"));    // False

Paramètres
Object value - Objet à tester.

Résultats
boolean - Vrai (true), si l'objet est un nombre.

Depuis
1.0

Méthode "multiply(Object, Object, Object...)"

Signature
BigDecimal multiply(Object value, Object multiplicand, Object... otherMultiplicand)

Description
Retourne un BigDecimal dont la valeur est le résultat de la multiplication (value * multiplicand). Il est possible de spécifier un nombre indéterminé d'autres multiplicateurs (optionnel).

Exemple
BigDecimal multiplyResult = xtNumber.multiply(2, 3);
report("Return value for the multiply method (2*3) : [$1]", multiplyResult); // Return value for the multiply method (2*3) : [6]
multiplyResult = xtNumber.multiply(2, 3, 4, 5, 6);
report("Return value for the multiply method (2*3*4*5*6) : [$1]", multiplyResult);    // Return value for the multiply method (2*3*4*5*6) : [720]

Paramètres
Object value - Valeur de départ.
Object multiplicand - Multiplicateur.
Object... otherMultiplicand - Autres multiplicateurs (optionnel).

Résultats
BigDecimal - Valeur calculée.

Depuis
1.0

Méthode "round(Object, int)"

Signature
BigDecimal multiply(Object value, int scale)

Description
Retourne un BigDecimal dont la valeur est l'arrondi de la valeur spécifiée en paramètre. Le nombre de décimales à conserver est spécifié dans le paramètre scale.

Exemple :
report("Rounded value (2/3) : [$1]", xtNumber.round(xtNumber.divide(2, 3), 2));    // Rounded value (2/3) : [0.67]

Paramètres
Object value - Valeur à arrondir.
int scale - Nombre de décimales à conserver.

Résultats
BigDecimal - Valeur arrondie.

Depuis
1.0

Méthode "subtract(Object, Object, Object...)"

Signature
BigDecimal subtract(Object value, Object subtrahend, Object... otherSubtrahend)

Description
Retourne un BigDecimal dont la valeur est le résultat de la soustraction (value - subtrahend). Il est possible de spécifier un nombre indéterminé d'autres diminuteurs (optionnel).

Exemple :
BigDecimal substractResult = xtNumber.subtract(10, 1);
report("Return value for the subtract method (10-1) : [$1]", substractResult); // Return value for the subtract method (10-1) : [9]
substractResult = xtNumber.subtract(10, 1, 2, 3, 4, 5);
report("Return value for the subtract method (10-1-2-3-4-5) : [$1]", substractResult);    // Return value for the subtract method (10-1-2-3-4-5) : [-5]

Paramètres
Object value - Valeur de départ.
Object subtrahend - diminuteur .
Object... otherSubtrahend - Autres diminuteurs (optionnel).

Résultats
BigDecimal - Valeur calculée.

Depuis
1.0