nablarch.common.code

クラス BasicCodeManager

java.lang.Object

nablarch.common.code.BasicCodeManager

すべての実装されたインタフェース:

CodeManager

public class BasicCodeManager
extends java.lang.Object
implements CodeManager

CodeManagerの基本実装クラス。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
BasicCodeManager()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	contains(java.lang.String codeId, java.lang.String value) コードID、コード値を条件に、そのコード値を持ったコードが存在するかチェックする。
boolean	contains(java.lang.String codeId, java.lang.String pattern, java.lang.String value) コードID、使用するパターンのカラム名、コード値を条件に、 そのコード値に対応するコードが、パターンに存在するかチェックする。
java.lang.String	getName(java.lang.String codeId, java.lang.String value) コードID、コード値を条件に、対応するコード名称を取得する。
java.lang.String	getName(java.lang.String codeId, java.lang.String value, java.util.Locale locale) コードID、コード値、取得対象の言語を条件に、対応するコード名称を取得する。
java.lang.String	getOptionalName(java.lang.String codeId, java.lang.String value, java.lang.String optionColumnName) コードID、コード値、取得するオプション名称のカラム名を条件に、 対応するコードのオプション名称を取得する。
java.lang.String	getOptionalName(java.lang.String codeId, java.lang.String value, java.lang.String optionColumnName, java.util.Locale locale) コードID、コード値、取得するオプション名称のカラム名、言語を条件に、 対応するコードのオプション名称を取得する。
java.lang.String	getShortName(java.lang.String codeId, java.lang.String value) コードID、コード値を条件に、対応するコードの略称を取得する。
java.lang.String	getShortName(java.lang.String codeId, java.lang.String value, java.util.Locale locale) コードID、コード値、取得対象の言語を条件に、対応するコードの略称を取得する。
java.util.List<java.lang.String>	getValues(java.lang.String codeId) コードIDに紐付く全てのコード値を取得する。
java.util.List<java.lang.String>	getValues(java.lang.String codeId, java.util.Locale locale) コードIDと言語を条件に、対応するコード値を全て取得する。
java.util.List<java.lang.String>	getValues(java.lang.String codeId, java.lang.String pattern) コードID、パターンを条件に、対応するコード値を全て取得する。
java.util.List<java.lang.String>	getValues(java.lang.String codeId, java.lang.String pattern, java.util.Locale locale) コードID、パターン、言語を条件に、対応するコード値を全て取得する。
void	setCodeDefinitionCache(StaticDataCache<Code> codeDefinitionCache) Codeのキャッシュをセットする。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

BasicCodeManager

public BasicCodeManager()

メソッドの詳細

setCodeDefinitionCache

public void setCodeDefinitionCache(StaticDataCache<Code> codeDefinitionCache)

Codeのキャッシュをセットする。
Codeのキャッシュは、コード値をキーとしてCodeインタフェースを実装したクラスが取得できなければならない。

パラメータ:

codeDefinitionCache - Codeのキャッシュ

contains

public boolean contains(java.lang.String codeId,
                        java.lang.String value)

コードID、コード値を条件に、そのコード値を持ったコードが存在するかチェックする。
コードIDが存在する上で、そのコード値に対応するコードが存在する場合はtrueを、 存在しない場合はfalseを返却する。

定義:

contains インタフェース内 CodeManager

パラメータ:

codeId - コードID

value - コード値

戻り値:

コード値がコードに存在する場合 true

contains

public boolean contains(java.lang.String codeId,
                        java.lang.String pattern,
                        java.lang.String value)

コードID、使用するパターンのカラム名、コード値を条件に、 そのコード値に対応するコードが、パターンに存在するかチェックする。
コードID、パターンが存在する上で、 そのコード値に対応するコードがパターン内に存在する場合にはtrueを、存在しない場合にはfalseを返却する。

定義:

contains インタフェース内 CodeManager

パラメータ:

codeId - コードID

pattern - 使用するパターンのカラム名（大文字・小文字を区別せずに使用する）

value - コード値

戻り値:

コード値がコードに存在する場合 true

getName

public java.lang.String getName(java.lang.String codeId,
                                java.lang.String value)

コードID、コード値を条件に、対応するコード名称を取得する。
取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。

定義:

getName インタフェース内 CodeManager

パラメータ:

codeId - コードID

value - コード値

戻り値:

対応するコード名称

getName

public java.lang.String getName(java.lang.String codeId,
                                java.lang.String value,
                                java.util.Locale locale)

コードID、コード値、取得対象の言語を条件に、対応するコード名称を取得する。

定義:

getName インタフェース内 CodeManager

パラメータ:

codeId - コードID

value - コード値

locale - 取得対象の言語

戻り値:

対応するコード名称

getShortName

public java.lang.String getShortName(java.lang.String codeId,
                                     java.lang.String value)

コードID、コード値を条件に、対応するコードの略称を取得する。
取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。

定義:

getShortName インタフェース内 CodeManager

パラメータ:

codeId - コードID

value - コード値

戻り値:

対応するコードの略称

getShortName

public java.lang.String getShortName(java.lang.String codeId,
                                     java.lang.String value,
                                     java.util.Locale locale)

コードID、コード値、取得対象の言語を条件に、対応するコードの略称を取得する。

定義:

getShortName インタフェース内 CodeManager

パラメータ:

codeId - コードID

value - コード値

locale - 取得対象の言語

戻り値:

対応するコードの略称

getOptionalName

public java.lang.String getOptionalName(java.lang.String codeId,
                                        java.lang.String value,
                                        java.lang.String optionColumnName)

コードID、コード値、取得するオプション名称のカラム名を条件に、 対応するコードのオプション名称を取得する。
取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。

定義:

getOptionalName インタフェース内 CodeManager

パラメータ:

codeId - コードID

value - コード値

optionColumnName - 取得するオプション名称のカラム名（大文字・小文字を区別せずに使用する）

戻り値:

対応するオプション名称

getOptionalName

public java.lang.String getOptionalName(java.lang.String codeId,
                                        java.lang.String value,
                                        java.lang.String optionColumnName,
                                        java.util.Locale locale)

コードID、コード値、取得するオプション名称のカラム名、言語を条件に、 対応するコードのオプション名称を取得する。
取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。

定義:

getOptionalName インタフェース内 CodeManager

パラメータ:

codeId - コードID

value - コード値

optionColumnName - 取得するオプション名称のカラム名（大文字・小文字を区別せずに使用する）

locale - 言語

戻り値:

対応するコードのオプション名称

getValues

public java.util.List<java.lang.String> getValues(java.lang.String codeId)

コードIDに紐付く全てのコード値を取得する。
取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。

返却値は、あらかじめ言語ごとに定義されたソート順に従い、並び替えを行う。

定義:

getValues インタフェース内 CodeManager

パラメータ:

codeId - コードID

戻り値:

コードIDに紐付く全てのコード値

getValues

public java.util.List<java.lang.String> getValues(java.lang.String codeId,
                                                  java.lang.String pattern)

コードID、パターンを条件に、対応するコード値を全て取得する。
取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。 返却値は、あらかじめ言語ごとに定義されたソート順に従い、並び替えを行う。

定義:

getValues インタフェース内 CodeManager

パラメータ:

codeId - コードID

pattern - 使用するパターンのカラム名（大文字・小文字を区別せずに使用する）

戻り値:

コードIDとパターンに紐付くコード値

getValues

public java.util.List<java.lang.String> getValues(java.lang.String codeId,
                                                  java.util.Locale locale)

コードIDと言語を条件に、対応するコード値を全て取得する。

返却値は、あらかじめ言語ごとに定義されたソート順に従い、並び替えを行う。

定義:

getValues インタフェース内 CodeManager

パラメータ:

codeId - コードID

locale - 言語

戻り値:

コードIDに紐付く全てのコード値

getValues

public java.util.List<java.lang.String> getValues(java.lang.String codeId,
                                                  java.lang.String pattern,
                                                  java.util.Locale locale)

コードID、パターン、言語を条件に、対応するコード値を全て取得する。

返却値は、あらかじめ言語ごとに定義されたソート順に従い、並び替えを行う。

定義:

getValues インタフェース内 CodeManager

パラメータ:

codeId - コードID

pattern - 使用するパターンのカラム名（大文字・小文字を区別せずに使用する）

locale - 言語

戻り値:

コードIDとパターンに紐付くコード値