nablarch.common.code

クラス CodeUtil

java.lang.Object

nablarch.common.code.CodeUtil

@Published
public final class CodeUtil
extends java.lang.Object

コードの値、及び名称の取り扱いのために使用するユーティリティ。

コードの値、及び名称の取得処理はCodeManagerによって提供される。 CodeManagerの実装は、SystemRepositoryからコンポーネント名で取得される。

関連項目:

CodeManager

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static boolean	contains(java.lang.String codeId, java.lang.String value) コード値がコードに存在するかチェックする。
static boolean	contains(java.lang.String codeId, java.lang.String pattern, java.lang.String value) コード値がパターンに存在するかチェックする。
static java.lang.String	getName(java.lang.String codeId, java.lang.String value) コード値に対応するコード名称を取得する。
static java.lang.String	getName(java.lang.String codeId, java.lang.String value, java.util.Locale locale) コード値、言語に対応するコード名称を取得する。
static java.lang.String	getOptionalName(java.lang.String codeId, java.lang.String value, java.lang.String optionColumnName) コード値に対応するコードのオプション名称(名称、略称の他に使用する補助名称)を取得する。
static java.lang.String	getOptionalName(java.lang.String codeId, java.lang.String value, java.lang.String optionColumnName, java.util.Locale locale) コード値、言語に対応するコードのオプション名称を取得する。
static java.lang.String	getShortName(java.lang.String codeId, java.lang.String value) コード値に対応するコードの略称を取得する。
static java.lang.String	getShortName(java.lang.String codeId, java.lang.String value, java.util.Locale locale) コード値、言語に対応するコードの略称を取得する。
static java.util.List<java.lang.String>	getValues(java.lang.String codeId) コードIDに紐付く全てのコード値を取得する。
static java.util.List<java.lang.String>	getValues(java.lang.String codeId, java.util.Locale locale) コードIDに紐付く全てのコード値を取得する。
static java.util.List<java.lang.String>	getValues(java.lang.String codeId, java.lang.String pattern) コードIDとパターンに紐付くコード値を取得する。
static java.util.List<java.lang.String>	getValues(java.lang.String codeId, java.lang.String pattern, java.util.Locale locale) コードIDとパターンに紐付くコード値を取得する。

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

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

メソッドの詳細

getName

public static java.lang.String getName(java.lang.String codeId,
                                       java.lang.String value)
                                throws java.lang.IllegalArgumentException

コード値に対応するコード名称を取得する。

対象の言語はThreadContextで設定された言語となる。 ThreadContextで設定が行われていない場合は、デフォルトロケールの言語となる。

パラメータ:

codeId - コードID

value - コード値

戻り値:

コード値に対応するコード名称

例外:

java.lang.IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

getName

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

コード値、言語に対応するコード名称を取得する。

パラメータ:

codeId - コードID

value - コード値

locale - 言語

戻り値:

コード値に対応するコード名称

例外:

java.lang.IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

getShortName

public static java.lang.String getShortName(java.lang.String codeId,
                                            java.lang.String value)
                                     throws java.lang.IllegalArgumentException

コード値に対応するコードの略称を取得する。

対象の言語はThreadContextにて設定された言語となる。 ThreadContextで設定が行われていない場合は、デフォルトロケールの言語となる。

パラメータ:

codeId - コードID

value - コード値

戻り値:

コード値に対応するコードの略称

例外:

java.lang.IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

getShortName

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

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

パラメータ:

codeId - コードID

value - コード値

locale - 言語

戻り値:

コード値に対応するコードの略称

例外:

java.lang.IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

getOptionalName

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

コード値に対応するコードのオプション名称(名称、略称の他に使用する補助名称)を取得する。

対象の言語はThreadContextにて設定された言語となる。 ThreadContextで設定が行われていない場合は、デフォルトロケールの言語となる。

パラメータ:

codeId - コードID

value - コード値

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

戻り値:

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

例外:

java.lang.IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

getOptionalName

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

コード値、言語に対応するコードのオプション名称を取得する。

対象の言語は引数の言語によって決定される。

パラメータ:

codeId - コードID

value - コード値

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

locale - 言語

戻り値:

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

例外:

java.lang.IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

getValues

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

コードIDに紐付く全てのコード値を取得する。

コード値の順序は、コード名称テーブルのソート順カラムに、言語ごとに設定された値で決定される。 返却値は、言語ごとに定義されたソート順に従い、並び替えが行われる。

パラメータ:

codeId - コードID

戻り値:

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

例外:

java.lang.IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

getValues

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

コードIDとパターンに紐付くコード値を取得する。

コード値の順序は、コード名称テーブルのソート順カラムに、言語ごとに設定された値で決定される。 返却値は、言語ごとに定義されたソート順に従い、並び替えが行われる。 対象の言語はThreadContextにて設定された言語となる。 ThreadContextで設定が行われていない場合は、デフォルトロケールの言語となる。

パラメータ:

codeId - コードID

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

戻り値:

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

例外:

java.lang.IllegalArgumentException - 指定したコードIDが存在しないか、パターンまたは言語に対応するデータが存在しない場合

getValues

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

コードIDに紐付く全てのコード値を取得する。

コード値の順序は、コード名称テーブルのソート順カラムに、言語ごとに設定された値で決定される。 返却値は、言語ごとに定義されたソート順に従い、並び替えが行われる。

パラメータ:

codeId - コードID

locale - 言語

戻り値:

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

例外:

java.lang.IllegalArgumentException - 指定したコードIDが存在しないか、コード値または言語に対応するデータが存在しない場合

getValues

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

コードIDとパターンに紐付くコード値を取得する。

コード値の順序は、コード名称テーブルのソート順カラムに、言語ごとに設定された値で決定される。 返却値は、言語ごとに定義されたソート順に従い、並び替えが行われる。

パラメータ:

codeId - コードID

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

locale - 言語

戻り値:

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

例外:

java.lang.IllegalArgumentException - 指定したコードIDが存在しないか、パターンまたは言語に対応するデータが存在しない場合

contains

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

コード値がコードに存在するかチェックする。

パラメータ:

codeId - コードID

value - コード値

戻り値:

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

例外:

java.lang.IllegalArgumentException - 指定したコードIDが存在しない場合

contains

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

コード値がパターンに存在するかチェックする。

パラメータ:

codeId - コードID

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

value - コード値

戻り値:

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

例外:

java.lang.IllegalArgumentException - 指定したコードIDが存在しない場合か、指定したパターンが存在しない場合