Précédent Suivant

Classe BirtStr

La classe BirtStr fournit des fonctions permettant de manipuler les chaînes, par exemple, pour concaténer des chaînes, supprimer les espaces superflus, obtenir des parties d'une chaîne et afficher des chaînes en minuscules ou en majuscules. Cette classe est statique. L'application ne peut pas créer d'instance de la classe.

BirtStr.charLength

Cette fonction retourne la longueur d'une chaîne.

Syntaxe

integer BirtStr.charLength( string source )

Paramètre

source

Chaîne. Chaîne à évaluer.

Renvoie

Entier. Nombre de caractères dans la chaîne spécifiée.

Exemples

L'exemple suivant retourne la longueur d'une chaîne spécifiée :

BirtStr.charLength( "Julie Murphy" ) // retourne 12

L'exemple suivant renvoie la longueur de chaque valeur dans la zone CustomerName :

BirtStr.charLength( row["CustomerName"] )

BirtStr.concat

Cette fonction retourne la chaîne résultant de la concaténation des chaînes spécifiées.

Syntaxe

string BirtStr.concat( string source1, ..., sourceN )

Paramètre

source1, ..., sourceN

Chaîne. Chaîne à concaténer.

Renvoie

Chaîne. Chaîne résultant de la concaténation d'une série de chaînes.

Exemple

L'exemple suivant retourne une adresse complète en concaténant les valeurs de plusieurs zones :

BirtStr.concat( row["AddressLine1"], ", ", row["AddressLine2"], ", ", row["City"], " ", row["PostalCode"], "row["State"], ", ", row["Country"] )

BirtStr.indexOf

Cette fonction retourne la position d'une sous-chaîne spécifiée dans une chaîne.

Syntaxe

integer BirtStr.indexOf( string target, string source, integer start )

Paramètres

target

Chaîne. Sous-chaîne à rechercher. La recherche tient compte de la casse.

source

Chaîne. Chaîne contenant une sous-chaîne à rechercher.

start

Entier. Facultatif. Position de début de la recherche dans la chaîne source. Si vous omettez cet argument, la fonction démarre la recherche à partir du premier caractère de la chaîne.

Renvoie

Entier. Position numérique de la sous-chaîne dans la chaîne. Le premier caractère d'une chaîne commence à 0. Si la sous-chaîne est introuvable, la fonction retourne -1.

Exemples

L'exemple suivant retourne la position numérique des caractères spécifiés dans les chaînes indiquées :

"BirtStr.indexOf( " ", "Julie Murphy" ) // retourne 5
BirtStr.indexOf( "-", "ModelA-1234-567" ) // retourne 6
BirtStr.indexOf( "-", "ModelA-1234-567", 7 ) // retourne 11

L'exemple suivant utilise BirtStr.indexOf( ) avec BirtStr.left( ) pour afficher les caractères qui précèdent l'espace dans un nom de client. La fonction BirtStr.left( ) extrait une sous-chaîne d'une longueur donnée, à partir du premier caractère. Dans cet exemple, la longueur de la sous-chaîne à afficher est égale à la position numérique de l'espace.

spaceCharPosition = BirtStr.indexOf( " ", row["customerName"] );
displayFirstName = BirtStr.left( row["customerName"], spaceCharPosition );

Si le nom du client est Julie Murphy, l'expression retourne Julie.

BirtStr.left

Cette fonction extrait une sous-chaîne d'une longueur donnée depuis une chaîne en commençant par le caractère le plus à gauche ou le premier.

Syntaxe

string BirtStr.left( string source, integer n )

Paramètres

source

Chaîne. Chaîne de laquelle extraire une sous-chaîne.

n

Entier. Nombre de caractères à extraire en commençant à partir du premier caractère.

Renvoie

Chaîne. Sous-chaîne d'une longueur donnée.

*
*
*

Exemples

L'exemple suivant retourne des sous-chaînes de diverses longueurs depuis des chaînes spécifiques :

BirtStr.left( "Julie Murphy", 5 ) // retourne Julie
BirtStr.left( "Julie Murphy", 12 ) // retourne Julie Murphy

L'exemple suivant utilise BirtStr.indexOf( ) avec BirtStr.left( ) pour afficher les caractères qui précèdent l'espace dans un nom de client. La fonction BirtStr.left( ) extrait une sous-chaîne d'une longueur donnée, à partir du premier caractère. Dans cet exemple, la longueur de la sous-chaîne à afficher est égale à la position numérique de l'espace.

spaceCharPosition = BirtStr.indexOf( " ", row["customerName"] );
displayFirstName = BirtStr.left( row["customerName"], spaceCharPosition );

Si le nom du client est Julie Murphy, l'expression retourne Julie.

BirtStr.right

Cette fonction extrait une sous-chaîne d'une longueur donnée depuis une chaîne en commençant par le caractère le plus à droite ou le dernier.

Syntaxe

String BirtStr.right( String source, integer n )

Paramètres

source

Chaîne. Chaîne de laquelle extraire une sous-chaîne.

n

Entier. Nombre de caractères à extraire en commençant à partir du dernier caractère.

Renvoie

Chaîne. Sous-chaîne d'une longueur donnée.

*
*
*

Exemples

L'exemple suivant retourne des sous-chaînes de diverses longueurs extraites de chaînes spécifiques :

BirtStr.right( "Julie Murphy", 6 ) // retourne Murphy
BirtStr.right( "Julie Murphy", 12 ) // retourne Julie Murphy

L'exemple suivant utilise BirtStr.right( ) avec les fonctions BirtStr.indexOf( ) et BirtStr.charLength( ) pour afficher les caractères qui se trouvent après l'espace dans un nom de client. Cet exemple suppose que le nombre de caractères après le tiret varie. Par conséquent, la longueur de l'ensemble de la chaîne (retournée par BirtStr.charLength( )) moins la longueur jusqu'au tiret (retournée par BirtStr.indexOf( )) correspond au nombre de caractères à afficher.

spaceCharPosition = BirtStr.indexOf( " ", row["customerName"] );
displayLastName = BirtStr.right( row["customerName"], (BirtStr.charLength( row["customerName"] - (spaceCharPosition + 1)) )

Si le nom du client est Julie Murphy, l'expression retourne Murphy. Si le nom du client est Kwai Li, l'expression retourne Li.

BirtStr.search

Cette fonction retourne la position d'une sous-chaîne donnée dans une chaîne. La sous-chaîne peut contenir des caractères génériques.

Syntaxe

integer BirtStr.search( string pattern, string source, integer index )

Paramètres

pattern

Chaîne. Modèle de chaîne à rechercher. La recherche tient compte de la casse. Vous pouvez utiliser les caractères génériques suivants dans un modèle :

*
L'astérisque ( * ) correspond à zéro ou plusieurs caractères, y compris les espaces. Par exemple, t*n établit une correspondance avec tn, tin et teen.
*

Pour faire correspondre un astérisque ou un point d'interrogation littéral dans une chaîne, faites précéder ces caractères de deux barres obliques inverses (\\). Par exemple, pour rechercher la sous-chaîne R*10, utilisez le modèle de chaîne suivant :

"R\\*10"

source

Chaîne. Chaîne contenant une sous-chaîne à rechercher.

index

Entier. Facultatif. Position de début de la recherche dans la chaîne source. Si vous omettez cet argument, la fonction démarre la recherche à partir du premier caractère de la chaîne.

Renvoie

Entier. Position numérique de la sous-chaîne dans la chaîne. Le premier caractère d'une chaîne commence à 0. Si la sous-chaîne est introuvable, la fonction retourne -1.

Exemples

L'exemple suivant retourne la position numérique des modèles de chaîne définis dans des chaînes spécifiques :

BirtStr.search( "XM?", "XMS-ModelA-1234-567" ) // retourne 0
BirtStr.search( "ModelA*", "XMS-ModelA-1234-567" ) // retourne 4
BirtStr.search( "-", "XMS-ModelA-1234-567", 4 ) // retourne 10

L'exemple suivant permet de rechercher le modèle de chaîne S*A dans chaque valeur de la zone ProductCode. Si le code produit est KBS5412A, l'expression retourne 2.

BirtStr.search( "S*A", row["ProductCode"] )

L'exemple suivant utilise BirtStr.search( ) avec BirtStr.left( ) pour afficher les caractères qui précèdent le modèle de chaîne -Model* dans un nom de produit. La fonction BirtStr.left( ) extrait une sous-chaîne d'une longueur donnée, à partir du premier caractère. Dans cet exemple, la longueur de la sous-chaîne à afficher est égale à la position numérique du modèle de chaîne.

stringPatternPosition = BirtStr.search( "-Model*", row["productName"] );
displayString = BirtStr.left( row["productName"], stringPatternPosition );

Si le nom de produit est XMS-ModelA-1234, l'expression retourne XMS.

BirtStr.toLower

Cette fonction convertit toutes les lettres d'une chaîne en minuscules.

Syntaxe

string BirtStr.toLower( string source )

Paramètre

source

Chaîne. Chaîne à convertir en minuscules.

Renvoie

Chaîne. Chaîne spécifiée avec toutes les lettres en minuscules

Exemple

L'exemple suivant affiche toutes les valeurs de la zone productLine en minuscules :

BirtStr.toLower( row["productLine"] )

BirtStr.toUpper

Cette fonction convertit toutes les lettres d'une chaîne en majuscules.

Syntaxe

string BirtStr.toUpper( string source )

Paramètre

source

Chaîne. Chaîne à convertir en majuscules.

Renvoie

Chaîne. Chaîne spécifiée avec toutes les lettres en majuscules

Exemple

L'exemple suivant affiche toutes les valeurs de la zone customerName en majuscules :

BirtStr.toUpper( row["customerName"] )

BirtStr.trim

Cette fonction retourne une chaîne avec tous les espaces de début et de fin supprimés. Elle ne supprime pas les espaces entre les mots.

Syntaxe

string BirtStr.trim( string source )

Paramètre

source

Chaîne. Chaîne dans laquelle les espaces de début et de fin doivent être supprimés.

Renvoie

Chaîne. Chaîne avec tous les espaces de début et de fin supprimés.

Exemple

L'exemple suivant utilise BirtStr.trim( ) pour supprimer tous les espaces de début et de fin des valeurs des zones de données FirstName et LastName.

BirtStr.trim( row["FirstName"]) + " " + BirtStr.trim(row["LastName"] )

BirtStr.trimLeft

Cette fonction retourne une chaîne avec tous les espaces de début et de fin supprimés. Elle ne supprime pas les espaces entre les mots.

Syntaxe

string BirtStr.trimLeft( string source )

Paramètre

source

Chaîne. Chaîne dans laquelle les espaces de début doivent être supprimés.

Renvoie

Chaîne. Chaîne avec tous les espaces de début supprimés.

Exemple

L'exemple suivant concatène une chaîne littérale avec chaque valeur de la zone customerName. BirtStr.trimLeft( ) supprime tous les espaces qui précèdent la valeur customerName pour qu'il n'y ait aucun espace entre la chaîne littérale et la valeur customerName.

"Customer name: " + BirtStr.trimLeft( row["customerName"] )

BirtStr.trimRight

Cette fonction retourne une chaîne avec tous les espaces de fin supprimés. Elle ne supprime pas les espaces entre les mots.

Syntaxe

string BirtStr.trimRight( string source )

Paramètre

source

Chaîne. Chaîne dans laquelle les espaces de fin doivent être supprimés.

Renvoie

Chaîne. Chaîne avec tous les espaces de fin supprimés.

Exemple

L'exemple suivant concatène chaque valeur dans la zone Comment avec un point-virgule, puis avec une valeur de la zone Action. BirtStr.trimRight( ) supprime tous les espaces après la valeur Comment pour qu'il n'y ait aucun espace entre la chaîne Comment et le point-virgule.

BirtStr.trimRight( row["Comment"]) + "; " + row["Action"] )

(c) Copyright Actuate Corporation 2013