前へ 次へ

クラス BirtStr

BirtStr クラスには、ストリングの連結、余分なスペースの切り取り、ストリングの一部の取得、およびストリングを小文字や大文字で表示するなど、ストリングを操作するための関数があります。このクラスは静的です。アプリケーションでは、このクラスのインスタンスは作成できません。

BirtStr.charLength

この関数は、指定したストリングの長さを戻します。

構文

integer BirtStr.charLength( string ソース )

パラメーター

ソース

String 型。評価するストリング。

戻り値

Integer 型。指定したストリングの文字数。

以下の例は、特定のストリングの長さを戻します。

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

以下の例は、CustomerName フィールドの各値の長さを戻します。

BirtStr.charLength( row["CustomerName"] )

BirtStr.concat

この関数は、指定したストリングを連結したストリングを戻します。

構文

string BirtStr.concat( string ソース 1, ..., ソース N )

パラメーター

ソース 1, ..., ソース N

String 型。連結するストリング。

戻り値

String 型。一連のストリングを連結したストリング。

以下の例は、複数のフィールドの値を連結して完全なアドレスを戻します。

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

BirtStr.indexOf

この関数は、指定のストリング内での指定したサブストリングの位置を戻します。

構文

integer BirtStr.indexOf( sring ターゲット, string ソース, integer 開始 )

パラメーター

ターゲット

String 型。検索するサブストリング。検索はケース・センシティブです。

ソース

String 型。指定したサブストリングを検索するストリング。

開始

Integer 型。オプション。検索を開始するソース・ストリング内の位置。この引数を省略した場合、検索はストリングの最初の文字から開始されます。

戻り値

Integer 型。ストリング内のサブストリングの数値位置。ストリングの最初の文字は、0 から始まります。サブストリングが見つからない場合、関数は -1 を戻します。

以下の例は、特定のストリング内での指定した文字の数値位置を戻します。

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

以下の例は、BirtStr.indexOf( ) と共に BirtStr.left( ) を使用して、顧客名のスペース文字の前にある文字を表示します。BirtStr.left( ) 関数は、最初の文字を先頭にして、指定された長さのサブストリングを抽出します。この例では、表示するサブストリングの長さは、スペース文字の数値位置と同じです。

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

顧客名が Julie Murphy の場合、式は Julie を戻します。

BirtStr.left

この関数は、ストリングから指定した長さのサブストリングを抽出します。抽出の開始位置は、左端または最初の文字です。

構文

string BirtStr.left( string ソース, integer n )

パラメーター

ソース

String 型。サブストリングの抽出元であるストリング。

n

Integer 型。最初の文字から数えた、抽出する文字数。

戻り値

String 型。特定の長さのサブストリング。

*
*
*

以下の例は、特定のストリングからさまざまな長さのサブストリングを戻します。

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

以下の例は、BirtStr.indexOf( ) と共に BirtStr.left( ) を使用して、顧客名のスペース文字の前にある文字を表示します。BirtStr.left( ) 関数は、最初の文字を先頭にして、指定された長さのサブストリングを抽出します。この例では、表示するサブストリングの長さは、スペース文字の数値位置と同じです。

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

顧客名が Julie Murphy の場合、式は Julie を戻します。

BirtStr.right

この関数は、ストリングから指定した長さのサブストリングを抽出します。抽出の開始位置は、右端または最後の文字です。

構文

String BirtStr.right( String ソース, integer n )

パラメーター

ソース

String 型。サブストリングの抽出元であるストリング。

n

Integer 型。最後の文字から数えた、抽出する文字数。

戻り値

String 型。特定の長さのサブストリング。

*
*
*

以下の例は、特定のストリングからさまざまな長さのサブストリングを戻します。

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

以下の例は、BirtStr.right( ) と共に BirtStr.indexOf( ) および BirtStr.charLength( ) 関数を使用して、顧客名のスペース文字の後に現れる文字を表示します。この例では、ハイフンの後にある文字数は異なっていると想定しています。そのため、BirtStr.charLength( ) から戻されるストリング全体の長さから BirtStr.indexOf( ) から戻されるハイフンまでの長さを引いた数が表示される文字数になります。

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

顧客名が Julie Murphy の場合、式は Murphy を戻します。顧客名が Kwai Li の場合、式は Li を戻します。

BirtStr.search

この関数は、指定のストリング内での指定したサブストリングの位置を戻します。サブストリングにはワイルドカード文字を含めることができます。

構文

integer BirtStr.search( string パターン, string ソース, integer インデックス )

パラメーター

パターン

String 型。検索するストリング・パターン。検索はケース・インセンシティブです。パターンには以下のワイルドカード文字を使用できます。

*
アスタリスク ( * ) は、ゼロまたはそれ以上の文字 (スペースを含む) と一致します。例えば、「t*n」は「tn」、「tin」、および「teen」と一致します。
*

ストリング内のリテラルのアスタリスクや疑問符と一致させるには、それらの文字の前に 2 つの円記号 (¥¥) を付けます。例えば、サブストリング R*10 を検索するには、以下のストリング・パターンを使用します。

"R¥¥*10"

ソース

String 型。指定したサブストリングを検索するストリング。

インデックス

Integer 型。オプション。検索を開始するソース・ストリング内の位置。この引数を省略した場合、検索はストリングの最初の文字から開始されます。

戻り値

Integer 型。ストリング内のサブストリングの数値位置。ストリングの最初の文字は、0 から始まります。サブストリングが見つからない場合、関数は -1 を戻します。

以下の例は、特定のストリング内での指定したストリング・パターンの数値位置を戻します。

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

以下の例は、ProductCode フィールドの各値で、ストリング・パターン S*A を検索します。製品コードが KBS5412A の場合、式は 2 を戻します。

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

以下の例は、BirtStr.search( ) と共に BirtStr.left( ) を使用して、製品名のストリング・パターン -Model* の前にある文字を表示します。BirtStr.left( ) 関数は、最初の文字を先頭にして、指定された長さのサブストリングを抽出します。この例では、表示するサブストリングの長さは、ストリング・パターンの数値位置と同じです。

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

製品名が XMS-ModelA-1234 の場合、式は XMS を戻します。

BirtStr.toLower

この関数は、ストリング内のすべての文字を小文字に変換します。

構文

string BirtStr.toLower( string ソース )

パラメーター

ソース

String 型。小文字に変換するストリング。

戻り値

String 型。指定したストリング (すべて小文字)

以下の例は、productLine フィールド内のすべての値を小文字で表示します。

BirtStr.toLower( row["productLine"] )

BirtStr.toUpper

この関数は、ストリング内のすべての文字を大文字に変換します。

構文

string BirtStr.toUpper( string ソース )

パラメーター

ソース

String 型。大文字に変換するストリング。

戻り値

String 型。指定したストリング (すべて大文字)

以下の例は、customerName フィールド内のすべての値を大文字で表示します。

BirtStr.toUpper( row["customerName"] )

BirtStr.trim

この関数は、すべての先行および末尾ブランク文字を削除したストリングを戻します。単語間のブランク文字は削除しません。

構文

string BirtStr.trim( string ソース )

パラメーター

ソース

String 型。先行および末尾ブランク文字を削除するストリング。

戻り値

String 型。すべての先行および末尾ブランク文字が削除されたストリング。

以下の例は、BirtStr.trim( ) を使用して、FirstName および LastName データ・フィールドからすべての先行および末尾ブランク文字を削除します。

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

BirtStr.trimLeft

この関数は、すべての先行および末尾ブランク文字を削除したストリングを戻します。単語間のブランク文字は削除しません。

構文

string BirtStr.trimLeft( string ソース )

パラメーター

ソース

String 型。先行ブランク文字を削除するストリング。

戻り値

String 型。すべての先行ブランク文字が削除されたストリング。

以下の例は、リテラル・ストリングと customerName フィールド内の各値を連結します。BirtStr.trimLeft( ) は customerName 値の前にあるすべてのブランク文字を削除して、リテラル・ストリングと customerName 値の間の余分なブランク文字をなくします。

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

BirtStr.trimRight

この関数は、すべての末尾ブランクが削除されたストリングを戻します。単語間のブランク文字は削除しません。

構文

string BirtStr.trimRight( string ソース )

パラメーター

ソース

String 型。末尾ブランク文字を削除するストリング。

戻り値

String 型。すべての末尾ブランク文字が削除されたストリング。

以下の例は、Comment フィールドの各値とセミコロンを連結し、次に Action フィールドの値と連結します。BirtStr.trimRight( ) は Comment 値の後にあるすべてのブランク文字を削除して、Comment のストリングとセミコロン値の間の余分なブランク文字をなくします。

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

(c) Copyright Actuate Corporation 2013