uCosminexus Portal Framework　ポートレット開発ガイド

[目次][用語][索引][前へ][次へ]

jp.co.hitachi.soft.portal.api.user.LocaleData

機能

カスタマイズ情報に保存されているユーザのロケール情報（言語およびタイムゾーン）を取得，設定するクラスです。

使用方法

ユーザの利用言語に応じたコンテンツを作成する場合に使用します。

注意事項

カスタマイズ情報が取得できない場合に，Webブラウザの設定値を取得する場合があります。しかし，このAPIからWebブラウザの設定を変更することはできません。

メソッドの一覧

戻り値のデータ型 メソッド 説明
static final String getLangType(HttpServletRequest req) ユーザが表示可能な言語の中で最も優先度の高い言語の識別子をISO言語コードに従った形式で取得します。
public static final Enumeration getLangTypes(HttpServletRequest req) ユーザが表示可能な言語のすべての識別子を取得します。
public static final String getLanguage(HttpServletRequest req) ユーザが表示可能な言語の中で最も優先度の高い言語の識別子を文字列表現で取得します。
static final String getTimeZone(HttpServletRequest req) カスタマイズ情報に設定されているタイムゾーンIDを取得します。
static final void setLangType(HttpServletRequest req,String langtype) カスタマイズ情報に言語IDを設定します。
static final void setTimeZone(HttpServletRequest req,String timezone) カスタマイズ情報にタイムゾーンIDを設定します。
public static final Locale getLocale(HttpServletRequest req) ユーザが表示可能な言語の中で最も優先度の高い言語に対応するロケールを取得します。
public static final Enumeration getLocales(HttpServletRequest req) ユーザが表示可能な言語に対応するロケールをすべて取得します。
public static final Enumeration getSupportLocales() uCosminexus Portal Frameworkがサポートしているすべての言語に対応するロケールを取得します。
public static final Enumeration getSupportLanguagesOrder() uCosminexus Portal Frameworkがサポートしているすべての言語の文字列表現を取得します。

メソッドの説明

getLangType

形式
public static final String getLangType(HttpServletRequest req)

機能
ユーザが表示可能な言語の中で最も優先度の高い言語の識別子をISO言語コードに従った形式で取得します。ユーザがカスタマイズ画面で特定の言語を選択している場合は，その言語の識別子を取得します。ユーザが特定の言語を選択していない場合は，ブラウザで設定されている言語の識別子の中で最も優先度が高いものを取得します。どちらも設定されていない場合は，uCosminexus Portal Frameworkのデフォルトの言語を取得します。言語の識別子は，ISO言語コード（RFC1766）に準拠しています。取得できる言語ID値を次の表に示します。
ユーザがカスタマイズ情報に設定している言語設定 ユーザがWebブラウザに設定している言語設定
日本語（ja） 英語（en） その他の言語
日本語 ja ja ja
英語 en en en
設定なし※1 ja en en※2

注※1　ユーザがポータル画面の利用者用レイアウトカスタマイズ画面で言語を設定していない場合，およびウェルカム画面などのログイン前の画面でこのメソッドを発行した場合です。

注※2　プロパティで変更できます。


パラメタ
req - サーブレットリクエスト（null以外）

戻り値
ユーザが表示可能な言語の中で最も優先度が高い言語のISO言語コード（null以外）

例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合

getLangTypes

形式
public static final Enumeration getLangTypes(HttpServletRequest req)

機能
ユーザが表示可能な言語を次のルールで決定し，該当する言語の配列を取得します。
  • ユーザがカスタマイズ画面で特定の言語を選択している場合は，その言語の識別子一つだけが格納された配列を取得します。
  • ユーザが特定の言語を選択していない場合は，ブラウザで設定されている言語の識別子が優先度順に格納された配列を取得します。
  • どちらも設定が行われていない場合は，uCosminexus Portal Frameworkのデフォルトの言語の識別子が格納された配列を取得します。

パラメタ
req - サーブレットリクエスト（null以外）

戻り値
ユーザが表示可能な言語（String型，ISO言語コード）が優先度順に格納された配列（Enumeration型）

例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合

getLanguage

形式
public static final String getLanguage(HttpServletRequest req)

機能
ユーザが表示可能な言語の中で最も優先度の高い言語の識別子を文字列表現で取得します。ユーザがカスタマイズ画面で特定の言語を選択している場合は，その言語の識別子を取得します。ユーザが特定の言語を選択していない場合は，ブラウザで設定されている言語の識別子の中で最も優先度が高いものを取得します。どちらも設定されていない場合は，uCosminexus Portal Frameworkのデフォルトの言語を取得します。

パラメタ
req - サーブレットリクエスト（null以外）

戻り値
ユーザが表示可能な言語の中で最も優先度が高い言語の文字列表現

例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合

getTimeZone

形式
public static final String getTimeZone(HttpServletRequest req)

機能
ユーザがカスタマイズ情報に設定したタイムゾーンIDを取得します。IDは，J2SE1.4の定めたカスタムタイムゾーンIDに準拠しています。ユーザが何も設定していない場合は，ポータルサーバのデフォルト値が返却されます。

パラメタ
req - サーブレットリクエスト（null以外）

戻り値
タイムゾーンID

例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合

setLangType

形式
public static final void setLangType(HttpServletRequest req,
                                     String langtype)

機能
ユーザが使用する言語のISO言語コードを設定します。設定された言語コードがサポート外の場合，例外（IllegalArgumentException）が発生します。

パラメタ
req - サーブレットリクエスト（null以外）
langtype - ISO言語コード（null以外）

戻り値
なし

例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合

setTimeZone

形式
public static final void setTimeZone(HttpServletRequest req,
                                     String timezone)

機能
ユーザのタイムゾーン（カスタムタイムゾーンID）を設定します。無効なIDを指定した場合，例外（IllegalArgumentException）が発生します。

パラメタ
req - サーブレットリクエスト（null以外）
timezone - カスタムタイムゾーンID（null以外）

戻り値
なし

例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合

getLocale

形式
public static final Locale getLocale(HttpServletRequest req)

機能
ユーザが表示可能な言語の中で最も優先度の高い言語に対応するロケールを取得します。ユーザがカスタマイズ画面で特定の言語を選択している場合は，その言語に対応するロケールを取得します。ユーザが特定の言語を選択していない場合は，ブラウザで設定されている言語の中で最も優先度が高いものに対応するロケールを取得します。

パラメタ
req - サーブレットリクエスト（null以外）

戻り値
ユーザが表示可能な言語の中で最も優先度の高い言語に対応するロケール

例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合

getLocales

形式
public static final Enumeration getLocales(HttpServletRequest req)

機能
ユーザが表示可能なロケールを次のルールで決定し，該当するロケールの配列を取得します。
  • ユーザがカスタマイズ画面で特定の言語を選択している場合は，その言語に対応するロケール一つだけが格納された配列を取得します。
  • ユーザが特定の言語を選択していない場合は，ブラウザで設定されている言語に対応するロケールが優先度順に格納された配列を取得します。
  • どちらも設定が行われていない場合は，uCosminexus Portal Frameworkのデフォルトの言語に対応するロケールが格納された配列を取得します。

パラメタ
req - サーブレットリクエスト（null以外）

戻り値
ユーザが表示可能なロケール（java.util.Locale型）が優先度順に格納された配列（Enumeration型）

例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合

getSupportLocales

形式
public static final Enumeration getSupportLocales()

機能
uCosminexus Portal Frameworkがサポートしているすべての言語に対応するロケールを優先度順に取得します。優先度は，uCosminexus Portal Frameworkのjp.co.hitachi.soft.portal.i18n.supportsプロパティに定義された順になります。

パラメタ
なし

戻り値
uCosminexus Portal Frameworkがサポートしているすべての言語に対応するロケール（java.util.Locale型）が優先度順に格納された配列

例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合

getSupportLanguagesOrder

形式
public static final Enumeration getSupportLanguagesOrder()

機能
uCosminexus Portal Frameworkがサポートしているすべての言語の文字列表現を優先度順に取得します。優先度は，uCosminexus Portal Frameworkのjp.co.hitachi.soft.portal.i18n.supportsプロパティに定義された順になります。

パラメタ
なし

戻り値
uCosminexus Portal Frameworkがサポートしているすべての言語の文字列表現（String型）が優先度順に格納された配列

例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合

[目次][前へ][次へ]

[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2009, 2013, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2009, 2013, Hitachi INS Software, Ltd.