プログラミングやる前に先お風呂はいっちゃいなさい

MEXSLTをspark projectにコミットしてみた

明日ってのは、確かに地球の自転周期から言えば、２４時間かもしれないがね
日光・鬼怒川の自転周期から言えばもっと長いのだよ。

すみません。
週末、鬼怒川に温泉入りに言っててすっかりブログが更新できませんでした。

で、一週間が過ぎましたが、ついにspark projectに自分の作ったライブラリをコミットしましたよ！

MEXSLT

このライブラリは、Flexユーザー向けのXML解析サポートライブラリとでも言いましょうか。

XSLTっていう、XMLを別のXMLやらHTMLやらに変換するマークアップ言語があるんですが、それを参考にして
FlashでXMLを読み込んで、それを自分で定義したクラスに変換したりできるものを作りました。

サンプルとして、こんなXMLを読み込むとします。
ちなみに、このXMLはなんちゃって個人情報です。

<?xml version="1.0" encoding="UTF-8"?>
<records>
  <record>
    <name>宇多田 信輔</name>
    <ruby>うただ しんすけ</ruby>
    <mail>utada_shinsuke@example.com</mail>
    <sex>男</sex>
    <age>65</age>
    <birthday>1944/1/1</birthday>
    <married>既婚</married>
    <bloodtype>A型</bloodtype>
    <prefecture>埼玉県</prefecture>
    <curry>ぶっかけ・せき止め派</curry>
  </record>
  <record>
    <name>竹下 未來</name>
    <ruby>たけした みらい</ruby>
    <mail>takeshita_mirai@example.com</mail>
    <sex>男</sex>
    <age>24</age>
    <birthday>1984/10/12</birthday>
    <married>既婚</married>
    <bloodtype>A型</bloodtype>
    <prefecture>新潟県</prefecture>
    <curry>ぶっかけ・せき止め派</curry>
  </record>
  <record>
    <name>北村 翔太</name>
    <ruby>きたむら しょうた</ruby>
    <mail>kitamura_shouta@example.com</mail>
    <sex>男</sex>
    <age>37</age>
    <birthday>1972/1/8</birthday>
    <married>既婚</married>
    <bloodtype>O型</bloodtype>
    <prefecture>神奈川県</prefecture>
    <curry>手前ルー・せき止め派</curry>
  </record>
  ...
</records>

このXMLを読み込んで、自分で定義したクラスにそれぞれの値を設定したりする作業って割とよくあると思うんですよ。
そこらへんを、MXMLを使って簡単に書けたらいいなという目論見で作ったライブラリの使用例がこちら。

（例1）

mexってのは名前空間です。あらかじめ、xmlns:mex="http://da.rkome.me/2009/mexslt"というようにmexという名前空間を設定しておいてください。

例えば、<Application>の直下でこのXMLパーサの定義を行うなら、<Application xmlns:mex="http://da.rkome.me/2009/mexslt">という感じで。

まず、一番上のMEXSLTタグ。これは、XMLパーサの定義です。
output属性には、このパーサがどのような形式を返すかを指定します。arrayかobjectのどちらかです。
そして、このパーサがどのようにXMLを解析するのかを<mex:xslt>ノード以下に書きます。

ここからは、xsltプロパティの設定の仕方。

まず、Templateという大枠の定義を書きます。
match属性に、渡されたXMLのどのタグを元にインスタンスを生成するかをXPathで指定します。
このサンプルの場合は、recordsタグの子要素のrecordタグ以下の値を一つのクラスにまとめます。

一応、クラス定義はこんな感じ。

1. package me.rkome.da.sample.model
2. {
3.   public class DummyData
4.   {
5.     public function DummyData()
6.     {
7.     }
8.  
9.     public var name:String;
10.     public var ruby:String;
11.     public var mail:String;
12.     public var sex:String;
13.     public var age:Number;
14.     public var birthday:Date;
15.     public var married:Boolean;
16.     public var bloodType:String;
17.     public var prefecture:String;
18.     public var curry:String;
19.    
20.     public function setBirthday(dateString:String):void
21.     {
22.       var array:Array = dateString.split("/");
23.       birthday = new Date(parseInt(array[0]), parseInt(array[1]), parseInt(array[2]));
24.     }
25.    
26.     public function setMarried(marriedString:String):void
27.     {
28.       married = (marriedString == "既婚");
29.     }
30.    
31.     public function toString():String
32.     {
33.       return "名前: " + this.name + "n" +
34.           "よみ: " + this.ruby + "n" +
35.           "メール: " + this.mail + "n" +
36.           "性別: " + this.sex + "n" +
37.           "歳: " + (this.sex == "女" ? this.age - 2 : this.age) + "n" +
38.           "生年月日: " + this.birthday.toDateString() + "n" +
39.           "結婚: " + (this.sex == "女" && !this.married && 30 <= this.age ? "募集中" : this.married) + "n" +
40.           "血液型: " + this.bloodType + "n" +
41.           "出身: " + this.prefecture + "n" +
42.           "カレーの食べ方: " + this.curry;
43.     }
44.   }
45. }

このクラスへと変えるために、まずNewタグというのをTemplateタグの直下に書きました。
これは、match属性でマッチしたXMLからクラスを生成する時に使用するタグです。

method属性には生成したインスタンスを出力オブジェクトに対してどうするかを指定します。
サンプルの場合、出力オブジェクトはarrayなのでここではpushを指定しています。
例えば、出力オブジェクトがobjectだった場合、Newタグのtarget属性に設定先プロパティ名、method属性にassignを指定するとtarget属性で指定したプロパティに生成したインスタンスを代入します。

product属性には、生成するインスタンスのクラス名を設定します。{}で囲んでいるのは何故かというと、product属性の値はClass型だからです。

で、Newタグの直下にずらりと書いてあるのがValueOfタグで、これはNewタグで生成したクラスに値を設定するためのタグです。

特別なクラスを生成しないで、単にString型の配列を作りたいときは、Templateタグの直下にValueOfオブジェクトを書けばOKです。

例えば、このなんちゃって個人情報の名前の配列を受け取りたい場合はこんな感じ。

（例2）

1. <mex:MEXSLT id="parser" output="array">
2.   <mex:xslt>
3.     <mex:Template name="nameList" match="records/record">
4.       <mex:ValueOf select="name" method="push" />
5.     </mex:Template>
6.   </mex:xslt>
7. </mex:MEXSLT>

さて、ValueOf タグの属性の説明。
select属性にTemplateタグで指定したXMLに対して、XPathでタグを指定します。
この例2の場合は、Templateタグのmatch属性にrecords/recordがあり、ValueOfタグのselect属性にnameがあるため、recordsタグの子要素のrecordタグの子要素のnameタグの値を指定していることになります。

method属性にはassign、push、invokeを指定できます。assignは代入、pushは配列に追加、invokeはtarget属性で指定した名前の関数をselect属性で指定した値を引数として呼び出します。
例1でinvokeを指定しているValueOfタグのtarget属性にはsetBirthdayとかsetMarriedといった関数の名前が書いてあります。
この二つはどちらもString型を引数に取る関数で、内部ではそれぞれ値をDate型やBoolean型に変換しています。
method属性のデフォルト値はassignなので、プロパティにselect属性で指定した値を代入する場合はmethod属性をいちいち設定しなくてもassignが設定されています。

この例には出てきませんが、ValueOfタグにはもう二つ重要な属性があります。
一つは、defaultValue属性です。select属性で指定した値がXML文書の中に記述されてなかった場合に設定する値を書くと、この属性で指定した値が設定されます。
もう一つは、required属性です。これもselect属性で指定した値がなかった場合の動作で、required属性をtrueに設定するとMEXSLTErrorをスローするようになります。デフォルトはfalseになっているので、必須のものにだけrequired属性をtrueに設定してください。

最後に、このように定義したMEXSLTクラスを実際に使う時です。

1. var result:Array = parser.parse(new XML(xml));
2. for each (var data ummyData in result)
3. {
4.   println(data.toString());
5.   println("================================");
6. }

parse関数でXMLを指定すれば、解析して戻り値として結果を返します。

required属性をtrueに設定した場合など、エラーがスローされる可能性がある場合はtry~catchでMEXSLTErrorをcatchするようにしてください。

また、複数のXMLパーサの定義を行いたい場合は、Templateをいくつも定義してTemplateタグのname属性に一意の名前をつけてcallTemplate関数でその名前を指定することにより、解析することが出来ます。

1. var names:Array = parser.callTemplate("nameList", new XML(xml));
2. for each (var name:String in names)
3. {
4.   println(name);
5.   println("================================");
6. }

導入方法

導入は、一番簡単なのはMEXSLT.swcをライブラリパスとしてFlexプロジェクトに追加します。

MEXSLT.swcはas3/MEXSLT/MEXSLT/binにあります。

次に、名前空間を書いてください。

Flexプロジェクトを作ると、大抵Applicationタグがルートになるはずなので、mx名前空間の次にでもmex名前空間に以下のURLで設定してください。

xmlns:mex="http://da.rkome.me/2009/mexslt"

これでMEXSLTを使えるようになるはずです。

もし分からなかったら、気軽に僕にメールを下さい。このブログにコメントして頂いても結構です。
ある程度サポート致します。

と言うわけで、鬼怒川から帰ってきたDarkOmemeはウラシマ効果によって、もう眠いわけです。普段なら3時まで平気で起きているのに、今日はまだ2時だというのに半分寝てます。

ではでは、おやすみなさい。