B コンバータおよびバリデータ・メッセージのメッセージ・キー

この付録では、ADF Facesのコンバータおよびバリデータのすべてのメッセージ・キーおよびメッセージ・セッター・メソッドをリストします。

この章の内容は次のとおりです。

• ADF Facesのデフォルト・メッセージについて

• メッセージ・キーおよびセッター・メソッド

• コンバータおよびバリデータのメッセージ・キーおよびセッター・メソッド

ADF Facesのデフォルト・メッセージについて

ADF Facesでは、検証または変換が失敗したときに表示されるメッセージのデフォルト・テキストが用意されています。連動して、できるだけエラー・メッセージが表示されないようにするとともに、ユーザーが有効な値を入力できるようにします。

FacesMessageクラスでは、サマリー・メッセージと詳細メッセージの両方がサポートされます。規則は次のとおりです。

• サマリー・メッセージはメイン・キーに対して定義されます。キー値の形式は、classname.MSG_KEYです。

• 詳細メッセージの形式は、classname.MSG_KEY_detailです。

簡単に言うと、詳細メッセージをオーバーライドするには、適切なクラスのセッター・メソッドを使用するか、必要なメッセージ・キーを使用してリソース・バンドルに置き換えるメッセージを入力します。

メッセージ文字列をインスタンスごとに変更するかわりに、メッセージ文字列をグローバルにオーバーライドすることもできます。カスタム文字列がすべてのインスタンスで使用可能になるよう、メッセージ・バンドルを使用します。コンバータおよびバリデータのデフォルトのエラー・メッセージをグローバルにオーバーライドする方法の詳細は、「コンポーネントの全インスタンスのバリデータおよびコンバータのカスタム・メッセージの定義方法」を参照してください。

ユーザーが入力した値やメッセージ用のコンポーネントのラベルなどの関連する詳細の指定に、詳細メッセージではプレースホルダが使用されます。プレースホルダ識別子の一般的な順序は次のとおりです。

• コンポーネント・ラベル

• 入力値(存在する場合)

• 最小値(存在する場合)

• 最大値(存在する場合)

• パターン(存在する場合)

また、メッセージ・バンドルを使用して、アプリケーション・レベルでメッセージ文字列をグローバルに設定することも可能です。「コンポーネントの全インスタンスのバリデータおよびコンバータのカスタム・メッセージの定義方法」を参照してください。

メッセージ・キーおよびセッター・メソッド

ADF Facesで、デフォルトのメッセージを独自のメッセージで置き換えるには、バリデータまたはコンバータのxxxMessageDetail属性のテキストを設定するか、EL式を使用してこれらの属性をリソース・バンドルにバインドします。メッセージ内のプレースホルダを使用して、関連する詳細を含めることもできます。

ADF Facesの各コンバータおよびバリデータについて、次の情報が提供されます。

• メッセージのオーバーライドに使用できるsetメソッド。

• リソース・バンドルで独自のメッセージの識別に使用できるメッセージ・キー。

• 入力値やパターンなどの詳細を含むプレースホルダのメッセージでの使用方法。

コンバータおよびバリデータのメッセージ・キーおよびセッター・メソッド

ADF Facesには多くのコンバータとバリデータが用意されており、アプリケーションでADF Faces入力コンポーネントに変換および検証機能を追加することができます。

次のサブセクションでは、すべてのADF Facesコンバータおよびバリデータの詳細メッセージのリファレンスの詳細を説明します。

af:convertColor

色の値を表す文字列とjava.awt.Colorオブジェクトとの間の変換を行います。変換に使用されるパターンのセットはオーバーライドできます。

色の変換: 入力値はパターン・セットに基づく色に変換できません

setメソッド:

setMessageDetailConvert(java.lang.String convertBothMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.convert.ColorConverter.CONVERT_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 色の例

af:convertDateTime

パターンとスタイル・セットに基づき、文字列とjava.util.Dateとの間の変換を行います。

日時の変換: typeがbothに設定されている場合、日付オブジェクトに変換できない日時の値

setメソッド:

setMessageDetailConvertBoth(java.lang.String convertBothMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.convert.DateTimeConverter.CONVERT_BOTH_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} コンバータで想定される形式の例

日にちの変換: パターンやセカンダリ・パターンが設定されている場合、またはtypeがdateに設定されている場合は、入力値を日にちに変換できません

setメソッド:

setMessageDetailConvertDate(java.lang.String convertDateMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.convert.DateTimeConverter.CONVERT_DATE_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} コンバータで想定される形式の例

日にちの変換: パターンやセカンダリ・パターンが設定されている場合、またはtypeがtimeに設定されている場合は、入力値を日にちに変換できません

setメソッド:

setMessageDetailConvertTime(java.lang.String convertTimeMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.convert.DateTimeConverter.CONVERT_TIME_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} コンバータで想定される形式の例

af:convertNumber

javax.faces.convert.NumberConverter標準JSFクラスの拡張が提供されます。コンバータでは、デフォルトNumberConverterのすべての標準機能が提供され、オブジェクトへの変換は厳密です。

数値の変換: パターン・セットに基づき、入力値はNumberに変換できません

setメソッド:

setMessageDetailConvertPattern(java.lang.String convertPatternMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.convert.NumberConverter.CONVERT_PATTERN_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 指定された変換パターン

数値の変換: typeがnumberに設定されている場合、およびpatternがnullか設定されていない場合は、入力値を数値に変換できません

setメソッド:

setMessageDetailConvertNumber(java.lang.String convertNumberMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.convert.NumberConverter.CONVERT_NUMBER_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値

数値の変換: typeがcurrencyに設定されている場合、およびpatternがnullか設定されていない場合は、入力値を数値に変換できません

setメソッド:

setMessageDetailConvertCurrency(java.lang.String convertCurrencyMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.convert.NumberConverter.CONVERT_CURRENCY_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値

数値の変換: typeがpercentに設定されている場合、およびpatternがnullか設定されていない場合は、入力値を数値に変換できません

setメソッド:

setMessageDetailConvertPercent(java.lang.String convertPercentMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.convert.NumberConverter.CONVERT_PERCENT_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値

af:validateByteLength

エンコード時に文字列のバイト数が検証されます。

バイト長の検証: 入力値が最大バイト長を超えています

setメソッド:

setMessageDetailMaximum(java.lang.String maximumMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.ByteLengthValidator.MAXIMUM_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 最大長

af:validateDateRestriction

特定の制限に対して日付が有効かどうかが検証されます。

日付制限の検証 - 無効な日付: invalidDateがinvalidDaysのリスト内にある場合、入力値は無効です

setメソッド:

setMessageDetailInvalidDays(java.lang.String invalidDays)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.DateRestrictionValidator.WEEKDAY_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 無効な日付

日付制限の検証 - 無効な曜日: 値がinvalidDaysOfWeekに指定される曜日のいずれかである場合、入力値は無効です

setメソッド:

setMessageDetailInvalidDaysOfWeek(java.lang.String invalidDaysOfWeek)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.DateRestrictionValidator.DAY_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 無効な曜日

日付制限の検証 - 無効な月: 値にinvalidMonthsに指定された月がある場合、入力値は無効です

setメソッド:

setMessageDetailInvalidMonths(java.lang.String invalidMonths)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.DateRestrictionValidator.MONTH_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 無効な月

af:validateDateTimeRange

入力された日付が、指定された範囲内かどうかが検証されます。

日付時間範囲の検証: 入力値が、設定されたmaximum値を超えています

setメソッド:

setMessageDetailMaximum(java.lang.String maximumMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.DateTimeRangeValidator.MAXIMUM_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 許可されている最大日付

日付時間範囲の検証: 入力値が、設定されたminimum値を下回っています

setメソッド:

setMessageDetailMinimum(java.lang.String minimumMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.DateTimeRangeValidator.MINIMUM_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 許可されている最小日付

日付時間範囲の検証: minimumおよびmaximumが設定されていますが、入力値がその範囲を超えています

setメソッド:

setMessageDetailNotInRange(java.lang.String notInRangeMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.DateTimeRangeValidator.NOT_IN_RANGE_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 許可されている最小日付
• {3} 許可されている最大日付

af:validateDoubleRange

入力された値が、指定された範囲内かどうかが検証されます。

Double範囲の検証: 入力値が、設定されたmaximum値を超えています

setメソッド:

setMessageDetailMaximum(java.lang.String maximumMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.DoubleRangeValidator.MAXIMUM_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 許可されている最大値

Double範囲の検証: 入力値が、設定されたminimum値を下回っています

setメソッド:

setMessageDetailMinimum(java.lang.String minimumMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.DoubleRangeValidator.MINIMUM_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 許可されている最小値

Double範囲の検証: minimumおよびmaximumが設定されていますが、入力値がその範囲を超えています

setメソッド:

setMessageDetailNotInRange(java.lang.String notInRangeMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.DoubleRangeValidator.NOT_IN_RANGE_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 許可されている最小値
• {3} 許可されている最大値

af:validateLength

入力された値が、指定された範囲内かどうかが検証されます。

長さの検証: 入力値が、設定されたmaximum値を超えています

setメソッド:

setMessageDetailMaximum(java.lang.String maximumMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.LengthValidator.MAXIMUM_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 許可されている最大長

長さの検証: 入力値が、設定されたminimum値を下回っています

setメソッド:

setMessageDetailMinimum(java.lang.String minimumMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.LengthValidator.MINIMUM_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 許可されている最小長

長さの検証: minimumおよびmaximumが設定されていますが、入力値がその範囲を超えています

setメソッド:

setMessageDetailNotInRange(java.lang.String notInRangeMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.LengthValidator.NOT_IN_RANGE_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 許可されている最小長
• {3} 許可されている最大長

af:validateRegExp

Javaの正規表現構文を使用した式を検証します。

正規表現の検証: 入力値が指定されたパターンと一致しません。

setメソッド:

setMessageDetailNoMatch(java.lang.String noMatchMessageDetail)

メッセージ・キー:

org.apache.myfaces.trinidad.validator.RegExpValidator.NO_MATCH_detail

プレースホルダ:

• {0} コンポーネントを識別するラベル
• {1} ユーザーが入力した値
• {2} 想定される変換パターン