5.14. コードリスト¶

Caution

本バージョンの内容は既に古くなっています。最新のガイドラインはこちらからご参照ください。

Overview
How to use
How to extend
Appendix
- SimpleI18nCodeListのコードリスト設定方法
  - 行単位でLocal毎のjava.util.Map(key=コード値, value=ラベル)を設定する
  - 列単位でコード値毎のjava.util.Map(key=Locale, value=ラベル)を設定する

5.14.1. Overview ¶

コードリストとは、「コード値(value)とその表示名(label)」の集合である。

画面のセレクトボックスなどコード値を画面で表示する際のラベルへのマッピング表として利用される。

共通ライブラリでは、

xmlファイルやDBに定義されたコードリストをアプリケーション起動時に読み込みキャッシュする機能
JSPやJavaクラスからコードリストを参照する機能
コードリストを用いて入力チェックするを行う機能

を提供している。

また、応用的な使い方として、

コードリストの国際化対応
キャッシュされたコードリストのリロード

もサポートしている。

Note

標準でリロードが可能なのは、DBに定義されたコードリストを使用する場合のみである。

共通ライブラリでは、以下4種類のコードリスト実装を提供している。

**コードリスト種類一覧**¶
種類	内容	Reloadable
`org.terasoluna.gfw.common.codelist.SimpleMapCodeList`	xmlファイルに直接記述した内容を使用する。	NO
`org.terasoluna.gfw.common.codelist.NumberRangeCodeList`	数値の範囲のリストを作成する際に使用する。	NO
`org.terasoluna.gfw.common.codelist.JdbcCodeList`	DBから対象のコードをSQLで取得して使用する。	YES
`org.terasoluna.gfw.common.codelist.i18n.SimpleI18nCodeList`	java.util.Localeに応じたコードリストを使用する。	NO

上記コードリストのインターフェースについて、共通ライブラリに org.terasoluna.gfw.common.codelist.CodeList を提供している。

共通ライブラリで提供しているコードリストのクラス図構成を以下に示す。

Picture - Image of codelist class diagram

現時点で SimpleI18nCodeList はreloadableに対応していない。 SimpleI18nCodeList が参照している JdbcCodeList (reloadableなCodeList)をリロードしても、 SimpleI18nCodeList には反映されないことに注意。もし、reloadableに対応したい場合は独自実装する必要がある。実装方法については、コードリストを独自カスタマイズする方法を参照されたい。

5.14.2.5.2. JSPでのコードリスト使用 ¶

基本的な設定は、前述した JSPでのコードリスト使用と同様のため、説明は省略する。

bean定義ファイル

spring-mvc.xml

<mvc:interceptors>
  <mvc:interceptor>
    <mvc:mapping path="/**" />
    <bean
      class="org.terasoluna.gfw.web.codelist.CodeListInterceptor">
      <property name="codeListIdPattern" value="CL_.+" />
      <property name="fallbackTo" value="en" />  <!-- (1) -->
    </bean>
  </mvc:interceptor>

  <!-- omitted -->

</mvc:interceptors>

項番	説明
(1)	リクエストのロケールがコードリスト定義されていなかった場合、 fallbackToプロパティに設定されたロケールでコードリストを取得する。 fallbackToプロパティが設定されていない場合、JVMのデフォルトロケールがfallbackToプロパティとして使用される。 fallbackToプロパティに設定されたロケールでも、コードリストが取得されない場合、WARNログを出力し、空のMapを返却する。

jspの実装例

<form:select path="basePrice" items="${CL_I18N_PRICE}" />

出力HTML lang=en

<select id="basePrice" name="basePrice">
  <option value="0">unlimited</option>
  <option value="1">Less than $10,000</option>
  <option value="2">Less than $20,000</option>
  <option value="3">Less than $30,000</option>
  <option value="4">Less than $40,000</option>
  <option value="5">Less than $50,000</option>
</select>

出力HTML lang=ja

<select id="basePrice" name="basePrice">
  <option value="0">上限なし</option>
  <option value="1">10,000円以下</option>
  <option value="2">20,000円以下</option>
  <option value="3">30,000円以下</option>
  <option value="4">40,000円以下</option>
  <option value="5">50,000円以下</option>
</select>

出力画面 lang=en

出力画面 lang=ja

5.14.2.5.3. Javaクラスでのコードリスト使用 ¶

基本的な設定は、前述した Javaクラスでのコードリスト使用と同様のため、説明は省略する。

public class CodeListController {

    @Inject
    @Named("CL_I18N_PRICE")
    protected I18nCodeList priceCodeList;

    private String getPriceMessage(String targetPrice, Locale locale) {
         return priceCodeList.asMap(locale).get(targetPrice);  // (1)
    }

}

項番	説明
(1)	I18nCodeList#asMap(Locale)で対応したロケールのMapを取得することができる。

5.14.3. How to extend ¶

5.14.3.1. JdbcCodeListの読み込む件数が大きい場合 ¶

JdbcCodeListの読み込む件数が大きい(数百)場合、Webアプリの起動に時間が掛かる。
原因は、DB問い合わせ時に全件取得することがあり、DBからリストを取得する時間がかかってしまうためである。
(fetchSizeのデフォルト設定が、全件取得になっている場合がある。)

この問題は、fetchSizeを適切な値に指定することで解決できる。
fetchSizeを変更するには org.springframework.jdbc.core.JdbcTemplate のfetchSizeを設定する必要がある。
以下に実装例を示す。

bean定義ファイル

xxx-infra.xml

<bean id="jdbcTemplateForCodeList" class="org.springframework.jdbc.core.JdbcTemplate" > <!-- (1) -->
    <property name="dataSource" ref="dataSource" />
    <property name="fetchSize" value="1000" /> <!-- (2) -->
</bean>

<bean id="AbstractJdbcCodeList"
    class="org.terasoluna.gfw.common.codelist.JdbcCodeList" abstract="true"> <!-- (3) -->
    <property name="jdbcTemplate" ref="jdbcTemplateForCodeList" /> <!-- (4) -->
</bean>

<bean id="CL_AUTHORITIES" parent="AbstractJdbcCodeList" ><!-- (5) -->
    <property name="querySql"
        value="SELECT authority_id, authority_name FROM authority ORDER BY authority_id" />
    <property name="valueColumn" value="authority_id" />
    <property name="labelColumn" value="authority_name" />
</bean>

項番	説明
(1)	`org.springframework.jdbc.core.JdbcTemplate` クラスをbean定義する。独自にfetchSizeを設定するために必要となる。
(2)	fetchSizeを設定する。適切な値を設定すること。
(3)	JdbcCodeListの共通bean定義。他のJdbcCodeListの共通部分を設定している。そのため、基本JdbcCodeListのbean定義はこのbean定義を親クラスに設定する。 abstract属性をtrueにすることで、このbeanはインスタンス化されない。
(4)	(1)で設定したjdbcTemplateを設定。 fetchSizeを設定したJdbcTemplateを、JdbcCodeListに格納している。
(5)	JdbcCodeListのbean定義。 parent属性を(3)のbean定義を親クラスとして設定することで、fetchSizeを設定したJdbcCodeListが設定される。このbean定義では、クエリに関する設定のみを行い、必要なCodeList分作成する。

5.14.3.2. コードリストをリロードする場合 ¶

前述した共通ライブラリで提供しているコードリストは、アプリケーション起動時に読み込まれ、それ以降は、基本的に更新されない。
しかし、コードリストのマスタデータを更新した時、コードリストも更新したい場合がある。
例：JdbcCodeListを使用して、DBのマスタを変更した時にコードリストの更新を行う場合。

共通ライブラリでは、 org.terasoluna.gfw.common.codelist.ReloadableCodeList インタフェースを用意している。
上記インタフェースを実装したクラスは、refreshメソッドを実装しており、refreshメソッドを呼ぶことでコードリストの更新が可能となる。
JdbcCodeListは、ReloadableCodeListインターフェースを実装しているため、コードリストの更新ができる。

コードリストの更新方法としては、以下2点の方法がある。

Task Schedulerで実現する方法
Controller(Service)クラスでrefreshメソッドを呼び出す方法

本ガイドラインでは、Springから提供されているTask Schedulerを使用して、コードリストを定期的にリロードする方式を基本的に推奨する。

ただし、任意のタイミングでコードリストをリフレッシュする必要がある場合はControllerクラスでrefreshメソッドを呼び出す方法で実現すればよい。

Note

ReloadableCodeListインターフェースを実装しているコードリストについては、コードリスト種類一覧を参照されたい。

5.14.3.2.1. Task Schedulerで実現する方法 ¶

Task Schedulerの設定例について、以下に示す。

bean定義ファイル

xxx-codelist.xml

<task:scheduler id="taskScheduler" pool-size="10"/>  <!-- (1) -->

<task:scheduled-tasks scheduler="taskScheduler">  <!-- (2) -->
    <task:scheduled ref="CL_AUTHORITIES" method="refresh" cron="${cron.codelist.refreshTime}"/>  <!-- (3) -->
</task:scheduled-tasks>

<bean id="CL_AUTHORITIES" class="org.terasoluna.gfw.common.codelist.JdbcCodeList">
    <property name="dataSource" ref="dataSource" />
    <property name="querySql"
        value="SELECT authority_id, authority_name FROM authority ORDER BY authority_id" />
    <property name="valueColumn" value="authority_id" />
    <property name="labelColumn" value="authority_name" />
</bean>

項番	説明
(1)	`<task:scheduler>` の要素を定義する、pool-size属性にスレッドのプールサイズを指定する。 pool-size属性を指定しない場合、”1” が設定される。
(2)	`<task:scheduled-tasks>` の要素を定義し、scheduler属性に、 `<task:scheduler>` のIDを設定する。
(3)	`<task:scheduled>` 要素を定義する。method属性に、refreshメソッドを指定する。 cron属性に、`org.springframework.scheduling.support.CronSequenceGenerator` でサポートされた形式で記述すること。 cron属性は開発環境、商用環境など環境によってリロードするタイミングが変わることが想定されるため、プロパティファイルや、環境変数等から取得することを推奨する。 cron属性の設定例「秒分時月年曜日」で指定する。毎秒実行「* * * * * 」毎時実行「0 0 * * 」平日の9-17時の毎時実行「0 0 9-17 * MON-FRI」詳細はJavaDocを参照されたい。 http://static.springsource.org/spring/docs/3.2.x/javadoc-api/org/springframework/scheduling/support/CronSequenceGenerator.html

5.14.3.2.2. Controller(Service)クラスでrefreshメソッドを呼び出す方法 ¶

refreshメソッドを直接呼び出す場合について、

JdbcCodeListのrefreshメソッドをServiceクラスで呼び出す場合の実装例を、以下に示す。

bean定義ファイル

xxx-codelist.xml

<bean id="CL_AUTHORITIES" class="org.terasoluna.gfw.common.codelist.JdbcCodeList">
    <property name="dataSource" ref="dataSource" />
    <property name="querySql"
        value="SELECT authority_id, authority_name FROM authority ORDER BY authority_id" />
    <property name="valueColumn" value="authority_id" />
    <property name="labelColumn" value="authority_name" />
</bean>

Controllerクラス

@Controller
@RequestMapping(value = "codelist")
public class CodeListContoller {

    @Inject
    protected CodeListService codeListService; // (1)

    @RequestMapping(method = RequestMethod.GET, params = "refresh")
    public String refreshJdbcCodeList() {
        codeListService.refresh(); // (2)
        return "codelist/jdbcCodeList";
    }
}

項番	説明
(1)	ReloadableCodeListクラスのrefreshメソッドを実行するServiceクラスをインジェクションする。
(2)	ReloadableCodeListクラスのrefreshメソッドを実行するServiceクラスのrefreshメソッドを実行する。

Serviceクラス

以下は実装クラスのみ記述し、インターフェースクラスは省略。

@Service
public class CodeListServiceImpl implements CodeListService { // (1)

    @Inject
    @Named(value = "CL_AUTHORITIES") // (2)
    protected ReloadableCodeList codeListItem; // (3)

    @Override
    public void refresh() { // (4)
        codeListItem.refresh(); // (5)
    }
}

項番	説明
(1)	実装クラス `CodeListServiceImpl` は、インターフェース `CodeListService` を実装する。
(2)	コードリストをインジェクションするとき、 `@Named` で、該当するコードリストを指定する。 value属性に取得したいbeanのIDを指定すること。 Bean定義ファイルに定義されているbeanタグのID属性”CL_AUTHORITIES”のコードリストがインジェクションされる。
(3)	フィールドの型にReloadableCodeListインターフェースを定義すること。 (1)で取得したBeanはReloadableCodeListインターフェースを実装していること。
(4)	Serviceクラスで定義したrefreshメソッド。 Controllerクラスから呼び出されている。
(5)	ReloadableCodeListインターフェースを実装したコードリストのrefreshメソッド。 refreshメソッドを実行することで、コードリストが更新される。

5.14.3.3. コードリストを独自カスタマイズする方法 ¶

共通ライブラリで提供している4種類のコードリストで実現できないコードリストを作成したい場合、コードリストを独自にカスタマイズすることができる。

独自カスタマイズする場合、作成できるコードリストの種類と実装方法について、以下の表に示す。

項番	Reloadable	継承するクラス	実装箇所
(1)	不要	`org.terasoluna.gfw.common.codelist.AbstractCodeList`	`asMap` をオーバライド
(2)	必要	`org.terasoluna.gfw.common.codelist.AbstractReloadableCodeList`	`retrieveMap` をオーバライド

org.terasoluna.gfw.common.codelist.CodeList 、 org.terasoluna.gfw.common.codelist.ReloadableCodeList インターフェースを直接実装しても実現はできるが、共通ライブラリで提供されている抽象クラスを拡張することで、最低限の実装で済む。

以下に、独自カスタマイズの実例について示す。
例として、今年と来年の年のリストを作るコードリストについて説明する。
(例：今年が2013の場合、コードリストには、”2013、2014”の順で格納される。)

コードリストクラス

@Component("CL_YEAR") // (1)
public class DepYearCodeList extends AbstractCodeList { // (2)

    @Inject
    protected DateFactory dateFactory; // (3)

    @Override
    public Map<String, String> asMap() {  // (4)
        DateTime dateTime = dateFactory.newDateTime();
        DateTime nextYearDateTime = dateTime.plusYears(1);

        Map<String, String> depYearMap = new LinkedHashMap<String, String>();

        String thisYear = dateTime.toString("Y");
        String nextYear = nextYearDateTime.toString("Y");
        depYearMap.put(thisYear, thisYear);
        depYearMap.put(nextYear, nextYear);

        return Collections.unmodifiableMap(depYearMap);
    }
}

項番	説明
(1)	`@Component` で、コードリストをコンポーネント登録する。 Valueに `"CL_YEAR"` を指定することで、bean定義で設定したコードリストインターセプトによりコードリストをコンポーネント登録する。
(2)	`org.terasoluna.gfw.common.codelist.AbstractCodeList` を継承する。今年と来年の年のリストを作る時、動的にシステム日付から算出して作成しているため、リロードは不要。
(3)	システム日付のDateクラスを作成する `org.terasoluna.gfw.common.date.DateFactory` をインジェクトしている。 `DateFactory` を利用して今年と来年の年を取得することができる。事前に、bean定義ファイルにDataFactory実装クラスを設定する必要がある。
(4)	`asMap()` メソッドをオーバライドして、今年と来年の年のリストを作成する。作成したいコードリスト毎に実装が異なる。

jspの実装例

<form:select path="mostRecentYear" items="${CL_YEAR}" /> <!-- (1) -->

項番	説明
(1)	items属性にコンポーネント登録した `"CL_YEAR"` を `${}` プレースホルダーで指定することで、該当のコードリストを取得することができる。

出力HTML

<select id="mostRecentYear" name="mostRecentYear">
   <option value="2013">2013</option>
   <option value="2014">2014</option>
</select>

出力画面

Note

リロード可能であるCodeListを独自カスタマイズする場合、スレッドセーフになるように実装すること。

xxx-codelist.xml

<bean id="CL_I18N_PRICE"
    class="org.terasoluna.gfw.common.codelist.i18n.SimpleI18nCodeList">
    <property name="rows"> <!-- (1) -->
        <util:map>
            <entry key="en">
                <util:map>
                     <entry key="0" value="unlimited" />
                     <entry key="10000" value="Less than $10,000" />
                     <entry key="20000" value="Less than $20,000" />
                     <entry key="30000" value="Less than $30,000" />
                     <entry key="40000" value="Less than $40,000" />
                     <entry key="50000" value="Less than $50,000" />
                </util:map>
            </entry>
            <entry key="ja">
                <util:map>
                     <entry key="0" value="上限なし" />
                     <entry key="10000" value="10,000円以下" />
                     <entry key="20000" value="20,000円以下" />
                     <entry key="30000" value="30,000円以下" />
                     <entry key="40000" value="40,000円以下" />
                     <entry key="50000" value="50,000円以下" />
                </util:map>
            </entry>
        </util:map>
    </property>
</bean>

項番	説明
(1)	rowsプロパティに対して、”MapのMap”を設定する。外側のMapのkeyは`java.lang.Locale`である。内側のMapのkeyはコード値、valueはロケールに対応したラベルである。

5.14.4.1.2. 列単位でコード値毎の`java.util.Map`(key=Locale, value=ラベル)を設定する ¶

bean定義ファイル

xxx-codelist.xml

<bean id="CL_I18N_PRICE"
    class="org.terasoluna.gfw.common.codelist.i18n.SimpleI18nCodeList">
    <property name="columns"> <!-- (1) -->
        <util:map>
            <entry key="0">
                <util:map>
                    <entry key="en" value="unlimited" />
                    <entry key="ja" value="上限なし" />
                </util:map>
            </entry>
            <entry key="10000">
                <util:map>
                    <entry key="en" value="Less than $10,000" />
                    <entry key="ja" value="10,000円以下" />
                </util:map>
            </entry>
            <entry key="20000">
                <util:map>
                    <entry key="en" value="Less than $20,000" />
                    <entry key="ja" value="20,000円以下" />
                </util:map>
            </entry>
            <entry key="30000">
                <util:map>
                    <entry key="en" value="Less than $30,000" />
                    <entry key="ja" value="30,000円以下" />
                </util:map>
            </entry>
            <entry key="40000">
                <util:map>
                    <entry key="en" value="Less than $40,000" />
                    <entry key="ja" value="40,000円以下" />
                </util:map>
            </entry>
            <entry key="50000">
                <util:map>
                    <entry key="en" value="Less than $50,000" />
                    <entry key="ja" value="50,000円以下" />
                </util:map>
            </entry>
        </util:map>
    </property>
</bean>

項番	説明
(1)	columnsプロパティに対して、”MapのMap”を設定する。外側のMapのkeyはコード値である。内側のMapのkeyは`java.lang.Locale`、valueはロケールに対応したラベルである。

authority_id	authority_name
01	STAFF_MANAGEMENT
02	MASTER_MANAGEMENT
03	STOCK_MANAGEMENT
04	ORDER_MANAGEMENT
05	SHOW_SHOPPING_CENTER

Table Of Contents

Previous topic

Next topic

This Page

5.14. コードリスト¶

5.14.1. Overview ¶

5.14.2. How to use ¶

5.14.2.1. SimpleMapCodeListの使用方法 ¶

5.14.2.1.1. コードリスト設定例 ¶

5.14.2.1.2. JSPでのコードリスト使用 ¶

5.14.2.1.3. Javaクラスでのコードリスト使用 ¶

5.14.2.2. NumberRangeCodeListの使用方法 ¶

5.14.2.2.1. コードリスト設定例 ¶

5.14.2.2.2. JSPでのコードリスト使用 ¶

5.14.2.2.3. Javaクラスでのコードリスト使用 ¶

5.14.2.3. JdbcCodeListの使用方法 ¶

5.14.2.3.1. コードリスト設定例 ¶

5.14.2.3.2. JSPでのコードリスト使用 ¶

5.14.2.3.3. Javaクラスでのコードリスト使用 ¶

5.14.2.4. コードリストを用いたコード値の入力チェック ¶

5.14.2.4.1. @ExistInCodeList の設定例 ¶

5.14.2.5. SimpleI18nCodeListの使用方法 ¶

5.14.2.5.1. コードリスト設定例 ¶

5.14.2.5.2. JSPでのコードリスト使用 ¶

5.14.2.5.3. Javaクラスでのコードリスト使用 ¶

5.14.3. How to extend ¶

5.14.3.1. JdbcCodeListの読み込む件数が大きい場合 ¶

5.14.3.2. コードリストをリロードする場合 ¶

5.14.3.2.1. Task Schedulerで実現する方法 ¶

5.14.3.2.2. Controller(Service)クラスでrefreshメソッドを呼び出す方法 ¶

5.14.3.3. コードリストを独自カスタマイズする方法 ¶

5.14.4. Appendix ¶

5.14.4.1. SimpleI18nCodeListのコードリスト設定方法 ¶

5.14.4.1.1. 行単位でLocal毎の`java.util.Map`(key=コード値, value=ラベル)を設定する ¶

5.14.4.1.2. 列単位でコード値毎の`java.util.Map`(key=Locale, value=ラベル)を設定する ¶

項番	説明
(1)	SimpleMapCodeListクラスをbean定義する。 beanIDは、後述する `org.terasoluna.gfw.web.codelist.CodeListInterceptor` のIDパターンに合致する名称にすること。
(2)	Mapの Key、Valueを定義する。 map-class属性を省略した場合、 `java.util.LinkedHashMap` で登録されるため、上記例では、「名前と値」が、登録順にMapへ保持される。

項番	説明
(1)	適用対象のパスを設定する。
(2)	CodeListInterceptor クラスをbean定義する。
(3)	自動でリクエストスコープに設定するコードリストのbeanIDのパターンを設定する。パターンには `java.util.regex.Pattern` で使用する正規表現を設定すること。上記例では、idが”CL_XXX”形式で定義されているデータのみを対象とする。その場合、idが”CL_”で始まらないbean定義は取り込まれない。 “CL_”で定義したbeanIDは、リクエストスコープに設定されるため、JSPで使用可能となる。

項番	説明
(1)	セレクトボックスの先頭にダミーの値を設定する場合、valueに空文字を指定すること。
(2)	コードリストを定義したbeanIDを指定する。

項番	説明
(1)	beanIDが、”CL_ORDERSTATUS”であるコードリストをインジェクションする。
(2)	CodeList#asMapメソッドでコードリストを `java.util.Map` 形式で取得する。

項番	説明
(1)	NumberRangeCodeListをbean定義する。
(2)	範囲開始の値を指定する。省略した場合、”0”が設定される。
(3)	範囲終了の値を設定する。指定必須。
(4)	Mapに設定されるkeyのフォーマット形式を設定する。フォーマット形式は `java.lang.String.format` の形式が使用される。省略した場合、”%s”が設定される。
(5)	Mapに設定されるvalueのフォーマット形式を設定する。フォーマット形式は `java.lang.String.format` の形式が使用される。省略した場合、”%s”が設定される。
(6)	増加する値を設定する。省略した場合、”1”が設定される。

項番	説明
(1)	範囲開始の値を指定する。name属性”to”のvalue属性の値より大きい値を指定する。この指定によって、interval分減少した値を、To～Fromの範囲分のリストとして、降順に表示する。 intervalは設定していないため、デフォルトの値1が適用される。
(2)	範囲終了の値を設定する。本例では、2000を指定することにより、リストには2013～2000までの範囲で1ずつ減少して格納される。

項番	説明
(1)	JdbcCodeListクラスをbean定義する。
(2)	querySqlプロパティに取得するSQLを記述する。その際、必ず「ORDER BY」を指定し、順序を確定させること。「ORDER BY」を指定しないと、取得する度に順序が変わってしまう。
(3)	valueColumnプロパティに、MapのKeyに該当する値を設定する。この例ではauthority_idを設定している。
(4)	labelColumnプロパティに、MapのValueに該当する値を設定する。この例ではauthority_nameを設定している。

row=Locale,column=Code	0	10000	20000	30000	40000	50000
en	unlimited	Less than $10,000	Less than $20,000	Less than $30,000	Less than $40,000	Less than $50,000
ja	上限なし	10,000円以下	20,000円以下	30,000円以下	40,000円以下	50,000円以下

項番	説明
(1)	ロケールが”en”であるbean定義 `CL_PRICE_EN` について、コードリストクラスを `SimpleMapCodeList` で設定している。
(2)	ロケールが”ja”であるbean定義 `CL_PRICE_JA` について、コードリストクラスを `SimpleMapCodeList` で設定している。

locale	code	label
en	0	unlimited
en	10000	Less than $10,000
en	20000	Less than $20,000
en	30000	Less than $30,000
en	40000	Less than $40,000
en	50000	Less than $50,000
ja	0	上限なし
ja	10000	10,000円以下
ja	20000	20,000円以下
ja	30000	30,000円以下
ja	40000	40,000円以下
ja	50000	50,000円以下