マイニング処理ツールの作り方(簡易版)

マイニング処理ツール(簡易版) †

• 入力テキストのデータ（テキストデータ）を入力として，入力テキストに関する処理結果をデータとして生成し，可視化ツールに出力します．
• 簡易版：複数の処理を行うためのボタン類を用意せず，単一の処理を実行する

マイニング処理ツール(簡易版)作成の概要 †

• マイニング処理ツール作成用の、マイニングモジュールクラス(MiningModule)を継承(extends)してクラスを作成します。
• 出力データを作成するための処理は，miningOperations() メソッドの中から、呼び出される形で記述します。(オーバーライド）
• 出力データの作成に必要な（データの再生成時に必要な）初期化処理は、initializeData() メソッドの中に記述します。（オーバーライド）
  • 入力テキストの再読み込みがあった場合など、データ再生成の命令があったときに呼び出されます。
• 処理結果は、setData***() メソッドを利用して、可視化インタフェースツールに渡します。
  • ***の部分には渡すデータの型を表す文字列が入ります。

マイニング処理ツールの構成 †

パネル初期化時の処理の流れ †

データ更新時の処理の流れ †

サンプルプログラム †

Sample1.java ：入力テキストの単語間にスペースを入れた文字列を生成

作成の準備 †

• module/MiningModules フォルダ内に，自分が作成するツール（クラス）名のフォルダ(たとえばMyModule)を作成します．
  • モジュール名に使用できるのは，アルファベットか数字のみで，一文字目は大文字にする必要があります．
• 作成したフォルダ内に，ソースファイル MyModule.java を用意します．
• MiningModule クラスのサブクラスとして実装します．

     例)  class MyModule extends MiningModule

コンストラクタの作成 †

• setModuleIDメソッドにより，ツールIDを与えます．（公開用に取得したID，または他のツールとかぶらないID）

     例)  setModuleID(4723);

• 配列 pairingVisualizationID を初期化して，ペアとなる可視化インタフェースツールのIDを1つ以上指定します．

     例)  pairingVisualizationID = new int[]{1};

• ツールタイプが，1:シンプル，2:プリミティブ，3:セミプリミティブ，に該当するときは，setToolType(int) メソッドにより，該当するタイプ番号をセットして下さい．

     例)  setToolType(2);

• コンストラクタ内には，マイニングモジュールクラスのコンストラクタ用の処理以外は記述しないで下さい

変数の宣言 †

• クラス内のグローバル変数を宣言して下さい．
• 宣言した変数の初期化とインスタンス化は，必ずいずれかのメソッド内で行って下さい．

入力 †

• 入力は，マイニングモジュールクラスで定義されている TextData 型のインスタンス text を利用して下さい．

自動実行メソッドの実装 †

• マイニングモジュールクラスで用意されている下記のメソッドを，オーバーライドして実装してください．

[2.初期化と前処理] void initializeData(){} †

• 処理ツール内の変数の初期化，マイニングの前処理を記述して下さい

[5.7. マイニング処理と結果の出力] void miningOperations(int optionNumber){}　(実装必須） †

• 全体をswitch(optionNumber) case 文により記述した上で，case 0: の箇所に以下を記述してください．
  • マイニング処理の結果を生成する処理
  • 処理結果を可視化ツールに送る setData*** メソッド
• 可視化ツールの初期表示（[6.結果の描画]）が終わった後に実行する処理（[7.マイニング後処理]）を， case -1:の箇所に記述することができます．
  • 可視化ツールの表示オプションを指定（ボタン等の初期設定）するなどの利用を想定しています．

出力 †

dataID について †

• 出力は，まず，dataID (可視化ツールがデータ受け取る際のID番号．可視化ツール内でデータ型ごとにカウント)の値を0にリセットする、下記のメソッドを呼び出してください。

   void resetData();

• setData*** メソッドにより可視化ツールがデータの受け取りに成功するごとに、可視化ツール内の，そのデータ型の dataID は 1 ずつ増加します
• dataIDの値は、ペアとする可視化ツールごとに、0から1ずつ増加していきます。

setData*** メソッド †

• 出力データの型に対応する setData*** メソッド（マイニングモジュールクラス内で定義）の引数に，生成したデータを与えて呼び出すことで、データを出力してください．

   void setDataBoolean(boolean data);
   void setDataInteger(int data);
   void setDataDouble(double data);
   void setDataString(String data);
   void setDataBooleanArray(boolean data[]);
   void setDataIntegerArray(int data[]);
   void setDataDoubleArray(double data[]);
   void setDataStringArray(String data[]);
   void setDataBooleanArray2(boolean data[][]);
   void setDataIntegerArray2(int data[][]);
   void setDataDoubleArray2(double data[][]);

• 上記のメソッドを1つだけ用いる場合，プリミティブツール（参考：ツールタイプ）となります．
• 特定の dataID のデータとして可視化ツールにデータを送りたい場合，上記メソッドの使用回数を把握して数を合わせるか，下記のメソッドにより直接 dataID を指定してデータを送ってください．

   void setDataBoolean(int dataID, boolean data);
   void setDataInteger(int dataID, int data);
   void setDataDouble(int dataID, double data);
   void setDataString(int dataID, String data);
   void setDataBooleanArray(int dataID, boolean data[]);
   void setDataIntegerArray(int dataID, int data[]);
   void setDataDoubleArray(int dataID, double data[]);
   void setDataStringArray(int dataID, String data[]);
   void setDataBooleanArray2(int dataID, boolean data[][]);
   void setDataIntegerArray2(int dataID, int data[][]);
   void setDataDoubleArray2(int dataID, double data[][]);

• dataID を指定するメソッドを利用した場合，データ型コンバートは行われません．（プリミティブ、セミプリミティブツール（参考：ツールタイプ）の認定対象外となります）

コンパイル †

• 統合環境の tetdm フォルダ内で make または ant でコンパイルしてください．（自動的に統合環境に組み込まれます）
  • makeまたはantコマンドが無い場合は，コマンドをインストールしてください．
  • Windowsのコマンドプロンプトでは，Makefileに記述されているjavacコマンド内のワイルドカード*が使用できないことがあります．
    • その場合，antコマンドを使用できるようにしていただくか，cygwinなどのターミナルソフトのインストールが必要です．
  • antコマンドでコンパイルを行った場合，各フォルダ内にclassファイルは作成されませんが動作には問題ありません．