[seasar-javadoc:525] Re: org/seasar/framework/container/package.html
Jundo Ishikawa
jundo.ishikawa ＠ gmail.com
2006年 8月 28日 (月) 13:40:16 JST
JUNDUです。
お疲れ様です。package.htmlですが、私の個人的に気に入ったイメージはjava.sql
のパッケージ説明でした。まぁ、これは書きすぎという気もしますが、構成はこんな
感じが分かりやすいように思うのですがいかがでしょうか？
http://java.sun.com/j2se/1.4/ja/docs/ja/api/java/sql/package-summary.html
このjava.sqlのまねをすると、例えば以下のような構成のイメージになるかと思い
ます。なお、説明文は適当なので、構成だけ見てください(^^;
--
S2コンテナとその構成要素を定義するインターフェースおよび、S2コンテナの振舞いに関連した例外クラスを提供します。
このパッケージを構成する主な要素は、以下のとおりです。
・コンテナ本体（S2Container）
S2コンテナ本体は、各コンポーネントの定義情報を保持し、必要に応じてコンポーネントの生成・提供を行います。S2コンテナは階層構造をもつことができ、diconファイルのincludeはS2コンテナの階層構造として内部的には表現されます。
・定義情報（〜Def）
diconファイルやアノテーションで指定されたコンポーネントの定義情報は、S2コンテナ上ではConponentDef、PropertyDefなどの定義情報として保持されます。
・定義情報の取得方法（〜DefAware）
diconファイル上でinitMethod要素の子要素としてarg要素を書くように、定義情報は親子関係を持ちます。親要素から子要素の定義情報を取り出す方法は、引数定義やメタ定義のように複数の親をもつものがあるため、個別にインターフェースとして定義されています。
・式（expression）
S2コンテナでは、コンポーネントの定義や値の定義に、式を利用することが出来ます。標準では、OGNL式をサポートしています。
・外部情報へのアクセス方法（ExternalContext）
S2コンテナの外部に保持したコンポーネントへアクセスするための方法を定義しています。例えば、Webコンテナやポートレットのrequestスコープに保持したコンポーネントへのアクセス方法を定義するのに利用しています。
・コンポーネントの構築方法（〜Assembler）
S2コンテナでは、コンストラクタ、プロパティ設定、初期化メソッドの呼び出しの順に実行してコンポーネントを組み立てますが、そのそれぞれをConstractorAssembler、PropertyAssembler、InitMethodAssemblerが担当します。
--
各クラスを見ても、それが何のために存在するのかが分かりにくいと思うのです。
それを大枠だけでもpackage.htmlで示しておくと、何のクラスなのかわかりやすくな
るかなと思いました。
> さて，いよいよリーチがかかってきたというか，打ち上げの準備に着手しなきゃ
> いけなくなってきましたね．
> 北海道の山本さんはさすがに参加頂けないと思いますが，
> # 近々上京の予定とかあります？＞山本さん
> 東京近辺にお住まいの方，是非集まって盛大に打ち上げしましょう！！
>
> 時期は来週くらい？ 09/04〜08 の週のどこかとか．
> その次の週だといろいろなイベントがあってひがさんを誘えなくなるので，
> 来週が無理なら 09/18〜22 の週がいいかも．
> 皆さんの予定は？
申し訳ないことに、09/05〜07まで夏休みで東京にいません(^^;;; ぶらり北海道に
遊びに行ってます。というわけで、私は以下のような感じです。
9/04 9/05 9/06 9/07 9/08 9/18 9/19 9/20 9/21 9/22
JUNDU ○ × × × ○ ○ ○ ○ ○ ○
06/08/28 に Koichi Kobayashi<koichik ＠ improvement.jp> さんは書きました:
> 小林 (koichik) です．
>
> Date: Thu, 24 Aug 2006 06:37:01 +0900
> From: Hideaki Suzuki <suzuki ＠ uinet.or.jp>
> To: seasar-javadoc ＠ ml.seasar.org
> Subject: [seasar-javadoc:521] Re: org/seasar/framework/container/package.html
>
> > ご無沙汰しておりましたが夏バテから復活の予感です (^^;;;
>
> 夏休みでお出かけしているのかなぁとか思ってましたが，夏バテでしたか．
> ご自愛くださいませ．
>
> > org/seasar/framework/container/package.html
> > Milestone 2 です。
>
> ありがとうございます．
>
> > 「主要なインタフェースの位置づけ紹介」部分を表にしてみました。
> > はじめに、文章で書いてみたのですが、ちと読みづらいかなと思い、
> > <dl><dt><dd>で書いたのですが、イマイチと感じたので、<table>
> > にしてみました。
>
> これ，Javadoc で生成するとクラス／インタフェース一覧表の後に
> また表が続くことになりませんか？
> 続いても悪いということはありませんが，どうなんだろう？
> とはいえ，表が見やすいなら表にするしかないですね．
>
> その表ですが，どうせならインタフェースではなく dicon のタグ名を
> 一番左に持ってきて，〜Def の隣りに 〜DefAware も並べてみては
> どうでしょうか？
>
> そうすると，説明が 〜Def しかないのはいかがなものか？
> という気もするのと，説明は Javadoc が生成する一覧にも出てくる
> はずなのと，リンク先をたどれば見れるので，こっちの一覧は
> 説明なしでもいいんじゃないかと思ってみたテスト．
>
> あと，タグ名は <components> のようにしてもらえると
> 見るからにタグっぽくていいかと思います．
>
> それから，インタフェース名って {@link 〜} 使えませんか？
> package.html に使えるのかどうか疑問も感じないではありませんが．
> もし使えない場合は <a href="S2Container.html">S2Container</a> で．
>
> > Tigerアノテーションについては、拡張プロダクトなのでここに書くのは
> > いかがなものか？とも思ったのですが、自分だったら、ここにまとめて
> > 書いてあると便利だなぁ〜と思い、一応入れておきました。
>
> そうですね，S2Tiger を使う人も見るかもしれないので，ここにあって
> いいんじゃないでしょうか．
>
> > それから、Milestone 1 の最後の「振舞いも表す」的な部分についてですが、
> > 以前、私自身「PropertyDef＝プロパティ」と勘違いしていた経験を踏まえて、
> > 書いてみたのですが、ちょっと文章の意図がはっきりしないのと、今回は、
> > 表の中の説明で「セッターインジェクション」と明確にしているので、
> > 削除しました。
>
> そうですね，ここは案内板の役割を果たせれば十分だと思うので，
> 一覧で十分だと思います．
>
>
> さて，いよいよリーチがかかってきたというか，打ち上げの準備に着手しなきゃ
> いけなくなってきましたね．
> 北海道の山本さんはさすがに参加頂けないと思いますが，
> # 近々上京の予定とかあります？＞山本さん
> 東京近辺にお住まいの方，是非集まって盛大に打ち上げしましょう！！
>
> 時期は来週くらい？ 09/04〜08 の週のどこかとか．
> その次の週だといろいろなイベントがあってひがさんを誘えなくなるので，
> 来週が無理なら 09/18〜22 の週がいいかも．
> 皆さんの予定は？
>
>
> --
> <component name="koichik">
> <property name="fullName">"Koichi Kobayashi"</property>
> <property name="email">"koichik ＠ improvement.jp"</property>
> <property name="blog">"http://d.hatena.ne.jp/koichik"</property>
> </component>
>
> _______________________________________________
> seasar-javadoc mailing list
> seasar-javadoc ＠ ml.seasar.org
> https://www.seasar.org/mailman/listinfo/seasar-javadoc
>
--
Jundo Ishikawa <jundo.ishikawa ＠ gmail.com>
seasar-javadoc メーリングリストの案内