jp.morpho.webapp.resource
クラス MessageResourceManager

java.lang.Object
  |
  +--jp.morpho.webapp.resource.MessageResourceManager
すべての実装インタフェース:
Plugin, java.io.Serializable

public class MessageResourceManager
extends java.lang.Object
implements Plugin

リソースをユーザのロケールに依存しない方法で構築するためのものです。 エンドユーザ用に表示するメッセージは、この方法で構築してください。

作成者:
Kumiko Hiroi
関連項目:
直列化された形式

フィールドの概要
protected  java.util.ArrayList resourceEntries
          メッセージ リソース エントリのリスト
 
コンストラクタの概要
MessageResourceManager()
           MessageResourceManager を作成します。
 
メソッドの概要
 void addConfigurationFilePath(java.lang.String path)
           設定ファイルパスを追加します。
 void addMessageResourceEntry(jp.morpho.webapp.resource.MessageResourceEntry resourceEntry)
           メッセージ リソース マネージャに指定のエントリを追加します。
 java.lang.String[] getConfigurationFilePaths()
           設定ファイルパスを適切な順序で格納している配列を返します。
 java.lang.String getFieldName(java.lang.String key, java.util.Locale locale)
           このメッセージ リソース マネージャに設定されているすべてのエントリから、指定されたキーのリソースを取得します。
 java.lang.String getMessage(java.lang.String key, java.lang.Object[] objs, java.util.Locale locale)
           このメッセージ リソース マネージャに設定されているすべてのエントリから、指定されたキーのリソースを取得してメッセージを構築します。
protected  java.lang.String getMessage(java.lang.String key, java.lang.Object[] objs, java.util.Locale locale, jp.morpho.webapp.resource.MessageResourceEntry entry)
           指定されたエントリから、指定されたキーのリソースを取得してメッセージを構築します。
 java.lang.String getMessage(java.lang.String key, java.lang.Object[] objs, java.util.Locale locale, java.lang.String resourceName)
           指定された名前のエントリから、指定されたキーのリソースを取得してメッセージを構築します。
 java.lang.String getPluginKey()
           プラグインを識別するためのキーを返します。
 void pluginActivate()
           設定ファイルを読み込み、メッセージ リソース マネージャを初期化します。
 void pluginRemove()
           フレームワークでは、プラグインオブジェクトの有効期間を終わらせる前にこのメソッドを呼び出します。
 void removeAllConfigurationFilePaths()
           すべての設定ファイルパスを削除します。
 void setPluginContext(jp.morpho.webapp.PluginContext fc)
           プラグインコンテキストを設定します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

resourceEntries

protected java.util.ArrayList resourceEntries
メッセージ リソース エントリのリスト

コンストラクタの詳細

MessageResourceManager

public MessageResourceManager()

MessageResourceManager を作成します。

メソッドの詳細

removeAllConfigurationFilePaths

public void removeAllConfigurationFilePaths()

すべての設定ファイルパスを削除します。


addConfigurationFilePath

public void addConfigurationFilePath(java.lang.String path)

設定ファイルパスを追加します。 設定ファイルはフレームワークから pluginActivate() メソッドが呼び出されたときに読み込まれます。

パラメータ:
path - 設定ファイルパス

getConfigurationFilePaths

public java.lang.String[] getConfigurationFilePaths()

設定ファイルパスを適切な順序で格納している配列を返します。

戻り値:
設定ファイルパスを適切な順序で格納している配列

addMessageResourceEntry

public void addMessageResourceEntry(jp.morpho.webapp.resource.MessageResourceEntry resourceEntry)

メッセージ リソース マネージャに指定のエントリを追加します。

パラメータ:
resourceEntry - メッセージ リソース マネージャに追加されるエントリ

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object[] objs,
                                   java.util.Locale locale)

このメッセージ リソース マネージャに設定されているすべてのエントリから、指定されたキーのリソースを取得してメッセージを構築します。

パラメータ:
key - 取得するリソースのキー
objs - フォーマットするかまたは置き換える対象のオブジェクトからなる配列
locale - リソースバンドルが必要なロケール
戻り値:
フォーマットされたメッセージ

getMessage

public java.lang.String getMessage(java.lang.String key,
                                   java.lang.Object[] objs,
                                   java.util.Locale locale,
                                   java.lang.String resourceName)

指定された名前のエントリから、指定されたキーのリソースを取得してメッセージを構築します。

パラメータ:
key - 取得するリソースのキー
objs - フォーマットするかまたは置き換える対象のオブジェクトからなる配列
locale - リソースバンドルが必要なロケール
resourceName - リソースを取得するエントリの名前
戻り値:
フォーマットされたメッセージ

getMessage

protected java.lang.String getMessage(java.lang.String key,
                                      java.lang.Object[] objs,
                                      java.util.Locale locale,
                                      jp.morpho.webapp.resource.MessageResourceEntry entry)

指定されたエントリから、指定されたキーのリソースを取得してメッセージを構築します。

パラメータ:
key - 取得するリソースのキー
objs - フォーマットするかまたは置き換える対象のオブジェクトからなる配列
locale - リソースバンドルが必要なロケール
entry - リソースを取得するエントリ
戻り値:
フォーマットされたメッセージ

getFieldName

public java.lang.String getFieldName(java.lang.String key,
                                     java.util.Locale locale)

このメッセージ リソース マネージャに設定されているすべてのエントリから、指定されたキーのリソースを取得します。 これは次と同等です。

getMessage("fieldName." + key, null, locale);

パラメータ:
key - 取得するリソースのキー
locale - リソースバンドルが必要なロケール
戻り値:
フィールド名

getPluginKey

public final java.lang.String getPluginKey()

プラグインを識別するためのキーを返します。 プラグインのキーは、パッケージ名と同じ規則に従う必要があります。 この仕様では、jp.morpho.* に一致する名前を予約しています。

定義:
インタフェース Plugin 内の getPluginKey
戻り値:
プラグインを識別するためのキー
関連項目:
Plugin.getPluginKey()

setPluginContext

public void setPluginContext(jp.morpho.webapp.PluginContext fc)
                      throws PluginException

プラグインコンテキストを設定します。 フレームワークでは、プラグインインスタンスが追加された時にこのメソッドを呼び出します。

定義:
インタフェース Plugin 内の setPluginContext
パラメータ:
fc - このインスタンスを追加した FrameworkContext オブジェクト
例外:
PluginException - このメソッドによってスローされ、何らかのエラーが原因で障害が発生したことを示す

pluginActivate

public void pluginActivate()
                    throws PluginException

設定ファイルを読み込み、メッセージ リソース マネージャを初期化します。

定義:
インタフェース Plugin 内の pluginActivate
例外:
PluginException - このメソッドによってスローされ、何らかのエラーが原因で障害が発生したことを示す

pluginRemove

public void pluginRemove()
                  throws PluginException

フレームワークでは、プラグインオブジェクトの有効期間を終わらせる前にこのメソッドを呼び出します。 すべてのリソースを解放します。

定義:
インタフェース Plugin 内の pluginRemove
例外:
PluginException - このメソッドによってスローされ、何らかのエラーが原因で障害が発生したことを示す