マイニングモジュールクラスの編集

*処理ツール作成のためのMiningModuleクラス [#u149e1e6]
-処理ツールは，このクラスを継承して作成します．
-&color(red){以下の仕様は，バージョン4.0時点のものです};

*MiningModuleクラス [#rd8f831e]

**入力データ [#secc8ca9]
|TextData text;|テキストデータ．[[テキストデータ]]クラスのインスタンス|

**コンストラクタ内に記述する変数とメソッド [#jaecfd87]
|void setModuleID(int moduleID)|ツールのIDをセットする．&color(blue){開発者が値をセットする};&color(red){（必須）};|
|int pairingVisualizationID[];|処理ツールが組合せ対象とする可視化ツールのIDのリスト．&color(blue){開発者が値をセットする};&color(red){（必須）};|
|void setToolType(int type)|ツールタイプが，1:シンプル，2:プリミティブ，3:セミプリミティブの時に指定する．（デフォルト値は，4:特殊）&color(blue){開発者が値をセットする};|
|int defaultSetPanelModuleID[];|セットボタンを押したときや，このツールのチュートリアル実行時にセットされる処理ツールのIDのリスト（左のパネルから順番）&color(blue){開発者が値をセットする};|
|int defaultSetPanelVisualizationID[];|セットボタンを押したときや，このツールのチュートリアル実行時にセットされる可視化ツールのIDのリスト（左のパネルから順番）&color(blue){開発者が値をセットする};|
|int defaultBalancedPanelSize[];|このツールのチュートリアル実行時のパネルのサイズ比（左のパネルから順に整数値で指定．要素数は上2つの変数に合わせる）&color(blue){開発者が値をセットする};|
|int cancelPartialDocument;|データ絞込みによる部分テキストの表示を行わない（true：行わない，false：行う（デフォルト値）&color(blue){開発者が値をセットする};|
|boolean focusExecute;|可視化ツールからの，フォーカス連動の要請を受けるか（true：受ける，false：受けない（デフォルト値））&color(blue){開発者が値をセットする};|

**処理ツール作成用：基本的な変数とメソッド [#u20a4b2f]
|JPanel operationPanel;|ボタン類（GUIコンポーネント）をのせるためのパネル．GridLayout()で初期化されており，パネル下部に出力される．|
|boolean isMenuInJapanese()|メニュー表示が日本語か英語か．（true：日本語，false：英語）|
|void initializePanel();|GUI初期化用メソッド&color(blue){''（自動実行メソッド１）''};&color(blue){開発者がオーバーライドして内容を記述する};|
|void initializeData();|初期化と前処理用メソッド&color(blue){''（自動実行メソッド２）''};&color(blue){開発者がオーバーライドして内容を記述する};|
|void miningOperations(int)|マイニング処理と結果の出力用メソッド&color(blue){''（自動実行メソッド５）''};&color(blue){開発者がオーバーライドして内容を記述する};&color(red){（必須）};|
|void displayOperations(int)|組み合わせて使用中の可視化ツールの処理 displayOperations（引数として与える番号） を実行する．|

**データ送信用メソッド [#j1ba5825]
|void resetData()|組み合わせている可視化ツールに渡したデータ数（組み合わせている可視化ツール内部でカウントしている変数の値、dataIDに相当）を0に初期化する|
|''推奨''&color(red){（[[データ型コンバート]]対象）};''メソッド''||
|void setDataBoolean(boolean)|boolean型のデータを，可視化ツールに送る|
|void setDataInteger(int)|int型のデータを，可視化ツールに送る|
|void setDataDouble(double)|double型のデータを，可視化ツールに送る|
|void setDataString(String)|String型のデータを，可視化ツールに送る|
|void setDataBooleanArray(boolean[])|boolean[]型のデータを，可視化ツールに送る|
|void setDataIntegerArray(int[])|int[]型のデータを，可視化ツールに送る|
|void setDataDoubleArray(double[])|double[]型のデータを，可視化ツールに送る|
|void setDataStringArray(String[])|String[]型のデータを，可視化ツールに送る|
|void setDataBooleanArray2(boolean[][])|boolean[][]型のデータを，可視化ツールに送る|
|void setDataIntegerArray2(int[][])|int[][]型のデータを，可視化ツールに送る|
|void setDataDoubleArray2(double[][])|double[][]型のデータを，可視化ツールに送る|
|''dataID指定''&color(red){（コンバート非対象）};''メソッド''||
|void setDataBoolean(int dataID, boolean)|boolean型のデータを，dataIDを指定して，可視化ツールに送る|
|void setDataInteger(int dataID, int)|int型のデータを，dataIDを指定して，可視化ツールに送る|
|void setDataDouble(int dataID, double)|double型のデータを，dataIDを指定して，可視化ツールに送る|
|void setDataString(int dataID, String)|String型のデータを，dataIDを指定して，可視化ツールに送る|
|void setDataBooleanArray(int dataID, boolean[])|boolean[]型のデータを，dataIDを指定して，可視化ツールに送る|
|void setDataIntegerArray(int dataID, int[])|int[]型のデータを，dataIDを指定して，可視化ツールに送る|
|void setDataDoubleArray(int dataID, double[])|double[]型のデータを，dataIDを指定して，可視化ツールに送る|
|void setDataStringArray(int dataID, String[])|String[]型のデータを，dataIDを指定して，可視化ツールに送る|
|void setDataBooleanArray2(int dataID, boolean[][])|boolean[][]型のデータを，dataIDを指定して，可視化ツールに送る|
|void setDataIntegerArray2(int dataID, int[][])|int[][]型のデータを，dataIDを指定して，可視化ツールに送る|
|void setDataDoubleArray2(int dataID, double[][])|double[][]型のデータを，dataIDを指定して，可視化ツールに送る|

**オプションによる処理連動：実行用メソッド [#cc1961dd]
|void executeOtherModuleFirst(int moduleID, int option)|自パネル以外にセットされている，指定IDの処理ツールの miningOperations(option)を実行する&color(blue){（この処理の後，同一IDの処理ツールに，引き続き処理連動を実施する場合に用いる）};|
|void executeOtherModule(int moduleID, int option)|自パネル以外にセットされている，指定IDの処理ツールの miningOperations(option)を実行する|
|void executeModuleFirst(int moduleID, int option)|指定IDの処理ツールの miningOperations(option)を実行する&color(blue){（この処理の後，同一IDの別の処理ツールに対して，引き続き処理連動を実施する場合に用いる）};|
|void executeModule(int moduleID, int option)|指定IDの処理ツールの miningOperations(option)を実行する|
**オプションによる可視化連動：実行用メソッド [#ib2d75d8]
|void displayOtherModuleFirst(int moduleID, int option)|自パネル以外にセットされている，指定IDの可視化ツールの displayOperations(option)を実行する&color(blue){（この処理の後，同一IDの可視化ツールに，引き続き可視化連動を実施する場合に用いる）};|
|void displayOtherModule(int moduleID, int option)|自パネル以外にセットされている，指定IDの可視化ツールの displayOperations(option)を実行する|
|void displayModuleFirst(int moduleID, int option)|指定IDの可視化ツールの displayOperations(option)を実行する&color(blue){（この処理の後，同一IDの可視化ツールに対して，引き続き可視化連動を実施する場合に用いる）};|
|void displayModule(int moduleID, int option)|指定IDの可視化ツールの displayOperations(option)を実行する|

**フォーカス情報による可視化連動：実行用メソッド [#z709841a]
|void repaintOthersByFocus()|自パネル以外の可視化ツールの，displayOperations(4500)を実行する．|

**データ取得による処理連動用メソッド [#k25f49f4]
|''データ取得用''（既存データがない場合はデータ生成も行う）||
|boolean getDataBoolean(int moduleID, int dataID, int optionNumber)|boolean型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|int getDataInteger(int moduleID, int dataID, int optionNumber)|int型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|double getDataDouble(int moduleID, int dataID, int optionNumber)|double型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|String getDataString(int moduleID, int dataID, int optionNumber)|String型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|boolean[] getDataBooleanArray(int moduleID, int dataID, int optionNumber)|boolean[]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|int[] getDataIntegerArray(int moduleID, int dataID], int optionNumber)|int[]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|double[] getDataDoubleArray(int moduleID, int dataID, int optionNumber)|double[]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|String[] getDataStringArray(int moduleID, int dataID, int optionNumber)|String[]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|boolean[][] getDataBooleanArray2(int moduleID, int dataID, int optionNumber)|boolean[][]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|int[][] getDataIntegerArray2(int moduleID, int dataID, int optionNumber)|int[][]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|double[][] getDataDoubleArray2(int moduleID, int dataID, int optionNumber)|double[][]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|''データ生成＋データ取得用''||
|boolean getNewDataBoolean(int moduleID, int dataID, int optionNumber)|boolean型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|int getNewDataInteger(int moduleID, int dataID, int optionNumber)|int型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|double getNewDataDouble(int moduleID, int dataID, int optionNumber)|double型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|String getNewDataString(int moduleID, int dataID, int optionNumber)|String型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|boolean[] getNewDataBooleanArray(int moduleID, int dataID, int optionNumber)|boolean[]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|int[] getNewDataIntegerArray(int moduleID, int dataID, int optionNumber])|int[]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|double[] getNewDataDoubleArray(int moduleID, int dataID, int optionNumber)|double[]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|String[] getNewDataStringArray(int moduleID, int dataID, int optionNumber)|String[]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|boolean[][] getNewDataBooleanArray2(int moduleID, int dataID, int optionNumber)|boolean[][]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|int[][] getNewDataIntegerArray2(int moduleID, int dataID, int optionNumber)|int[][]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|
|double[][] getNewDataDoubleArray2(int moduleID, int dataID, int optionNumber)|double[][]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(optionNumber) を実行する|

|''データ取得用''（既存データがない場合はデータ生成も行う）||
|boolean getDataBoolean(int moduleID, int dataID)|boolean型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|int getDataInteger(int moduleID, int dataID)|int型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|double getDataDouble(int moduleID, int dataID)|double型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|String getDataString(int moduleID, int dataID)|String型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|boolean[] getDataBooleanArray(int moduleID, int dataID)|boolean[]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|int[] getDataIntegerArray(int moduleID, int dataID])|int[]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|double[] getDataDoubleArray(int moduleID, int dataID)|double[]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|String[] getDataStringArray(int moduleID, int dataID)|String[]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|boolean[][] getDataBooleanArray2(int moduleID, int dataID)|boolean[][]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|int[][] getDataIntegerArray2(int moduleID, int dataID)|int[][]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|double[][] getDataDoubleArray2(int moduleID, int dataID)|double[][]型のデータを，指定IDの処理ツールが生成する，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|''データ生成＋データ取得用''||
|boolean getNewDataBoolean(int moduleID, int dataID)|boolean型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|int getNewDataInteger(int moduleID, int dataID)|int型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|double getNewDataDouble(int moduleID, int dataID)|double型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|String getNewDataString(int moduleID, int dataID)|String型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|boolean[] getNewDataBooleanArray(int moduleID, int dataID)|boolean[]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|int[] getNewDataIntegerArray(int moduleID, int dataID])|int[]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|double[] getNewDataDoubleArray(int moduleID, int dataID)|double[]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|String[] getNewDataStringArray(int moduleID, int dataID)|String[]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|boolean[][] getNewDataBooleanArray2(int moduleID, int dataID)|boolean[][]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|int[][] getNewDataIntegerArray2(int moduleID, int dataID)|int[][]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|
|double[][] getNewDataDoubleArray2(int moduleID, int dataID)|double[][]型のデータを，指定IDの処理ツールを実行した上で，dataIDのデータを取得する．既存データがない場合 miningOperations(dataID) を実行する|

**フォーカスデータ設定用メソッド（変数） [#p28c5af9]
-フォーカスデータ生成用ローカル変数
|boolean focusKeywords[];|各キーワードのフォーカスのon, off（添え字にはキーワード番号を用いる）|
|boolean focusSentences[];|各文のフォーカスのon, off（添え字には文番号を用いる）|
|boolean focusSegments[];|各セグメントのフォーカスのon, off（添え字にはセグメント番号を用いる）|
-フォーカスデータ初期化用メソッド
|void resetAllFocus()|セグメント，文，キーワードに関するフォーカスデータをすべて初期化|
|void resetMainSub()|セグメント，文，キーワードのメイン，サブに関するフォーカスデータのみを初期化|
-セグメント，文，キーワードのフォーカスデータセット用メソッド
--String japaneseCondition, String englishCondition には，フォーカスデータの意味を与えます(""で省略可能)．
--onlyをtrueにすると，mainとsubの他方の値を-1に初期化します
|void setFocusSegments(String japaneseCondition, String englishCondition)|変数focusSegmentsのデータを，TextData.Focusクラスにコピー|
|void setFocusSentences(String japaneseCondition, String englishCondition)|変数focusSentencesのデータを，TextData.Focusクラスにコピー|
|void setFocusKeywords(String japaneseCondition, String englishCondition)|変数focusKeywordsのデータを，TextData.Focusクラスにコピー|
|void setMainFocusKeyword(int value, String japaneseCondition, String englishCondition, boolean only)|valueの値を，TextData.Focusクラスにコピー|
|void setSubFocusKeyword(int value, String japaneseCondition, String englishCondition, boolean only)|valueの値を，TextData.Focusクラスにコピー|
|void setMainFocusSegment(int value, String japaneseCondition, String englishCondition, boolean only)|valueの値を，TextData.Focusクラスにコピー|
|void setSubFocusSegment(int value, String japaneseCondition, String englishCondition, boolean only)|valueの値を，TextData.Focusクラスにコピー|
|void setMainFocusSentence(int value, String japaneseCondition, String englishCondition, boolean only)|valueの値を，TextData.Focusクラスにコピー|
|void setSubFocusSentence(int value, String japaneseCondition, String englishCondition, boolean only)|valueの値を，TextData.Focusクラスにコピー|
-真理値，整数，実数，文字列のフォーカスデータセット用メソッド
|void setMainFocusBoolean(boolean value)|valueの値を，Control.Focusクラスにコピー|
|void setSubFocusBoolean(boolean value)|valueの値を，Control.Focusクラスにコピー|
|void setMainFocusInteger(int value)|valueの値を，Control.Focusクラスにコピー|
|void setSubFocusInteger(int value)|valueの値を，Control.Focusクラスにコピー|
|void setMainFocusDouble(double value)|valueの値を，Control.Focusクラスにコピー|
|void setSubFocusDouble(double value)|valueの値を，Control.Focusクラスにコピー|
|void setMainFocusString(String value)|valueの値を，Control.Focusクラスにコピー|
|void setSubFocusString(String value)|valueの値を，Control.Focusクラスにコピー|
|void setFocusBooleanArray(boolean value[])|valueの値を，Control.Focusクラスにコピー|
|void setFocusIntegerArray(int value[])|valueの値を，Control.Focusクラスにコピー|
|void setFocusDoubleArray(double value[])|valueの値を，Control.Focusクラスにコピー|
|void setFocusStringArray(String value[])|valueの値を，Control.Focusクラスにコピー|
|void setFocusBooleanArray2(boolean value[][])|valueの値を，Control.Focusクラスにコピー|
|void setFocusIntegerArray2(int value[][])|valueの値を，Control.Focusクラスにコピー|
|void setFocusDoubleArray2(double value[][])|valueの値を，Control.Focusクラスにコピー|

**ファイル入出力用メソッド（変数） [#q3063ee1]
|String inJapanese[]|ファイルからの文字列読み込み用変数．処理ツールがあるフォルダ内のファイル「&color(red){Japanese.txt};」が．initializePanel()の実行前に自動的に読み込まれる|
|String fileRead()|処理ツールがあるフォルダ内のファイル「&color(red){Japanese.txt};」を読み込む|
|String fileRead(String)|処理ツールがあるフォルダ内のファイル「引数として与えられた文字列」を読み込む|
|String[] fileReadArray()|処理ツールがあるフォルダ内のファイル「&color(red){Japanese.txt};」を読み込む|
|String[] fileReadArray(String)|処理ツールがあるフォルダ内のファイル「引数として与えられた文字列」を読み込む|
|void fileWrite(String, String)|第１引数として与えられたファイル名のファイルに，第２引数として与えられた文字列を書き込む|
|void fileWriteArray(String, String[], int)|第１引数として与えられたファイル名のファイルに，第２引数として与えられた文字列を，第３引数の行数分だけ，書き込む|

**ボタン用変数 [#m0e687e1]
|JButton button[]|ボタン用の変数（これを利用すると[[キャラクターアシストチュートリアル>キャラクターアシストチュートリアルの作成]]での指差し説明が可能になります）|
|JToggleButton toggleButton[]|トグルボタン用の変数（これを利用すると[[キャラクターアシストチュートリアル>キャラクターアシストチュートリアルの作成]]での指差し説明が可能になります）|

**再処理用メソッド [#b9ae2498]

**設定取得用メソッド [#b9ae2498]

**操作ログ保存用メソッド [#uf8f3065]
|void writeActionLog(String)|「システムが起動してからの時間(秒)，Mining/Visualizationの区別，パネルID，ツールID，引数で与えられた文字列」のデータを，スペース区切りで一行として，TETDMの実行ファイルがあるフォルダ内に，ファイル「&color(red){ACTIONLOG};」に追加保存|

**パネルセット用メソッド（&color(red){バージョン1.10以降};） [#q3063ee1]
|void panelSetFromModule(int moduleIDs[], int displayIDs[])|与えられたIDの処理ツールと可視化ツールがセットされたパネル構成に変更する|
|void panelSetFromModule(int moduleIDs[], int displayIDs[], int sizeX[])|与えられたIDの処理ツールと可視化ツールがセットされたパネル構成に変更する．表示時の横幅の比をsizeXで与える|
-セットするツールのIDは，[[処理ツール一覧>マイニング処理ツール一覧]]または[[可視化ツール一覧>可視化インタフェースツール一覧]]を参考にして下さい．自作のツールをセットする場合は，そのIDを用いて下さい．

タイムスタンプを変更しない