fn:tokenize 関数

fn:tokenize 関数は、ストリングをサブストリングのシーケンスに分割します。

構文

構文図を読む
>>-fn:tokenize(--source-string--,--pattern--+----------+--)----><
                                            '-,--flags-'      

source-string
サブストリングのシーケンスに分割されるストリング。

source-string は、リテラル・ストリング、または xs:string 値または空のシーケンスに解決される XQuery 式です。

pattern
source-string 内のサブストリング間の区切り文字。

pattern は、正規表現を含むストリング・リテラルです。正規表現は、検索パターン内の 1 つのストリングまたはストリングのグループを定義する、文字、パターン・マッチング文字、および演算子のセットです。

flags
pattern の source-string への一致を制御する以下のいずれかの値を含むストリング・リテラル:
s
ドット (.) が任意の文字に一致することを示します。

s フラグが指定されていない場合、ドット (.) は改行文字 (#x0A) を除く任意の文字に一致します。

m
脱字記号 (^) が任意の行の先頭 (改行文字の後の位置) に一致し、ドル記号 ($) が任意の行の末尾 (改行文字の前の位置) に一致することを示します。

m フラグが指定されていない場合、脱字記号 (^) はストリング全体の先頭に一致し、ドル記号 ($) はストリング全体の末尾に一致します。

i
文字 "a" から "z" および "A" から "Z" について、一致で大/小文字を区別しないことを示します。

i フラグが指定されていない場合、大/小文字の区別があるマッチングが行われます。

x
pattern 内の空白文字 (#x09、#x0A、#x0D、および #x20) が無視されることを示します。ただし、それらが文字クラス内にある場合は除きます。文字クラス内の空白文字が無視されることはありません。

x フラグが指定されていない場合、空白文字はマッチングに使用されます。

戻り値

source-string が空のシーケンスまたはゼロ長ストリングでない場合、戻り値は、source-string に対して以下の操作を実行した結果の xs:string 値のシーケンスです。
  • source-string で pattern に一致する文字列が検索されます。
  • pattern が複数の代替文字セットを含んでおり、それらの代替文字セットが source-string 内の同じ位置で始まる文字列に一致する場合、source-string 内の文字列に一致する pattern 内の最初の文字のセットのみが、pattern に一致するとみなされます。
  • pattern に一致しないそれぞれの文字のセットは、結果シーケンス内の項目になります。
  • pattern が source-string の先頭の文字列に一致する場合、戻されるシーケンスの最初の項目はゼロ長ストリングです。
  • source-string 内に pattern に対して 2 つの連続する一致が検出された場合、ゼロ長ストリングがシーケンスに追加されます。
  • pattern が source-string の末尾の文字列に一致する場合、戻されるシーケンスの最後の項目はゼロ長ストリングです。

pattern が source-string に検出されない場合、source-string が戻されます。

pattern がゼロ長ストリングに一致する場合、エラーが戻されます。

source-string が空のシーケンスであるか、またはゼロ長ストリングである場合、結果は空のシーケンスです。

例

次の関数は、疑問符 (?) 文字を除去して、残りの文字からシーケンスを作成することにより、ストリング "?A?B?C?D?" からシーケンスを作成します。
fn:tokenize("?A?B?C?D?","\?")

戻り値は、シーケンス ("", "A", "B", "C", "D", "") です。