Package nablarch.common.code

Class BasicCodeManager

java.lang.Object
nablarch.common.code.BasicCodeManager
All Implemented Interfaces:
CodeManager
public class BasicCodeManager extends Object implements CodeManager
CodeManagerの基本実装クラス。
Author:
Koichi Asano

  • Constructor Summary

    Constructors
    Constructor
    Description
    BasicCodeManager()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contains(String codeId, String value)
    コードID、コード値を条件に、そのコード値を持ったコードが存在するかチェックする。
    コードIDが存在する上で、そのコード値に対応するコードが存在する場合はtrueを、 存在しない場合はfalseを返却する。
    boolean
    contains(String codeId, String pattern, String value)
    コードID、使用するパターンのカラム名、コード値を条件に、 そのコード値に対応するコードが、パターンに存在するかチェックする。
    コードID、パターンが存在する上で、 そのコード値に対応するコードがパターン内に存在する場合にはtrueを、存在しない場合にはfalseを返却する。
    String
    getName(String codeId, String value)
    コードID、コード値を条件に、対応するコード名称を取得する。
    取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。
    String
    getName(String codeId, String value, Locale locale)
    コードID、コード値、取得対象の言語を条件に、対応するコード名称を取得する。
    String
    getOptionalName(String codeId, String value, String optionColumnName)
    コードID、コード値、取得するオプション名称のカラム名を条件に、 対応するコードのオプション名称を取得する。
    取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。
    String
    getOptionalName(String codeId, String value, String optionColumnName, Locale locale)
    コードID、コード値、取得するオプション名称のカラム名、言語を条件に、 対応するコードのオプション名称を取得する。
    取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。
    String
    getShortName(String codeId, String value)
    コードID、コード値を条件に、対応するコードの略称を取得する。
    取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。
    String
    getShortName(String codeId, String value, Locale locale)
    コードID、コード値、取得対象の言語を条件に、対応するコードの略称を取得する。
    List<String>
    getValues(String codeId)
    コードIDに紐付く全てのコード値を取得する。
    取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。
    List<String>
    getValues(String codeId, String pattern)
    コードID、パターンを条件に、対応するコード値を全て取得する。
    取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。 返却値は、あらかじめ言語ごとに定義されたソート順に従い、並び替えを行う。
    List<String>
    getValues(String codeId, String pattern, Locale locale)
    コードID、パターン、言語を条件に、対応するコード値を全て取得する。
    List<String>
    getValues(String codeId, Locale locale)
    コードIDと言語を条件に、対応するコード値を全て取得する。
    void
    setCodeDefinitionCache(StaticDataCache<Code> codeDefinitionCache)
    Codeのキャッシュをセットする。
    Codeのキャッシュは、コード値をキーとしてCodeインタフェースを実装したクラスが取得できなければならない。

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • BasicCodeManager

      public BasicCodeManager()

  • Method Details

    • setCodeDefinitionCache

      public void setCodeDefinitionCache(StaticDataCache<Code> codeDefinitionCache)
      Codeのキャッシュをセットする。
      Codeのキャッシュは、コード値をキーとしてCodeインタフェースを実装したクラスが取得できなければならない。
      Parameters:
      codeDefinitionCache - Codeのキャッシュ

    • contains

      public boolean contains(String codeId, String value)
      コードID、コード値を条件に、そのコード値を持ったコードが存在するかチェックする。
      コードIDが存在する上で、そのコード値に対応するコードが存在する場合はtrueを、 存在しない場合はfalseを返却する。
      Specified by:
      contains in interface CodeManager
      Parameters:
      codeId - コードID
      value - コード値
      Returns:
      コード値がコードに存在する場合 true

    • contains

      public boolean contains(String codeId, String pattern, String value)
      コードID、使用するパターンのカラム名、コード値を条件に、 そのコード値に対応するコードが、パターンに存在するかチェックする。
      コードID、パターンが存在する上で、 そのコード値に対応するコードがパターン内に存在する場合にはtrueを、存在しない場合にはfalseを返却する。
      Specified by:
      contains in interface CodeManager
      Parameters:
      codeId - コードID
      pattern - 使用するパターンのカラム名（大文字・小文字を区別せずに使用する）
      value - コード値
      Returns:
      コード値がコードに存在する場合 true

    • getName

      public String getName(String codeId, String value)
      コードID、コード値を条件に、対応するコード名称を取得する。
      取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。
      Specified by:
      getName in interface CodeManager
      Parameters:
      codeId - コードID
      value - コード値
      Returns:
      対応するコード名称

    • getName

      public String getName(String codeId, String value, Locale locale)
      コードID、コード値、取得対象の言語を条件に、対応するコード名称を取得する。
      Specified by:
      getName in interface CodeManager
      Parameters:
      codeId - コードID
      value - コード値
      locale - 取得対象の言語
      Returns:
      対応するコード名称

    • getShortName

      public String getShortName(String codeId, String value)
      コードID、コード値を条件に、対応するコードの略称を取得する。
      取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。
      Specified by:
      getShortName in interface CodeManager
      Parameters:
      codeId - コードID
      value - コード値
      Returns:
      対応するコードの略称

    • getShortName

      public String getShortName(String codeId, String value, Locale locale)
      コードID、コード値、取得対象の言語を条件に、対応するコードの略称を取得する。
      Specified by:
      getShortName in interface CodeManager
      Parameters:
      codeId - コードID
      value - コード値
      locale - 取得対象の言語
      Returns:
      対応するコードの略称

    • getOptionalName

      public String getOptionalName(String codeId, String value, String optionColumnName)
      コードID、コード値、取得するオプション名称のカラム名を条件に、 対応するコードのオプション名称を取得する。
      取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。
      Specified by:
      getOptionalName in interface CodeManager
      Parameters:
      codeId - コードID
      value - コード値
      optionColumnName - 取得するオプション名称のカラム名（大文字・小文字を区別せずに使用する）
      Returns:
      対応するオプション名称

    • getOptionalName

      public String getOptionalName(String codeId, String value, String optionColumnName, Locale locale)
      コードID、コード値、取得するオプション名称のカラム名、言語を条件に、 対応するコードのオプション名称を取得する。
      取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。
      Specified by:
      getOptionalName in interface CodeManager
      Parameters:
      codeId - コードID
      value - コード値
      optionColumnName - 取得するオプション名称のカラム名（大文字・小文字を区別せずに使用する）
      locale - 言語
      Returns:
      対応するコードのオプション名称

    • getValues

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

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

      Specified by:
      getValues in interface CodeManager
      Parameters:
      codeId - コードID
      Returns:
      コードIDに紐付く全てのコード値

    • getValues

      public List<String> getValues(String codeId, String pattern)
      コードID、パターンを条件に、対応するコード値を全て取得する。
      取得対象言語は、ThreadContextでデフォルトとして指定された言語とする。 ThreadContextからデフォルト言語を取得できなかった場合、 デフォルトロケールから言語を取得する。 返却値は、あらかじめ言語ごとに定義されたソート順に従い、並び替えを行う。
      Specified by:
      getValues in interface CodeManager
      Parameters:
      codeId - コードID
      pattern - 使用するパターンのカラム名（大文字・小文字を区別せずに使用する）
      Returns:
      コードIDとパターンに紐付くコード値

    • getValues

      public List<String> getValues(String codeId, Locale locale)
      コードIDと言語を条件に、対応するコード値を全て取得する。

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

      Specified by:
      getValues in interface CodeManager
      Parameters:
      codeId - コードID
      locale - 言語
      Returns:
      コードIDに紐付く全てのコード値

    • getValues

      public List<String> getValues(String codeId, String pattern, Locale locale)
      コードID、パターン、言語を条件に、対応するコード値を全て取得する。

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

      Specified by:
      getValues in interface CodeManager
      Parameters:
      codeId - コードID
      pattern - 使用するパターンのカラム名（大文字・小文字を区別せずに使用する）
      locale - 言語
      Returns:
      コードIDとパターンに紐付くコード値