概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.seasar.cubby.validator
クラス DefaultValidationRules

    java.lang.Object
      org.seasar.cubby.validator.AbstractValidationRules
          org.seasar.cubby.validator.DefaultValidationRules

すべての実装されたインタフェース:
  ValidationRules

    public abstract class DefaultValidationRules

extends AbstractValidationRules

入力検証を保持するクラスです。

作成者:
  agata, baba

フィールドの概要
`static ValidationPhase` | `DATA_CONSTRAINT` データ上の制約を検証するフェーズ。
`static ValidationPhase` | `DATA_TYPE` データ型を検証するフェーズ。

コンストラクタの概要
`DefaultValidationRules()` メッセージキーのプリフィックスなしのコンストラクタ。
`DefaultValidationRules(String resourceKeyPrefix)` メッセージキーのプリフィックス付きのコンストラクタ。

メソッドの概要
`protected void` | `add(String paramName, String paramNameResourceKey, Validator... validators)` 項目名のリソースキーを指定して、最初のフェーズに入力検証を追加します。
`protected void` | `add(String paramName, Validator... validators)` `getDefaultValidationPhase()` のフェーズに入力検証を追加します。
`protected void` | `add(ValidationPhase validationPhase, ValidationRule validationRule)` 入力検証ルールを追加します。
`protected void` | `add(ValidationRule validationRule)` `getDefaultValidationPhase()` のフェーズに入力検証ルールを追加します。
`protected void` | `addAll(ValidationRules validationRules)` 指定された `ValidationRules` に定義された入力検証ルールをすべて追加します。
`protected String` | `addResourceKeyPrefixTo(String resourceKey)` 指定されたリソースキーにこのオブジェクトに設定されているプレフィックスを追加します。
`ActionResult` | `fail(String errorPage)` 入力検証にエラーがあった場合に呼び出されます。
`protected ValidationPhase` | `getDefaultValidationPhase()` 項目ごとの入力検証を行うフェーズを返します。
`Collection<ValidationRule>` | `getPhaseValidationRules(ValidationPhase validationPhase)` 指定された入力検証フェーズに対応する入力検証ルールの`Collection`を取得します。
`List<ValidationPhase>` | `getValidationPhases()` 入力検証のフェーズの一覧を実行順に並べた`Collection`として取得します。
`protected void` | `initialize()` 初期化メソッド。
`protected void` | `initialize(String resourceKeyPrefix)` 初期化メソッド。

クラス org.seasar.cubby.validator.AbstractValidationRules から継承されたメソッド
`validate, validate`

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

フィールドの詳細

### DATA_TYPE

    public static final ValidationPhase DATA_TYPE

  データ型を検証するフェーズ。

### DATA_CONSTRAINT

    public static final ValidationPhase DATA_CONSTRAINT

  データ上の制約を検証するフェーズ。

コンストラクタの詳細

### DefaultValidationRules

    public DefaultValidationRules()

  メッセージキーのプリフィックスなしのコンストラクタ。

### DefaultValidationRules

    public DefaultValidationRules(String resourceKeyPrefix)

  メッセージキーのプリフィックス付きのコンストラクタ。

  パラメータ:
    `resourceKeyPrefix` - メッセージキーのプリフィックス

メソッドの詳細

### initialize

    protected void initialize(String resourceKeyPrefix)

  初期化メソッド。

  このメソッドをサブクラスでオーバーライドして各項目の入力検証ルールを追加します。

### initialize

    protected void initialize()

  初期化メソッド。

  このメソッドをサブクラスでオーバーライドして各項目の入力検証ルールを追加します。

### add

    protected void add(ValidationPhase validationPhase,
                       ValidationRule validationRule)

  入力検証ルールを追加します。

  パラメータ:
    `validationPhase` - 指定された入力検証ルールを実行するフェーズ
    `validationRule` - 入力検証ルール

### getDefaultValidationPhase

    protected ValidationPhase getDefaultValidationPhase()

  項目ごとの入力検証を行うフェーズを返します。

  戻り値:
    `DATA_TYPE`
  関連項目:
    `add(ValidationRule)`, `add(String, Validator...)`

### add

    protected void add(ValidationRule validationRule)

  `getDefaultValidationPhase()` のフェーズに入力検証ルールを追加します。

  パラメータ:
    `validationRule` - 入力検証ルール

### add

    protected void add(String paramName,
                       Validator... validators)

  `getDefaultValidationPhase()` のフェーズに入力検証を追加します。

  項目名のメッセージキーとしてパラメータ名が使用されます。

  パラメータ:
    `paramName` - パラメータ名
    `validators` - 入力検証

### add

    protected void add(String paramName,
                       String paramNameResourceKey,
                       Validator... validators)

  項目名のリソースキーを指定して、最初のフェーズに入力検証を追加します。

  パラメータ:
    `paramName` - パラメータ名
    `paramNameResourceKey` - 項目名のメッセージキー
    `validators` - 入力検証

### addAll

    protected void addAll(ValidationRules validationRules)

  指定された `ValidationRules` に定義された入力検証ルールをすべて追加します。

  パラメータ:
    `validationRules` - 追加する入力検証ルールの集合

### addResourceKeyPrefixTo

    protected String addResourceKeyPrefixTo(String resourceKey)

  指定されたリソースキーにこのオブジェクトに設定されているプレフィックスを追加します。

  パラメータ:
    `resourceKey` - リソースキー
  戻り値:
    プレフィックスが付加されたリソースキー

### fail

    public ActionResult fail(String errorPage)

  入力検証にエラーがあった場合に呼び出されます。

  指定されたエラーページへ遷移する `Forward` を返します。

  パラメータ:
    `errorPage` - エラーページ
  戻り値:
    アクションメソッド実行後の処理
  関連項目:
    `Validation.errorPage()`

### getValidationPhases

    public List<ValidationPhase> getValidationPhases()

  入力検証のフェーズの一覧を実行順に並べた`Collection`として取得します。

  デフォルトでは以下の順序です。

  - `DATA_TYPE`
  - `DATA_CONSTRAINT`
  これを変更してフェーズの追加などをしたい場合はこのメソッドをオーバーライドしてください。

  戻り値:
    入力検証のフェーズ

### getPhaseValidationRules

    public Collection<ValidationRule> getPhaseValidationRules(ValidationPhase validationPhase)

  指定された入力検証フェーズに対応する入力検証ルールの`Collection`を取得します。

  パラメータ:
    `validationPhase` - 入力検証フェーズ
  戻り値:
    指定された入力検証フェーズに対応する入力検証ルールの`Collection`

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Copyright © 2006-2009 The Seasar Foundation. All Rights Reserved.