jp.go.aist.rtm.RTC
クラス ConfigAdmin

java.lang.Object
  上位を拡張 jp.go.aist.rtm.RTC.ConfigAdmin

public class ConfigAdmin
extends java.lang.Object

コンフィギュレーション情報を管理するクラスです。


入れ子のクラスの概要
(package private)  class ConfigAdmin.OnActivateSetCallback
          OnActivateSetCallbackクラス
(package private)  class ConfigAdmin.OnAddConfigurationAddCallback
          OnAddConfigurationAddCallbackクラス
(package private)  class ConfigAdmin.OnRemoveConfigurationSetCallback
          OnRemoveConfigurationSetCallbackクラス
(package private)  class ConfigAdmin.OnSetConfigurationSetCallback
          OnSetConfigurationSetCallbackクラス
(package private)  class ConfigAdmin.OnUpdateCallback
          OnUpdateCallbackクラス
(package private)  class ConfigAdmin.OnUpdateParamCallback
          OnUpdateParamCallbackクラス
 
コンストラクタの概要
ConfigAdmin(Properties configsets)
          コンストラクタです。
 
メソッドの概要
 boolean activateConfigurationSet(java.lang.String config_id)
          指定したコンフィギュレーションセットをアクティブにします。
 boolean addConfigurationSet(Properties config_set)
          コンフィギュレーションセットに設定値を追加します。
 boolean bindParameter(java.lang.String param_name, ValueHolder var, java.lang.String def_val)
          指定したパラメータに値を設定すします。
 void destruct()
          デストラクタです。
protected  void finalize()
          ファイナライザです。
 Properties getActiveConfigurationSet()
          現在アクティブなコンフィギュレーションセットを取得します。
 java.lang.String getActiveId()
          現在アクティブなコンフィギュレーションセットのIDを取得します。
 Properties getConfigurationSet(java.lang.String config_id)
          指定したIDのコンフィギュレーションセットを取得します。
 java.util.Vector<Properties> getConfigurationSets()
          設定されている全コンフィギュレーションセットを取得します。
 boolean haveConfig(java.lang.String config_id)
          指定したコンフィギュレーションが存在するか確認します。
 boolean isActive()
          コンフィギュレーションセットがアクティブとなっているか確認します。
 boolean isChanged()
          パラメータが変更されているか確認します。
 boolean isExist(java.lang.String param_name)
          指定したパラメータが存在するか確認します。
 void onActivateSet(java.lang.String config_id)
          onActivateSet
 void onAddConfigurationSet(Properties config_set)
          onAddConfigurationSet
 void onRemoveConfigurationSet(java.lang.String config_id)
          onRemoveConfigurationSet
 void onSetConfigurationSet(Properties config_set)
          onSetConfigurationSet
 void onUpdate(java.lang.String config_set)
          onUpdate
 void onUpdateParam(java.lang.String config_set, java.lang.String config_param)
          onUpdateParam
 boolean removeConfigurationSet(java.lang.String config_id)
          指定したコンフィギュレーションセットを削除します。
 boolean setConfigurationSetValues(java.lang.String config_id, Properties config_set)
          指定したコンフィギュレーションセットに設定値をマージします。
 void setOnActivateSet(OnActivateSetCallbackFunc cb)
          setOnActivateSet
 void setOnAddConfigurationSet(OnAddConfigurationAddCallbackFunc cb)
          setOnAddConfigurationSet
 void setOnRemoveConfigurationSet(OnRemoveConfigurationSetCallbackFunc cb)
          setOnRemoveConfigurationSet
 void setOnSetConfigurationSet(OnSetConfigurationSetCallbackFunc cb)
          setOnSetConfigurationSet
 void setOnUpdate(OnUpdateCallbackFunc cb)
          setOnUpdate
 void setOnUpdateParam(OnUpdateParamCallbackFunc cb)
          setOnUpdateParam
 void update()
          現在アクティブなコンフィギュレーションの値で,バインドパラメータの値を変更します。
 void update(java.lang.String config_set)
          コンフィギュレーションセットに設定した値で,バインドパラメータの値を変更します。
 void update(java.lang.String config_set, java.lang.String config_param)
          指定したコンフィギュレーションに設定した値で,バインドパラメータの値を変更します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

ConfigAdmin

public ConfigAdmin(Properties configsets)

コンストラクタです。

パラメータ:
configsets - 設定対象プロパティ
メソッドの詳細

destruct

public void destruct()

デストラクタです。


finalize

protected void finalize()
                 throws java.lang.Throwable

ファイナライザです。

オーバーライド:
クラス java.lang.Object 内の finalize
例外:
java.lang.Throwable

bindParameter

public boolean bindParameter(java.lang.String param_name,
                             ValueHolder var,
                             java.lang.String def_val)

指定したパラメータに値を設定すします。 設定対象値の設定に失敗した場合は,デフォルト値をパラメータに設定します。

パラメータ:
param_name - 設定対象パラメータ名
var - 設定対象値
def_val - デフォルト値
戻り値:
設定結果

update

public void update(java.lang.String config_set)

コンフィギュレーションセットに設定した値で,バインドパラメータの値を変更します。

パラメータ:
config_set - 設定対象のコンフィギュレーションセットID

update

public void update()

現在アクティブなコンフィギュレーションの値で,バインドパラメータの値を変更します。


update

public void update(java.lang.String config_set,
                   java.lang.String config_param)

指定したコンフィギュレーションに設定した値で,バインドパラメータの値を変更します。

パラメータ:
config_set - コンフィギュレーション名称 「.」区切りで最後の要素を除いた名前
config_param - コンフィギュレーションセットの最後の要素名

isExist

public boolean isExist(java.lang.String param_name)

指定したパラメータが存在するか確認します。

パラメータ:
param_name - 確認対象パラメータ名
戻り値:
存在確認結果

isChanged

public boolean isChanged()

パラメータが変更されているか確認します。

戻り値:
変更有無確認結果

getActiveId

public final java.lang.String getActiveId()

現在アクティブなコンフィギュレーションセットのIDを取得します。

戻り値:
アクティブ・コンフィギュレーションセットID

haveConfig

public final boolean haveConfig(java.lang.String config_id)

指定したコンフィギュレーションが存在するか確認します。

パラメータ:
config_id - 確認対象コンフィギュレーションID
戻り値:
存在確認結果

isActive

public boolean isActive()

コンフィギュレーションセットがアクティブとなっているか確認します。

戻り値:
確認結果

getConfigurationSets

public final java.util.Vector<Properties> getConfigurationSets()

設定されている全コンフィギュレーションセットを取得します。

戻り値:
全コンフィギュレーションセット

getConfigurationSet

public final Properties getConfigurationSet(java.lang.String config_id)

指定したIDのコンフィギュレーションセットを取得します。 存在しない場合は空のコンフィギュレーションセットを返します。

パラメータ:
config_id - 取得対象コンフィギュレーションセットID
戻り値:
コンフィギュレーションセット

setConfigurationSetValues

public boolean setConfigurationSetValues(java.lang.String config_id,
                                         Properties config_set)

指定したコンフィギュレーションセットに設定値をマージします。

パラメータ:
config_id - 追加対象コンフィギュレーションセットID
config_set - 追加対象設定値
戻り値:
追加結果

getActiveConfigurationSet

public final Properties getActiveConfigurationSet()

現在アクティブなコンフィギュレーションセットを取得します。 アクティブなコンフィギュレーションセットが存在しない場合は, 空のコンフィギュレーションセットを返します。

戻り値:
アクティブ・コンフィギュレーションセット

addConfigurationSet

public boolean addConfigurationSet(Properties config_set)

コンフィギュレーションセットに設定値を追加します。

パラメータ:
configset - 追加対象コンフィギュレーションセット
戻り値:
追加結果

removeConfigurationSet

public boolean removeConfigurationSet(java.lang.String config_id)

指定したコンフィギュレーションセットを削除します。

パラメータ:
config_id - 削除対象コンフィギュレーションセットID
戻り値:
削除結果

activateConfigurationSet

public boolean activateConfigurationSet(java.lang.String config_id)

指定したコンフィギュレーションセットをアクティブにします。

パラメータ:
config_id - アクティブにするコンフィギュレーションセットID
戻り値:
Activate結果

setOnUpdate

public void setOnUpdate(OnUpdateCallbackFunc cb)
setOnUpdate


setOnUpdateParam

public void setOnUpdateParam(OnUpdateParamCallbackFunc cb)
setOnUpdateParam


setOnSetConfigurationSet

public void setOnSetConfigurationSet(OnSetConfigurationSetCallbackFunc cb)
setOnSetConfigurationSet


setOnAddConfigurationSet

public void setOnAddConfigurationSet(OnAddConfigurationAddCallbackFunc cb)
setOnAddConfigurationSet


setOnRemoveConfigurationSet

public void setOnRemoveConfigurationSet(OnRemoveConfigurationSetCallbackFunc cb)
setOnRemoveConfigurationSet


setOnActivateSet

public void setOnActivateSet(OnActivateSetCallbackFunc cb)
setOnActivateSet


onUpdate

public void onUpdate(java.lang.String config_set)
onUpdate


onUpdateParam

public void onUpdateParam(java.lang.String config_set,
                          java.lang.String config_param)
onUpdateParam


onSetConfigurationSet

public void onSetConfigurationSet(Properties config_set)
onSetConfigurationSet


onAddConfigurationSet

public void onAddConfigurationSet(Properties config_set)
onAddConfigurationSet


onRemoveConfigurationSet

public void onRemoveConfigurationSet(java.lang.String config_id)
onRemoveConfigurationSet


onActivateSet

public void onActivateSet(java.lang.String config_id)
onActivateSet