XMLUpdate - XPathによる値の更新

入力のXMLに対して更新箇所をXPathで指定して、削除/挿入/更新を行います。

■ストリーム情報

入力	フォーマット	XML
	接続数	1
出力	フォーマット	XML
	説明	入力のXMLを更新したXML

■コンポーネントプロパティ

名前	プロパティ型	マッピング	説明
削除	category	-	入力のXMLから対象XPath式で選択されたノードを削除します。対象XPath式は、XPath式エディタを使ってXMLのツリーからの選択により自動生成したXPathをプロパティに指定することができます。詳細については下記トピック「XPath式エディタ」を参照してください。 対象XPath式 削除するノードを選択するためのXPath式。 式にマッチするノードがなかった場合は何もしません。 式にマッチするノードが複数存在した場合はそのすべてのノードが削除されます。
挿入	category	入力＆出力	対象XPath式で指定された要素に、要素名または属性名で指定されたノードを作成し、値で指定された値を差し込みます。対象XPath式は、XPath式エディタを使ってXMLのツリーからの選択により自動生成したXPathをプロパティに指定することができます。詳細については下記トピック「XPath式エディタ」を参照してください。 フィールド名 マッパーで参照するための定義名。 対象XPath式 ノードを作成する要素を選択するためのXPath式。 式にマッチするノードがなかった場合は何もしません。 式にマッチするノードが要素以外だった場合はエラーになります。 式にマッチするノードが複数存在した場合はそのすべてのノードに要素名または属性名が作成されます。 要素名または属性名 作成する要素または属性の名前。 属性を作成する場合は「@attr1」のように「@」を付けて名前を指定します。 「element1/element2/@attr1」のように「/」で区切ることで深い階層のノードを作成することもできます。 要素名または属性名で指定された要素／属性はそこに同名の要素／属性があるかどうかに関わらず必ず作成されます。 （属性は置換されます。） プレフィクス付の名前を定義する場合はそのプレフィクスに対する名前空間の定義が入力ストリームのフィールド 定義で行われていなければなりません。（このコンポーネントのフィールド定義ではないことに注意してください。） 値 作成したノードに差し込む値。 マッパーで値を差し込むことができます。
更新	category	入力＆出力	対象XPath式で指定されたノードを値で指定された値で更新します。対象XPath式は、XPath式エディタを使ってXMLのツリーからの選択により自動生成したXPathをプロパティに指定することができます。詳細については下記トピック「XPath式エディタ」を参照してください。 フィールド名 マッパーで参照するための定義名。 対象XPath式 更新するノードを選択するためのXPath式。 式にマッチするノードがなかった場合は何もしません。 式にマッチするノードが要素だった場合、その要素内容が値に置き換わります。 式にマッチするノードが属性だった場合、その属性値が値に置き換わります。 式にマッチするノードがそれ以外だった場合、そのノード自体が値に置き換わります。 式にマッチするノードが複数存在した場合はそのすべてのノードが更新されます。 値 選択されたノードを更新する値。 マッパーで値を差し込むことができます。
ローカル変数	category	入力＆出力	コンポーネント内でのみ有効なローカル変数を定義します。 式中では「$local.変数名」として参照できます。

■トランザクション処理

コミット	何もしません。
ロールバック	何もしません。

■エラー処理

タイプ	パラメーター	エラー処理フロー へのストリーム	エラー コード	説明
汎用	なし	コンポーネントの入力ストリーム	なし	XPath式が不正な場合

■変数の使用

XPath式の中ではローカル変数の他にフロー変数とシステム変数が使用できます。
（外部変数セットは使用することができません。）

フロー変数	$flow.＜フロー変数名＞
システム変数	$system.＜システム変数名＞（英語名）
ローカル変数	$local.＜変数名＞

変数を使用することにより条件にあうノードだけを選択する式を書くことも可能です。

例） /root/record[@id=$local.var1]

■名前空間の解決

式中の名前空間プレフィクスの解決は、入力ストリームのフィールド定義中の名前空間定義によって行われます。
このコンポーネントのフィールド定義ではないことに注意してください。

■式の適用順序

定義された式は、削除 ,挿入 、更新 の順で上から順に適用されます。
挿入 によって作成されたノードはそれ以降の式で選択することも可能です。

「element1」に「element2」という要素がなかった場合だけ「element2」を作成し、 そこに「attr1」という属性を作成する場合には挿入 に以下のように式を定義します。

TargetPath	TargetNode
//element1[not(element2)]	element2
//element1/element2	@attr1

最初の式で、element2を持たないelement1にelement2という要素が作成され、
2番目の式でelement2にattr1という属性が作成されます。

■XPath式エディタ

XPath式エディタはプロパティ値にXPathを指定する場合にその入力をサポートするためのエディタです。ツリーからノードを選択してそこまでのXPathをプロパティに設定することができます。
XPathを指定するフィールドの右にある「...」をクリックすると起動します。

ツリー

ツリーにはXPathの対象となるストリームのフィールド定義が表示されます。例えば、XPathNodesetコンポーネントでは入力ストリームがXPathの対象となり、そのフィールド定義が表示されます。コンポーネントの入力側にリンクが繋がっていない場合、入力ストリームにフィールド定義がされていない場合は初期状態では何も表示されません。

「サンプル参照」ボタン

任意のXMLを読み込み、その構造をツリーに表示させることができます。また、ツリーで選択したノードの値（属性値または要素内容）が値タブに表示され、それを条件式の指定に利用することができます。

1. 「サンプル参照」ボタンをクリックして表示される「開く」ダイアログボックスから読み込むXMLを選択します。
2. XMLの構造が解析されてツリーに表示されます。

「サンプルをxfpに保存する」チェックボックス

サンプル参照からXMLを読み込んでいる場合、「サンプルをxfpに保存する」チェックボックスをオンにすると、読み込んだXMLがxfpファイル（プロジェクトファイル）に保存され、次回にxfpファイルを開いた場合同じXMLを参照することができます。チェックボックスがオフの場合、読み込んだXMLはエディタを保存されません。次回に使用したい場合は再度「サンプル参照」ボタンから読み込みます。

注意：サンプルXMLはコンポーネントの実行に必要な情報ではありません。ファイルサイズの大きなXMLを保存するとxfpファイル（プロジェクトファイル）のファイルサイズが大きくなり、保存やコンパイルにかかる時間も増えるため開発やテストの段階のみ保存するようにしてください。

XPathの設定

ツリーでノードを選択すると、そのXPathが「選択パス」欄に表示されます。「選択パスをXPathにコピー」のボタンを押すとそのパスが「XPath」欄にコピーされます。 「XPath」欄は編集可能なテキストフィールドで、複雑なXPathを指定する場合はそこに直接記述することができます。

変数を条件式に設定する

フロー変数やローカル変数などコンポーネントで使用可能な変数は変数タブにリストされています。
ツリーで選択したパスがXPathの一部を構成する場合は「選択パスへの条件とする」ボタンで変数との比較をXPathに追加することができます。

例

XPath	/School/Class/Student
選択パス	/School/Class/@name
変数	$flow.var1
条件追加後のXPath	/School/Class[@name=$flow.var1]/Student

選択パス「/School/Class/@name」はXPathで指定されている「/School/Class/Student」の上位に存在するので、条件式として設定することができます。 選択パスが「/School/Class/Teacher/@name」のようにXPathとは別のパスを指している場合は「選択パスへの条件とする」ボタンは無効となります。

値を条件式に設定する

サンプルXMLを参照している場合は選択パスに実際に設定されている値が値タブにリストされています。 ツリーでの選択パスがXPathの一部を構成する場合は「選択パスへの条件とする」ボタンで値との比較をXPathに追加することができます。

例

XPath	/School/Class/Student
選択パス	/School/Class/@name
値	1組
条件追加後のXPath	/School/Class[@name="1組"]/Student

条件追加が可能なルールは変数の場合と同じです。