ファイルの種類を認識するチュートリアル

フィードバック

このチュートリアルでは IDE のプラグインモジュールや NetBeans Platform 上に作成されたアプリケーションに新しいファイルを認識させる方法を説明しています。IDE 上で認識されている「ファイルの種類」はそれぞれアイコン、メニュー、そして動作を持っています。FileObject として表示される "ファイル群" は java.io.File のラップか、あるいは構成ファイルではモジュールで使用される XML ファイルのようにデータストアのラップです。実際に見えるものは Node と呼ばれ、アクションなどの機能やファイルのオブジェクトのように地域対応された名前を提供します。この Node と FileObject の間が DataObject です。DataObject は FileObject のようなものですが、ファイルがどのような種類でどのように表示されるかの情報は知りません。ファイルには別の拡張と名前空間を持つ DataObject があります。それぞれの DataObject は別のモジュールから提供されます。それぞれの実装はひとつあるいはそれ以上のファイルの種類があります。例えば画像モジュールであれば .gif ファイルや .png ファイルを認識し開けるようにしています。

モジュールは DataLoader をインストールし新しいファイルの種類を認識します。これはそのファイルの種類特有の DataObject を提供するファクトリです。フォルダを展開すると IDE はそれぞれの利用可能な DataLoader に「これは何だかわかりますか?」と聞きにいきます。最初に「はい」と答えた DataLoader が DataObject を作成します。それぞれのファイルを実際に表示するにはシステムは DataObject.getNodeDelegate() をそれぞれの DataObject に対して呼び出します。Node が実際に IDE 上で表示されるものです。

以下の左の図にこれまでの説明して項目をあらわしています。右側の図はそれぞれの関係を表しています:

このチュートリアルではひとつのモジュールを作成し、JAR マニフェストファイル(.mf 拡張子)用の DataLoader をインストールする方法を説明します。デフォルトではマニフェストファイルは IDE では認識のできない「その他」のファイルとして扱われます。このようなファイルは通常テキストファイルとして扱われ IDE はテキストファイルとしての機能を提供します。一度モジュールを作成してしまえばマニフェストファイル専用の機能を拡張する方法を理解できます。開発サイクルが完了すれば「モジュール」として他の人にモジュールを簡単に使ってもらえるようになります。IDE を使えば他の人に配布できるようなバイナリを作成できます。他の人はアップデートセンター等でそのバイナリをインストールできます。

このチュートリアルでは以下のことを説明します:

• ソフトウェアのインストール
• サンプルのインストール
• モジュールプロジェクトの作成
• マニフェストファイルの認識
• マニフェストファイル用の機能を追加
• マニフェストファイル用の DataLoader モジュールをインストール
• 今後の拡張

このチュートリアルはソフトウェアがインストールできれば 30 分程度で完了します。

モジュール開発に関する詳細は NetBeans サイトの NetBeans Development Project home をご覧下さい。わからないところがあれば NetBeans Developer FAQ をご覧下さい。またこのページの「フィードバック」リンクを使ってください。

ソフトウェアのインストール

まずはじめにコンピュータにソフトウェアをインストールします:

• NetBeans IDE 5.0 (ダウンロード)
• Java Standard Development Kit (JDK) バージョン 1.4.2 (ダウンロード) または 5.0 (ダウンロード)

サンプルのインストール

次の手順でサンプルをインストールします:

1. サンプルファイル を展開 (unzip) します。

2. IDE の「ファイル」>「プロジェクトを開く」を選択し、解凍したファイルがあるフォルダまで移動します。モジュールプロジェクトを開きます。プロジェクトを開くと次のようになります:

   

3. プロジェクトノードを右クリックし「ターゲットプラットフォームでのインストール/再読み込み」を選びます。ターゲットプラットフォームが開きモジュールがインストールされます。

4. 「新規 プロジェクト」ウィザード (Ctrl-Shift-N) を使って Java アプリケーションを作成します。そこではマニフェストファイルは別のアイコンで表示されコンテキストメニューは新規のメニュー項目があります。コンテキストメニューを開いて結果を見てみます。

モジュールプロジェクトの作成

1. 「ファイル」>「新規プロジェクト」(Ctrl-Shift-N) を選択してください。「カテゴリ」で「NetBeans プラグインモジュール」を選択します。「プロジェクト」では「モジュールプロジェクト」を選択し「次へ」ボタンをクリックします。
2. 「名前と場所」パネルでは「プロジェクト名」に「ManifestFileType」と入力します。「プロジェクトの場所」は適当なディレクトリを指定します。例えば c:\mymodules などです。「スタンドアロンモジュール」のラジオボタンはそのままにします。パネルはこのようになります:

   

   「次へ」をクリックします。

3. 「基本モジュール構成」パネルでは「コード名ベース」で yourorghere を myorg に置き換え、org.myorg.manifestfiletype にします。デフォルトの「モジュール表示名」に空白を挿入に Manifest File Type にします。「地域対応のバンドル」と「XML レイヤー」はそのままにし org/myorg/manifestfiletype にこれらのファイルが保存されるようにします。パネルはこのようになります:

   

4. 「完了」ボタンをクリックします。

IDE は Manifest File Type プロジェクトを作成します。プロジェクトは必要なすべてのソースやメタデータ、たとえばプロジェクトの構築スクリプトなどを含んでいます。プロジェクトは IDE 上で開かれます。「プロジェクト」ウィンドウ(Ctrl-1) で理論的な構成を表示できます。また「ファイル」ウィンドウ(Ctrl-2)ではファイル構造を表示できます。例えば「プロジェクト」ウィンドウではこのようになります:

これらのファイルの基本的な説明は NetBeans IDE 5.0 プラグインモジュールクイックスタートガイド を参照してください。

マニフェストファイルの認識

1. プロジェクトノードで右クリックして「新規」>「ファイルの種類」を選択します。「次へ」をクリックします。
2. 「ファイルの認識」パネルでは次のようにします:
   • 「MIME タイプ」には text/x-java-jar-manifest と入力します。
   • 「ファイル名の拡張子」には .mf .MF と入力します。

   「ファイルの認識」パネルはこのようになります:

   

   「ファイルの認識」パネルのそれぞれの項目は次のようになっています:

   • MIME タイプ はデータオブジェクトの一意の MIME タイプを指定します。
   • 識別方法
     • ファイル拡張子 は IDE がその MIME タイプに割り当てるひとつあるいはそれ以上のファイル拡張子を指定します。ファイル拡張子は任意でドット(.)を先頭に付けることができます。セパレータはコンマ、空白あるいはどちらでもかまいません。したがって以下の例はすべて有効です:
       • .abc,.def
       • .abc .def
       • abc def
       • abc,.def ghi, .wow

       JAR ファイルのマニフェストファイルは "MANIFEST.MF" であり少なくとも UNIX プラットフォームでは大文字小文字が区別されます。そのためこのチュートリアルでは ２つ の MIME タイプを使用します、.mf と .MF です。

     • XML ルート要素 は他の XML ファイルと区別するための一意に決められた名前空間です。XML ファイルは同じ拡張子 (xml) を持つので IDE はこの XML ルート要素を使って XML ファイルを区別します。さらに具体的に言うと、IDE は XML ファイルの最初の要素で名前空間を区別します。これを使うことで例えば JBoss の配備記述子と WebLogic の配備記述子を区別することができます。この区別ができると JBoss の配備記述子のコンテキストメニューには表示されるが WebLogic のメニューには表示されないというようなメニュー項目を提供することができます。例として NetBeans コンポーネントパレットモジュールのチュートリアル(日本語) をご覧下さい。

   「次へ」をクリックします。

3. 「名前と場所」パネルでは「クラス名」に「Manifest」と入力し、16x16 ピクセルのイメージファイルを新しいファイルの種類のアイコンとして参照します。

   

   NetBeans のインストールディレクトリにはいろいろな 16x16 ピクセルのイメージファイルがあります。例えば次の場所にあります:

   enterprise2\jakarta-tomcat-5.5.7\server\webapps\admin\images

   このチュートリアルでは上記ディレクトリの Datasource.gif を使用します。これは次のようなアイコンです:

4. 「完了」ボタンをクリックします。

   これで「プロジェクト」ウィンドウはこのようになります:

   

新規に作成されたファイルについて簡単に説明します:

• ManifestDataLoader.java. このファイルは text/x-java-jar-manifest MIME タイプを認識します。ManifestDataObject.java のファクトリとして機能します。詳しい説明は What is a DataLoader? をご覧下さい。

• ManifestResolver.xml. このファイルは .mf と .MF の拡張子を MIME タイプにマップします。ManifestDataLoader は MIME タイプのみ認識します。ファイル拡張子についてはまったく知りません。

• ManifestDataObject.java. このファイルは FileObject をラップします。DataObjects は DataLoaders によって生成されます。詳しい説明は What is a DataObject? をご覧下さい。

• ManifestDataNode.java. このファイルはアクションなどの機能、アイコンや地域対応された名前など IDE 上での 見え方 を提供します。

• ManifestDataLoaderBeanInfo.java. このファイルは「オプション」ウィンドウの「オブジェクトの種類」セクションでローダーを表示するかしないかを制御します。