Package nablarch.common.code

Class CodeUtil

java.lang.Object
nablarch.common.code.CodeUtil
@Published public final class CodeUtil extends Object
コードの値、及び名称の取り扱いのために使用するユーティリティ。

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

Author:
Koichi Asano
See Also:

  • Method Details

    • getName

      public static String getName(String codeId, String value) throws IllegalArgumentException
      コード値に対応するコード名称を取得する。

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

      Parameters:
      codeId - コードID
      value - コード値
      Returns:
      コード値に対応するコード名称
      Throws:
      IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

    • getName

      public static String getName(String codeId, String value, Locale locale) throws IllegalArgumentException
      コード値、言語に対応するコード名称を取得する。
      Parameters:
      codeId - コードID
      value - コード値
      locale - 言語
      Returns:
      コード値に対応するコード名称
      Throws:
      IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

    • getShortName

      public static String getShortName(String codeId, String value) throws IllegalArgumentException
      コード値に対応するコードの略称を取得する。

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

      Parameters:
      codeId - コードID
      value - コード値
      Returns:
      コード値に対応するコードの略称
      Throws:
      IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

    • getShortName

      public static String getShortName(String codeId, String value, Locale locale) throws IllegalArgumentException
      コード値、言語に対応するコードの略称を取得する。
      Parameters:
      codeId - コードID
      value - コード値
      locale - 言語
      Returns:
      コード値に対応するコードの略称
      Throws:
      IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

    • getOptionalName

      public static String getOptionalName(String codeId, String value, String optionColumnName) throws IllegalArgumentException
      コード値に対応するコードのオプション名称(名称、略称の他に使用する補助名称)を取得する。

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

      Parameters:
      codeId - コードID
      value - コード値
      optionColumnName - 取得するオプション名称のカラム名（大文字・小文字を区別せずに使用する）
      Returns:
      コード値に対応するコードのオプション名称
      Throws:
      IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

    • getOptionalName

      public static String getOptionalName(String codeId, String value, String optionColumnName, Locale locale) throws IllegalArgumentException
      コード値、言語に対応するコードのオプション名称を取得する。

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

      Parameters:
      codeId - コードID
      value - コード値
      optionColumnName - 取得するオプション名称のカラム名（大文字・小文字を区別せずに使用する）
      locale - 言語
      Returns:
      コード値に対応するコードのオプション名称
      Throws:
      IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

    • getValues

      public static List<String> getValues(String codeId) throws IllegalArgumentException
      コードIDに紐付く全てのコード値を取得する。

      コード値の順序は、コード名称テーブルのソート順カラムに、言語ごとに設定された値で決定される。 返却値は、言語ごとに定義されたソート順に従い、並び替えが行われる。
      Parameters:
      codeId - コードID
      Returns:
      コードIDに紐付く全てのコード値
      Throws:
      IllegalArgumentException - 指定したコードIDが存在しないか、対象のコード値または言語に対応するデータが存在しない場合

    • getValues

      public static List<String> getValues(String codeId, String pattern) throws IllegalArgumentException
      コードIDとパターンに紐付くコード値を取得する。

      コード値の順序は、コード名称テーブルのソート順カラムに、言語ごとに設定された値で決定される。 返却値は、言語ごとに定義されたソート順に従い、並び替えが行われる。 対象の言語はThreadContextにて設定された言語となる。 ThreadContextで設定が行われていない場合は、デフォルトロケールの言語となる。
      Parameters:
      codeId - コードID
      pattern - 使用するパターンのカラム名（大文字・小文字を区別せずに使用する）
      Returns:
      コードIDとパターンに紐付くコード値
      Throws:
      IllegalArgumentException - 指定したコードIDが存在しないか、パターンまたは言語に対応するデータが存在しない場合

    • getValues

      public static List<String> getValues(String codeId, Locale locale) throws IllegalArgumentException
      コードIDに紐付く全てのコード値を取得する。

      コード値の順序は、コード名称テーブルのソート順カラムに、言語ごとに設定された値で決定される。 返却値は、言語ごとに定義されたソート順に従い、並び替えが行われる。
      Parameters:
      codeId - コードID
      locale - 言語
      Returns:
      コードIDに紐付く全てのコード値
      Throws:
      IllegalArgumentException - 指定したコードIDが存在しないか、コード値または言語に対応するデータが存在しない場合

    • getValues

      public static List<String> getValues(String codeId, String pattern, Locale locale) throws IllegalArgumentException
      コードIDとパターンに紐付くコード値を取得する。

      コード値の順序は、コード名称テーブルのソート順カラムに、言語ごとに設定された値で決定される。 返却値は、言語ごとに定義されたソート順に従い、並び替えが行われる。
      Parameters:
      codeId - コードID
      pattern - 使用するパターンのカラム名（大文字・小文字を区別せずに使用する）
      locale - 言語
      Returns:
      コードIDとパターンに紐付くコード値
      Throws:
      IllegalArgumentException - 指定したコードIDが存在しないか、パターンまたは言語に対応するデータが存在しない場合

    • contains

      public static boolean contains(String codeId, String value) throws IllegalArgumentException
      コード値がコードに存在するかチェックする。
      Parameters:
      codeId - コードID
      value - コード値
      Returns:
      コード値がコードに存在する場合 true
      Throws:
      IllegalArgumentException - 指定したコードIDが存在しない場合

    • contains

      public static boolean contains(String codeId, String pattern, String value) throws IllegalArgumentException
      コード値がパターンに存在するかチェックする。
      Parameters:
      codeId - コードID
      pattern - 使用するパターンのカラム名（大文字・小文字を区別せずに使用する）
      value - コード値
      Returns:
      コード値がコードに存在する場合 true
      Throws:
      IllegalArgumentException - 指定したコードIDが存在しない場合か、指定したパターンが存在しない場合