public interface IIOMetadataController
GUIを使用してユーザーから値を取得するか、またはほかの手段によって、
IIOMetadata
オブジェクトの設定値を判定できるオブジェクトにより実装されるインタフェースです。 このインタフェースは、コントローラを呼び出すジェネリックactivate
メソッドを指定するだけであり、コントーラが値を取得する方法については考慮しません。つまり、コントローラがGUIを使用するか、一連の値を計算するだけかどうかは、このインタフェースには関係ありません。
activate
メソッド内で、コントローラは、XML DOMツリーまたはプラグイン固有のインタフェースを使って、IIOMetadata
オブジェクトの設定値を照会して初期値を取得し、何らかの方法で値を変更します。次に、setFromTree
またはmergeTree
メソッド、あるいはプラグイン固有のインタフェースを使用してIIOMetadata
オブジェクトの設定値を変更します。 一般に、アプリケーションはactivate
メソッドがtrue
を返す場合、IIOMetadata
オブジェクトが書込み操作に使用する準備ができていると見なすことがあります。
ベンダーは、特定のプラグインを定義するIIOMetadata
サブクラスのためのGUIを提供できます。 これらは、対応するIIOMetadata
サブクラスにデフォルト・コントローラとして設定できます。
または、データベース・ルックアップやコマンド行の解析などのアルゴリズム処理は、コントローラとして使用でき、その場合、activate
メソッドは単に設定値を参照または計算し、IIOMetadata
のメソッドを呼び出してその状態を設定して、true
を返します。
-
メソッドのサマリー
-
メソッドの詳細
-
activate
boolean activate(IIOMetadata metadata) コントローラを呼び出します。true
が返される場合は、IIOMetadata
オブジェクトの設定値はすべて書込み操作に使用する準備ができています。false
が返される場合、IIOMetadata
オブジェクトの設定は影響を受けません。つまり、ユーザーにより操作が取り消されました。- パラメータ:
metadata
- 変更されるIIOMetadata
オブジェクト。- 戻り値:
IIOMetadata
が変更されている場合はtrue
、それ以外の場合はfalse
。- 例外:
IllegalArgumentException
-metadata
がnull
、または正しいクラスのインスタンスではない場合。
-