Thème "Textes"

Cegid XRP Ultimate | I3 Actualisé le 06/10/2022

XLinks - ETL

Thème "Textes"

Macro "contains(String, String)"

Méthode "createString(char, int)"

Macro "endsWith(String, String)"

Méthode "isEmpty(String)"

Méthode "isNotEmpty(String)"

Macro "length(String)"

Méthode "lpad(String, int, char)"

Méthode "ltrim(String)"

Méthode "normalizeSpaces(String)"

Méthode "rpad(String, int, char)"

Méthode "rtrim(String)"

Macro "startsWith(String, String)"

Méthode "substringUseLength(String, int, int)"

Macro "substring(String, int, int)"

Méthode "truncateRight(String, int)"

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

Macro "contains(String, String)"

Signature

if ({text}.indexOf({pattern}) > -1) {
// TODO
}

Description

Génère le code permettant de vérifier si un texte contient la chaîne de caractères souhaitée.

Exemple :
String text = "a"
if (text.indexOf("a") > -1) {
   report("Text contains a");
} else {
   report("Text doesn't contain a");
}

if (text.indexOf("b") > -1) {
   report("Text contains b");
} else {
   report("Text doesn't contain b");
}

if (text.indexOf("A") > -1) {
   report("Text contains A");
} else {
   report("Text doesn't contain A");
}

Paramètres

Variable/String text - Variable (de type String) ou chaîne de caractères qu'on souhaite tester.
Variable/String pattern - Variable (de type String) ou chaîne de caractères à rechercher dans la valeur spécifiée dans le paramètre.

Depuis

Méthode "createString(char, int)"

Signature

String createString(char filler, int count)

Description

Crée une chaîne (String) à l'aide de la répétition du caractère (char) spécifié.

Exemple :
String text = xtString.createString('a', 10);
report("Text : [$1]", text); // Texte : [aaaaaaaaaa]

Paramètres

char filler - Caractère à utiliser pour créer le texte. Exemple : 'C'.
int count - Taille du texte à créer. Exemple 10.

Résultats

String - Texte construit par répétition du caractère spécifié.

Depuis

Macro "endsWith(String, String)"

Signature

if ({text}.endsWith({endPattern})) {
// TODO
}

Description

Génère le code permettant de vérifier si un texte se termine par la chaîne de caractères souhaitée.

Exemple :
String text = "abc";
if (text.endsWith("b")) {
   report("Text [$1] ends with \"b\"");
} else {
   report("Text [$1] doesn't end with \"b\"");
}

if (text.endsWith("a")) {
   report("Text [$1] ends with \"a\"");
} else {
   report("Text [$1] doesn't end with \"a\"");
}

Paramètres

Depuis

Méthode "isEmpty(String)"

Signature

boolean isEmpty(String text)

Description

Teste si un texte est vide ou ne contient que des espaces.

Exemple :
if (xtString.isEmpty("")) {
   report("Text \"\" is empty");
} else {
   report("Text \"\" isn't empty");
}

if (xtString.isEmpty(" ")) {
   report("Text \" \" is empty");
} else {
   report("Text \" \" isn't empty");
}

if (xtString.isEmpty("a")) {
   report("Text \"a\" is empty");
} else {
   report("Text \"a\" isn't empty");
}

Paramètres

String text - Texte à tester.

Résultats

boolean - Vrai (True) si le texte est vide ou ne contient que des espaces.

Depuis

Méthode "isNotEmpty(String)"

Signature

boolean isNotEmpty(String text)

Description

Teste si un texte n'est pas vide et contient au moins un caractère autre que le caractère espace.

Exemple :
if (xtString.isNotEmpty("")) {
   report("Text \"\" isn't empty");
} else {
   report("Text \"\" is empty");
}
if (xtString.isNotEmpty(" ")) {
   report("Text \" \" isn't empty");
} else {
   report("Text \" \" is empty");
}
if (xtString.isNotEmpty("a")) {
   report("Text \"a\" isn't empty");
} else {
   report("Text \"a\" is empty");
}

Paramètres

String text - Texte à tester.

Résultats

boolean - Vrai (True) si le texte n'est pas vide et contient au moins un caractère autre que le caractère espace.

Depuis

Macro "length(String)"

Signature

{text}.length()

Description

Génère le code permettant de récupérer la taille d'une chaîne de caractères. La valeur de la méthode "length()", générée par cette macro, peut être stockée dans une variable de type int.

Exemple :
report("String length \"\" : [$1]", "".length());    // String length "" : [0]
report("String length \" \" : [$1]", " ".length());    // String length " " : [1]
report("String length \"abc\" : [$1]", "abc".length());    // String length "abc" : [3]

Paramètres

Variable/String text - Variable (de type String) ou chaîne de caractères dont on souhaite récupérer la longueur.

Depuis

Méthode "lpad(String, int, char)"

Signature

String lpad(String text, int size, char chr)

Description

Ajoute ou supprime des caractères à gauche du texte spécifié pour atteindre la taille demandée.

Exemples :

char character = 'z';

text = "bat";
size = 3;
report("lpad : Original text [$1], size [$2], additional character [$3] ==> result [$4]", text, size, character, xtString.lpad(text, size, character));    // lpad : Original text [bat], size [3], additional character [z] ==> result [bat]

size = 5;
report("lpad : Original text [$1], size [$2], additional character [$3] ==> result [$4]", text, size, character, xtString.lpad(text, size, character));    // lpad : Original text [bat], size [5], additional character [z] ==> result [zzbat]

size = 1;
report("lpad : Original text [$1], size [$2], additional character [$3] ==> result [$4]", text, size, character, xtString.lpad(text, size, character));    // lpad : Original text [bat], size [1], additional character [z] ==> result [b]

size = -1;
try {
   report("lpad : Original text [$1], size [$2], additional character [$3] ==> result [$4]", text, size, character, xtString.lpad(text, size, character));    // Appel de la méthode en erreur car la taille est négative
} catch(XTException e) {
   report("Error when call lpad with negative size");
}

String text = null;
int size = 3;
report("lpad : Original text [$1], size [$2], additional character [$3] ==> result [$4]", text, size, character, xtString.lpad(text, size, character));    // lpad : Original text [null], size [3], additional character [z] ==> result [null]

text = "";
size = 3;
report("lpad : Original text [$1], size [$2], additional character [$3] ==> result [$4]", text, size, character, xtString.lpad(text, size, character));   // lpad : Original text [], size [3], additional character [z] ==> result [zzz]

Paramètres

String text - Texte initial.
int size - Taille finale du texte (supérieur ou égale à 0).
char chr - Caractère pour compléter (si la taille du texte initiale est inférieure à la taille finale).

Résultats

String - Texte formaté.

Exceptions

XTException - Si la taille finale est inférieure à 0.

Depuis

Méthode "ltrim(String)"

Signature

String ltrim(String text)

Description

Supprime les caractères "espaces" en début de texte.

Exemple :
L'appel xtString.ltrim(" Hello ") renvoie la chaîne "Hello ".

Paramètres

String text - Texte initial.

Résultats

String - Texte sans les espaces devant.

Depuis

Méthode "normalizeSpaces(String)"

Signature

String normalizeSpaces(String text)

Description

Supprime les caractères "espaces" autour du texte spécifié, ainsi que les caractères "espaces" consécutifs dans le texte lui-même.

Exemple :
L'appel xtString.normalizeSpaces(" normalize spaces around words ") renvoie la chaîne "normalize spaces around words".

Paramètres

String text - Texte à transformer.

Résultats

String - Texte modifié.

Depuis

Méthode "rpad(String, int, char)"

Signature

String rpad(String text, int size, char chr)

Description

Ajoute ou supprime des caractères à gauche du texte spécifié pour atteindre la taille demandée.

Exemple :

int size = 3;
char character = 'z';
text = "bat";
size = 3;
report("rpad : Original text [$1], size [$2], additional character [$3] ==> result [$4]", text, size, character, xtString.rpad(text, size, character));    // rpad : Original text [bat], size [3], additional character [z] ==> result [bat]

size = 5;
report("rpad : Original text [$1], size [$2], additional character [$3] ==> result [$4]", text, size, character, xtString.rpad(text, size, character));    // rpad : Original text [bat], size [5], additional character [z] ==> result [batzz]

size = 1;
report("rpad : Original text [$1], size [$2], additional character [$3] ==> result [$4]", text, size, character, xtString.rpad(text, size, character));    // rpad : Original text [bat], size [1], additional character [z] ==> result [b]

size = -1;
try {
   report("rpad : Original text [$1], size [$2], additional character [$3] ==> result [$4]", text, size, character, xtString.rpad(text, size, character));   // Appel de la méthode en erreur car la taille est négative
} catch(XTException e) {
   report("Error when call rpad with negative size");
}
String text = null;
size = 3;
report("rpad : Original text [$1], size [$2], additional character [$3] ==> result [$4]", text, size, character, xtString.rpad(text, size, character));    // rpad : Original text [null], size [3], additional character [z] ==> result [null]

String text = "";
size = 3;
report("rpad : Original text [$1], size [$2], additional character [$3] ==> result [$4]", text, size, character, xtString.rpad(text, size, character));    // rpad : Original text [], size [3], additional character [z] ==> result [zzz]

Paramètres

Résultats

String - Texte formaté.

Exceptions

XTException - Si la taille finale est inférieure à 0.

Depuis

Méthode "rtrim(String)"

Signature

String rtrim(String text)

Description

Supprime les caractères "espace" à la fin d'un texte.

Exemple :
L'appel xtString.rtrim(" trim ") renvoie la chaîne " trim"

Paramètres

String text - Texte initial.

Résultats

String - Texte sans les espaces à la fin.

Depuis

Macro "startsWith(String, String)"

Signature

if ({text}.startsWith({startPattern})) {
// TODO
}

Description

Génère le code permettant de vérifier si un texte commence par la chaîne de caractères souhaitée.

Exemple :
String text = "abc";
if (text.startsWith("b")) {
   report("Text [$1] starts with \"b\"");
} else {
   report("Text [$1] doesn't start with \"b\"");
}

if (text.startsWith("a")) {
   report("Text [$1] starts with \"a\"");
} else {
   report("Text [$1] doesn't start with \"a\"");
}

Paramètres

Depuis

Méthode "substringUseLength(String, int, int)"

Signature

String substringUseLength(String text, int start, int length)

Description

Extrait une chaîne de caractères d'un texte principal, en utilisant une position de départ et le nombre de caractères à extraire. La position de départ commence à partir de 0 et elle est elle-même incluse.

Exemple :
String text = "1234567890"; xtString.substringUseLength(text, 2, 5) renvoie la chaîne de caractères "34567".

Paramètres

String text - Texte initial.
int start - Position de départ.
int length - Taille à extraire.

Résultats

String - Texte extrait.

Exceptions

XTException

Depuis

Macro "substring(String, int, int)"

Signature

{text}.substring({startIndex}, {endIndex})

Description

Génère le code java permettant d'extraire une chaîne de caractères d'un texte principal. La sous-chaîne commence à partir de l'index de début et s'étend au caractère de l'index de fin moins 1. Ainsi, la longueur de la sous-chaîne est index de fin moins index de début. Les index commencent à partir de 0.

Exemple :
String text = "123456";
L'appel text.substring(1,5) renvoie la chaîne "2345".

Paramètres

Variable/String text - Variable (de type String) ou chaîne de caractères d'origine.
int startIndex - Index de départ, compris, pour extraire la sous-chaîne à partir de la chaîne d'origine.
int endIndex - Index de fin, non compris, pour extraire la sous-chaîne à partir de la chaîne d'origine.

Résultats

String - Texte extrait.

Exceptions

IndexOutOfBoundsException - Si l'index de départ ou de fin est négatif,ou si l'index de début ou de fin est plus grand que la taille de la chaîne.

Depuis

Méthode "truncateRight(String, int)"

Signature

String truncateRight(String text, int size)

Description

Tronque le texte à droite si sa taille excède celle demandée. Note : les sauts de ligne sont supprimés.

Exemple :
String text = "123456";
L'appel xtString.truncateRight(text, 5) produit la chaîne de caractères "12345".

Paramètres

String text - Texte à traiter.
int size - Taille maximale souhaitée.

Résultats

String - Texte tronqué avec la taille spécifiée.

Depuis