NumberConvertorSupport (Nablarch-API)

java.lang.Object
- nablarch.core.validation.convertor.NumberConvertorSupport

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

Convertor

直系の既知のサブクラス:

BigDecimalConvertor, IntegerConvertor
```
public abstract class NumberConvertorSupport
extends java.lang.Object
implements Convertor
```
数値のコンバータの作成を助けるサポートクラス。
数値のコンバータは変換前にバリデーションを行うが、各コンバータが行う共通バリデーションは当クラスにて行う。共通バリデーションの仕様は次の通りである。
- allowNullValueがfalseの時に、入力値がnullでないこと。
- 入力値がNumber、String、String配列のいずれかのインスタンスであること。
- 入力値がString配列である場合、要素数が1であること。
トリム仕様
値の前後の空白文字はトリムしてから変換可否の判定および変換を行う。
関連項目:

Digits, BigDecimalConvertor, LongConvertor, IntegerConvertor

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

NumberConvertorSupport()

コンストラクタ
コンストラクタと説明
`NumberConvertorSupport()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`<T> java.lang.Object`	`convert(ValidationContext<T> context, java.lang.String propertyName, java.lang.Object value, java.lang.annotation.Annotation format)` 変換を行う。
`protected java.lang.String`	`convertToNumber(java.lang.String number, java.text.DecimalFormatSymbols symbols)` 言語に応じた数字を`Number`に変換可能な数字に変換する。
`protected abstract java.lang.Number`	`convertToPropertyType(java.lang.String numberString)` トリムおよびフォーマットを行った文字列を、プロパティの型のオブジェクトへ変換する。
`protected java.lang.String`	`convertToString(java.lang.Object value)` パラメータのオブジェクトを文字列に変換する。
`protected abstract java.util.regex.Pattern`	`createPattern(Digits digits, java.text.DecimalFormatSymbols symbols)` Digitsに対応する正規表現を作成する。
`protected <T> java.text.DecimalFormatSymbols`	`getDecimalFormatSymbols(ValidationContext<T> context, java.lang.String propertyName)` プロパティに対する`DecimalFormatSymbols`を取得する。
`protected java.text.DecimalFormatSymbols`	`getDefaultDecimalFormatSymbols()` デフォルトの`DecimalFormatSymbols`を返す。
`<T> boolean`	`isConvertible(ValidationContext<T> context, java.lang.String propertyName, java.lang.Object propertyDisplayName, java.lang.Object value, java.lang.annotation.Annotation format)` 変換可否のプレチェックを行う。
`void`	`setAllowNullValue(boolean allowNullValue)` 変換対象の値にnullを許可するか否かを設定する。
`void`	`setInvalidDigitsFractionMessageId(java.lang.String invalidDigitsFractionMessageId)` 小数部を指定した場合の桁数不正時のデフォルトのエラーメッセージのメッセージIDを設定する。
`void`	`setInvalidDigitsIntegerMessageId(java.lang.String invalidDigitsMessageId)` 小数部を指定しなかった場合の桁数不正時のデフォルトのエラーメッセージのメッセージIDを設定する。
`void`	`setMultiInputMessageId(java.lang.String multiInputMessageId)` 入力値に複数の文字列が設定された場合のデフォルトのエラーメッセージのメッセージIDを設定する。
`protected java.lang.String`	`trim(java.lang.String value)` トリムを実行する。

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

インタフェースから継承されたメソッド nablarch.core.validation.Convertor
getTargetClass

- コンストラクタの詳細
  - NumberConvertorSupport
```
public NumberConvertorSupport()
```
- メソッドの詳細
  - setInvalidDigitsIntegerMessageId
```
public void setInvalidDigitsIntegerMessageId(java.lang.String invalidDigitsMessageId)
```
    小数部を指定しなかった場合の桁数不正時のデフォルトのエラーメッセージのメッセージIDを設定する。
    デフォルトメッセージの例 : "{0}には{1}桁以下の数値を入力してください。"
    
    パラメータ:
    
    invalidDigitsMessageId - 小数部を指定しなかった場合の桁数不正時のデフォルトのエラーメッセージのメッセージID
  - setInvalidDigitsFractionMessageId
```
public void setInvalidDigitsFractionMessageId(java.lang.String invalidDigitsFractionMessageId)
```
    小数部を指定した場合の桁数不正時のデフォルトのエラーメッセージのメッセージIDを設定する。
    デフォルトメッセージの例 : "{0}には整数部{1}桁以下、小数部{2}桁以下の数値を入力してください。"
    
    パラメータ:
    
    invalidDigitsFractionMessageId - 小数部を指定した場合の桁数不正時のデフォルトのエラーメッセージのメッセージID
  - setMultiInputMessageId
```
public void setMultiInputMessageId(java.lang.String multiInputMessageId)
```
    入力値に複数の文字列が設定された場合のデフォルトのエラーメッセージのメッセージIDを設定する。
    デフォルトメッセージの例 : "{0}の値が不正です。"
    
    パラメータ:
    
    multiInputMessageId - 入力値に複数の文字列が設定された場合のデフォルトのエラーメッセージのメッセージID
  - setAllowNullValue
```
public void setAllowNullValue(boolean allowNullValue)
```
    変換対象の値にnullを許可するか否かを設定する。設定を省略した場合、nullが許可される。
    
    パラメータ:
    
    allowNullValue - nullを許可するか否か。許可する場合は、true
  - isConvertible
```
public <T> boolean isConvertible(ValidationContext<T> context,
                                 java.lang.String propertyName,
                                 java.lang.Object propertyDisplayName,
                                 java.lang.Object value,
                                 java.lang.annotation.Annotation format)
```
    変換可否のプレチェックを行う。
    変換できない文字列であった場合、エラーメッセージをValidationContextに追加し、falseを返却する。
    
    定義:
    
    isConvertible インタフェース内 Convertor
    
    型パラメータ:
    
    T - バリデーション結果で取得できる型
    
    パラメータ:
    
    context - ValidationContext
    
    propertyName - プロパティ名
    
    propertyDisplayName - プロパティの表示名オブジェクト
    
    value - 変換可否のプレチェックを行う値
    
    format - フォーマットを指定するアノテーション（指定がない場合null)
    
    戻り値:
    
    変換できる場合true
  - convert
```
public <T> java.lang.Object convert(ValidationContext<T> context,
                                    java.lang.String propertyName,
                                    java.lang.Object value,
                                    java.lang.annotation.Annotation format)
```
    変換を行う。
    変換に失敗した場合、ValidationContextにエラー内容を設定する。
    
    定義:
    
    convert インタフェース内 Convertor
    
    型パラメータ:
    
    T - バリデーション結果で取得できる型
    
    パラメータ:
    
    context - ValidationContext
    
    propertyName - プロパティ名
    
    value - 変換する値(データ型は様々な形式がありえる。)
    
    format - フォーマットを指定するアノテーション（指定がない場合null)
    
    戻り値:
    
    変換結果のオブジェクト
  - convertToPropertyType
```
@Published(tag="architect")
protected abstract java.lang.Number convertToPropertyType(java.lang.String numberString)
```
    トリムおよびフォーマットを行った文字列を、プロパティの型のオブジェクトへ変換する。
    
    パラメータ:
    
    numberString - トリムおよびフォーマットを行った文字列
    
    戻り値:
    
    プロパティの型のオブジェクト（数値型）
  - convertToString
```
protected java.lang.String convertToString(java.lang.Object value)
```
    パラメータのオブジェクトを文字列に変換する。以下に該当しないオブジェクトの場合には、nullを返却する。
    - String配列
    - String
    値の前後の空白文字はトリムする。
    パラメータ:
    
    value - 変換対象のオブジェクト
    
    戻り値:
    
    変換後の文字列
  - createPattern
```
@Published(tag="architect")
protected abstract java.util.regex.Pattern createPattern(Digits digits,
                                                                                     java.text.DecimalFormatSymbols symbols)
```
    Digitsに対応する正規表現を作成する。
    
    パラメータ:
    
    digits - 数値フォーマット指定のアノテーション
    
    symbols - 小数点に使用する文字や1000の区切り文字を提供するDecimalFormatSymbols
    
    戻り値:
    
    フォーマットを表わすパターン
  - getDecimalFormatSymbols
```
protected <T> java.text.DecimalFormatSymbols getDecimalFormatSymbols(ValidationContext<T> context,
                                                                     java.lang.String propertyName)
```
    プロパティに対するDecimalFormatSymbolsを取得する。
    ConversionUtil#getFormatSpec(ValidationContext, String)を呼び出し、 10進数に対する有効なフォーマット仕様(decimal)が取得できた場合は、フォーマット仕様に設定された言語を使用して生成したDecimalFormatSymbolsを返す。
    プロパティに対する有効なフォーマット仕様が存在しない場合は、 getDefaultDecimalFormatSymbols()を呼び出し、デフォルトのDecimalFormatSymbolsを返す。
    
    型パラメータ:
    
    T - バリデーション結果で取得できる型
    
    パラメータ:
    
    context - ValidationContext
    
    propertyName - プロパティ名
    
    戻り値:
    
    プロパティに対するDecimalFormatSymbols
  - getDefaultDecimalFormatSymbols
```
protected java.text.DecimalFormatSymbols getDefaultDecimalFormatSymbols()
```
    デフォルトのDecimalFormatSymbolsを返す。
    デフォルト実装では日本語に対するDecimalFormatSymbols(小数点の文字=ドット、1000の区切り文字=カンマ)を返す。
    
    戻り値:
    
    日本語に対するDecimalFormatSymbols(小数点の文字=ドット、1000の区切り文字=カンマ)
  - convertToNumber
```
protected java.lang.String convertToNumber(java.lang.String number,
                                           java.text.DecimalFormatSymbols symbols)
```
    言語に応じた数字をNumberに変換可能な数字に変換する。
    ConversionUtil#convertToNumber(String, DecimalFormatSymbols)に処理を委譲する。
    
    パラメータ:
    
    number - 数字
    
    symbols - 数字に使用されている小数点や1000の区切り文字を提供するDecimalFormatSymbols
    
    戻り値:
    
    Numberに変換可能な数字
  - trim
```
protected java.lang.String trim(java.lang.String value)
```
    トリムを実行する。
    
    パラメータ:
    
    value - トリム対象の文字列
    
    戻り値:
    
    トリム後の文字列

クラス NumberConvertorSupport

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド nablarch.core.validation.Convertor

コンストラクタの詳細

NumberConvertorSupport

メソッドの詳細

setInvalidDigitsIntegerMessageId

setInvalidDigitsFractionMessageId

setMultiInputMessageId

setAllowNullValue

isConvertible

convert

convertToPropertyType

convertToString

createPattern

getDecimalFormatSymbols

getDefaultDecimalFormatSymbols

convertToNumber

trim