fn:matches 関数

fn:matches 関数は、ストリングが指定されたパターンに一致するかどうかを判別します。

構文

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

source-string
パターンと比較するストリング。

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

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

pattern はストリング・リテラルです。

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 が pattern に一致する場合に true である xs:boolean 値です。 source-string が pattern に一致しない場合、戻り値は false です。

マッチングの規則は、以下のとおりです。

  • pattern がストリング開始または行開始文字である脱字記号 (^)、またはストリング終了または行終了文字であるドル記号 ($) を含まない場合、source-string のいずれかのサブストリングが pattern に一致すると source-string は pattern に一致します。
  • pattern がストリング開始または行開始文字である脱字記号 (^) を含む場合、source-string が source-string の先頭または source-string 内の 1 つの行の先頭から pattern に一致する場合のみ、source-string は pattern に一致します。
  • pattern がストリング終了または行終了文字であるドル記号 ($) を含む場合、source-string が source-string の末尾または source-string 内の 1 つの行の末尾の pattern に一致する場合のみ、source-string は pattern に一致します。
  • m フラグは、以下のことを決定します。
    • 一致が、ストリングの先頭または行の先頭から行われるかどうか
    • 一致が、ストリングの末尾または行の末尾から行われるかどうか

source-string が空のシーケンスである場合、source-string はゼロ長ストリングであるとみなされ、pattern がゼロ長ストリングに一致する場合に source-string が pattern に一致します。

例

ストリング内のサブストリングに対するパターンのマッチングの例: 次の関数は、ストリング "ac" または "bd" がストリング "abbcacadbdcd" 内のどこかに現れるかどうかを判別します。
fn:matches("abbcacadbdcd","(ac)|(bd)")

戻り値は true です。

ストリング全体に対するパターンのマッチングの例: 次の関数は、ストリング "ac" または "bd" がストリング "bd" に一致するかどうかを判別します。脱字記号 (^) 文字およびドル記号 ($) 文字は、ソース・ストリングの先頭で開始しソース・ストリングの末尾で終了する一致でなければならないことを示します。
fn:matches("bd","^(ac)|(bd)$")

戻り値は true です。