NumberStringDecimal (Nablarch-API)

java.lang.Object
- nablarch.core.dataformat.convertor.datatype.DataType<F,byte[]>
- - nablarch.core.dataformat.convertor.datatype.ByteStreamDataSupport<java.math.BigDecimal>
  - - nablarch.core.dataformat.convertor.datatype.NumberStringDecimal

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

public class NumberStringDecimal
extends ByteStreamDataSupport<java.math.BigDecimal>

符号なし数値のデータタイプ。

入力時にはバイトデータを数値（BigDecimal）に変換し、出力時にはオブジェクトをバイトデータに変換して返却する。

本データタイプは符号なし数値の入出力データを扱うことを前提として設計されている。
入出力データとして符号付き数値を扱う場合は、SignedNumberStringDecimalを使用すること。

本データタイプは符号なし数値の入出力データを扱うことを前提として設計されている。
よって符号（'+'または'-'）が存在する入力データや、負数の出力データを扱うことはできない。

入力時にはトリム処理を、出力時にはパディング処理を行う。
パディング/トリム文字として、デフォルトでは"0"を使用するが、個別にパディング/トリム文字を使用することもできる。
（※パディング/トリム文字として指定できるのは1バイトの文字のみである。また、パディング/トリム文字として1～9の文字を使用することはできない）

データタイプの引数として設定可能なパラメータ

データタイプの第1引数にはバイト長を指定する。必須項目である。

データタイプの第2引数には小数点位置を指定する。ここで指定された小数点位置に従い、データの読み書きを行う。
ただし、入力データに小数点が含まれている場合（例：123.45）は、ここで指定した小数点位置は無視され、入力データ内の小数点をもとにデータの読み込みが行われる。

データタイプの引数の一覧を以下に示す。

引数	パラメータ名	パラメータの型	必須/任意	デフォルト値
第1引数	バイト長	Integer	必須	-
第2引数	小数点位置	Integer	任意	0

セッターを使用して設定可能なパラメータ

小数点の要否は#setRequiredDecimalPoint(boolean)によって指定できる。
trueを設定した場合、出力データに小数点が付与される。

セッタを使用して設定可能なパラメータの一覧を以下に示す。これらのパラメータはディレクティブを使用して設定することを想定している。

パラメータ名	パラメータの型	必須/任意	デフォルト値
小数点の要否	boolean	任意	true

設定例

入力データを読み込む場合の設定例を以下に示す。

入力データ	バイト長	小数点位置	小数点の要否	パディング/トリム文字	入力データ変換後の値（BigDecimal）
0000012345	10	0	必要	0	12345
0000123.45	10	0	必要	0	123.45
0000012345	10	0	必要	0	12345
(半角スペース5個)12345	10	0	必要	半角スペース	12345
0000012345	10	2	必要	0	123.45

出力データを書き込む場合の設定例を以下に示す。

出力データ	出力データの型	バイト長	小数点位置	小数点の要否	パディング/トリム文字	出力データ変換後の値（byte[]）
12345	String	10	0	必要	0	0000012345
123.45	String	10	0	必要	0	0000012345
12345	String	10	0	必要	半角スペース	(半角スペース5個)12345
12345	BigDecimal	10	0	必要	0	0000012345
123.45	BigDecimal	10	2	必要	0	0000123.45
123.45	BigDecimal	10	3	必要	0	000123.450
123.45	BigDecimal	10	3	不要	0	0000123450
12345	BigDecimal	10	3	必要	0	012345.000
123000	BigDecimal	10	-3	不要	0	0000000123
123000	BigDecimal	10	-4	必要	0	00000012.3

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

protected static int PADDING_CHAR_LENGTH
パディング/トリム文字のサイズ

フィールド
修飾子とタイプ	フィールドと説明
`protected static int`	`PADDING_CHAR_LENGTH` パディング/トリム文字のサイズ

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

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

NumberStringDecimal()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected void`	`checkBytesSize(byte[] bytes)` 出力データのサイズをチェックする。
`protected void`	`checkPaddingStrLength(java.lang.String paddingStr)` パディング/トリム文字のバイト長を返却する。
`java.math.BigDecimal`	`convertOnRead(byte[] data)` 入力時に読み込んだデータを変換する。
`protected java.math.BigDecimal`	`convertOnRead(java.lang.String strData)` 文字列に変換した入力データに対してトリム処理を行い、BigDecimalに変換する。
`byte[]`	`convertOnWrite(java.lang.Object data)` 出力時にフィールドデータの変換を行う。
`protected byte[]`	`convertToBytes(java.lang.String strData)` 文字列をエンコーディングに従いバイトデータに変換する。
`protected java.lang.String`	`formatWriteData(java.math.BigDecimal bigDecimal)` 書き込みを行うデータをフォーマットする。
`protected byte[]`	`getPaddingBytes(java.lang.String paddingStr)` パディング/トリム文字のバイト配列を返却する。
`protected java.lang.String`	`getPaddingStr()` パディング/トリム文字を返却する。
`int`	`getScale()` 小数点の位置を取得する。
`DataType<java.math.BigDecimal,byte[]>`	`init(FieldDefinition field, java.lang.Object... args)` 初期化処理を行う。
`DataType<java.math.BigDecimal,byte[]>`	`initialize(java.lang.Object... args)` 初期化処理を行う。
`protected boolean`	`isNegative(java.math.BigDecimal bigDecimal)` BigDecimalが負数かどうか。
`protected byte[]`	`padding(byte[] bytes, int size)` パディング処理を行う。
`NumberStringDecimal`	`setRequiredDecimalPoint(boolean requiredDecimalPoint)` 小数点の要否を設定する。
`protected java.math.BigDecimal`	`toBigDecimal(java.lang.String trimmedStr)` トリム後の文字列をBigDecimalに変換する。
`protected java.lang.String`	`trim(java.lang.String str)` トリム処理を行う。
`protected void`	`validateReadDataFormat(java.lang.String data)` 入力データが妥当であることをチェックする。
`protected void`	`validateWriteDataFormat(java.math.BigDecimal bigDecimal)` 書き込みを行うデータの形式をチェックする。

クラスから継承されたメソッド nablarch.core.dataformat.convertor.datatype.ByteStreamDataSupport
getSize, setSize

クラスから継承されたメソッド nablarch.core.dataformat.convertor.datatype.DataType
getField, removePadding

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

- フィールドの詳細
  - PADDING_CHAR_LENGTH
```
protected static final int PADDING_CHAR_LENGTH
```
    パディング/トリム文字のサイズ
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - NumberStringDecimal
```
public NumberStringDecimal()
```
- メソッドの詳細
  - init
```
public DataType<java.math.BigDecimal,byte[]> init(FieldDefinition field,
                                                  java.lang.Object... args)
```
    初期化処理を行う。
    
    オーバーライド:
    
    init クラス内 DataType<java.math.BigDecimal,byte[]>
    
    パラメータ:
    
    field - フィールド定義
    
    args - データタイプのパラメータ
    
    戻り値:
    
    初期化されたデータタイプ（通常はthisをリターンする）
  - getPaddingBytes
```
protected byte[] getPaddingBytes(java.lang.String paddingStr)
```
    パディング/トリム文字のバイト配列を返却する。
    
    パラメータ:
    
    paddingStr - パディング/トリム文字
    
    戻り値:
    
    パディング/トリム文字のバイト配列
  - initialize
```
public DataType<java.math.BigDecimal,byte[]> initialize(java.lang.Object... args)
```
    初期化処理を行う。
    
    定義:
    
    initialize クラス内 DataType<java.math.BigDecimal,byte[]>
    
    パラメータ:
    
    args - データタイプのパラメータ
    
    戻り値:
    
    初期化されたデータタイプ（通常はthisをリターンする）
  - convertOnRead
```
public java.math.BigDecimal convertOnRead(byte[] data)
```
    入力時に読み込んだデータを変換する。
    この実装では、入力時に、入力データをBigDecimalに変換して返却する。
    
    変換の際に指定された文字でトリムを行う。デフォルトのトリム文字として'0'を使用する。
    
    入力データの読み込みは、setRequiredDecimalPoint(boolean)で指定された小数点位置にしたがって行う。
    ただし、入力データに小数点が含まれている場合（例：123.45）は、入力データ内の小数点にしたがってデータの読み込みが行われる。
    
    定義:
    
    convertOnRead クラス内 DataType<java.math.BigDecimal,byte[]>
    
    パラメータ:
    
    data - フィールドの値データ
    
    戻り値:
    
    変換後の値
  - convertOnRead
```
protected java.math.BigDecimal convertOnRead(java.lang.String strData)
```
    文字列に変換した入力データに対してトリム処理を行い、BigDecimalに変換する。
    入力データに符号（'+'または'-'）が存在する場合、例外をスローする。
    
    パラメータ:
    
    strData - 入力データ
    
    戻り値:
    
    数値
  - validateReadDataFormat
```
protected void validateReadDataFormat(java.lang.String data)
```
    入力データが妥当であることをチェックする。
    数値型で無い場合は、例外をスローする。
    
    パラメータ:
    
    data - 入力データまたは出力データ
  - trim
```
protected java.lang.String trim(java.lang.String str)
```
    トリム処理を行う。
    もし、パディング/トリム文字が'0'かつ、トリム対象のデータが0のみで構成される数値（0や000000）の場合、0を返却する。
    
    パラメータ:
    
    str - トリム対象のデータ
    
    戻り値:
    
    トリム後の文字列
  - toBigDecimal
```
protected java.math.BigDecimal toBigDecimal(java.lang.String trimmedStr)
```
    トリム後の文字列をBigDecimalに変換する。
    
    パラメータ:
    
    trimmedStr - トリム後の文字列
    
    戻り値:
    
    変換後のBigDecimal
  - convertOnWrite
```
public byte[] convertOnWrite(java.lang.Object data)
```
    出力時にフィールドデータの変換を行う。
    もし書き込みを行うデータが負数の場合、例外をスローする。
    
    定義:
    
    convertOnWrite クラス内 DataType<java.math.BigDecimal,byte[]>
    
    パラメータ:
    
    data - 書き込みを行うデータ
    
    戻り値:
    
    変換後のバイトデータ
  - validateWriteDataFormat
```
protected void validateWriteDataFormat(java.math.BigDecimal bigDecimal)
```
    書き込みを行うデータの形式をチェックする。
    データが負の符号を持つ場合、例外をスローする。
    
    符号を許容するサブクラスでは、本メソッドをオーバーライドし、無効化すること。
    
    パラメータ:
    
    bigDecimal - 書き込みを行うデータ
  - formatWriteData
```
protected java.lang.String formatWriteData(java.math.BigDecimal bigDecimal)
```
    書き込みを行うデータをフォーマットする。
    小数点が必要な場合は小数点を付与した文字列を返却し、
    不要な場合は小数点を削除した文字列を返却する。
    
    パラメータ:
    
    bigDecimal - BigDecimal変換後の書き込みデータ
    
    戻り値:
    
    フォーマット後のデータ
  - isNegative
```
protected boolean isNegative(java.math.BigDecimal bigDecimal)
```
    BigDecimalが負数かどうか。
    
    パラメータ:
    
    bigDecimal - BigDecimal
    
    戻り値:
    
    負数かどうか
  - convertToBytes
```
protected byte[] convertToBytes(java.lang.String strData)
```
    文字列をエンコーディングに従いバイトデータに変換する。
    
    パラメータ:
    
    strData - 文字列
    
    戻り値:
    
    文字列を変換したバイトデータ
  - checkBytesSize
```
protected void checkBytesSize(byte[] bytes)
```
    出力データのサイズをチェックする。
    出力データのサイズがバイト長を超える場合、例外をスローする。
    
    パラメータ:
    
    bytes - 出力データ
  - padding
```
protected byte[] padding(byte[] bytes,
                         int size)
```
    パディング処理を行う。
    
    パラメータ:
    
    bytes - パディング前の値
    
    size - パディングを行うサイズ
    
    戻り値:
    
    パディング後の値
  - getPaddingStr
```
protected java.lang.String getPaddingStr()
```
    パディング/トリム文字を返却する。パディング/トリム文字が指定されていない場合、デフォルトで半角スペースを使用する。
    
    戻り値:
    
    パディング/トリム文字
  - checkPaddingStrLength
```
protected void checkPaddingStrLength(java.lang.String paddingStr)
```
    パディング/トリム文字のバイト長を返却する。
    
    パラメータ:
    
    paddingStr - パディング/トリム文字のバイト長
  - setRequiredDecimalPoint
```
public NumberStringDecimal setRequiredDecimalPoint(boolean requiredDecimalPoint)
```
    小数点の要否を設定する。
    
    パラメータ:
    
    requiredDecimalPoint - 小数点の要否（trueの場合、必要）
    
    戻り値:
    
    このオブジェクト自体
  - getScale
```
public int getScale()
```
    小数点の位置を取得する。
    
    戻り値:
    
    小数点の位置

クラス NumberStringDecimal

フィールドのサマリー

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

メソッドのサマリー

クラスから継承されたメソッド nablarch.core.dataformat.convertor.datatype.ByteStreamDataSupport

クラスから継承されたメソッド nablarch.core.dataformat.convertor.datatype.DataType

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

フィールドの詳細

PADDING_CHAR_LENGTH

コンストラクタの詳細

NumberStringDecimal

メソッドの詳細

init

getPaddingBytes

initialize

convertOnRead

convertOnRead

validateReadDataFormat

trim

toBigDecimal

convertOnWrite

validateWriteDataFormat

formatWriteData

isNegative

convertToBytes

checkBytesSize

padding

getPaddingStr

checkPaddingStrLength

setRequiredDecimalPoint

getScale