PackedDecimal (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.PackedDecimal

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

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

パック10進数のデータタイプ。

入力時にはバイト配列（パック10進数）をBigDecimal型に変換し、出力時にはオブジェクト（BigDecimalや文字列型の数値など）をバイト配列（パック10進数）に変換して返却する。

出力対象のデータ（#convertOnWrite(Object)の引数）として使用できるオブジェクトの種類を以下に示す。nullは許容しない。

BigDecimal
BigDecimalに変換可能なオブジェクト（数値や文字列など）

出力対象のデータに小数点が含まれる場合、小数点を取り除いた値に変換する。
また、出力対象のデータがBigDecimalの場合はスケーリングした値に変換する。
以下に出力例を示す。

出力対象データの型	出力対象データの値	出力対象データの変換後の値
Integer	123.45	12345
String	"123.45000"	12345000
BigDecimal	123.45	12345
BigDecimal（scale=5)	123.45	12345000

本クラスが出力対象のデータの桁数として許容するのは18桁までの数値である。
この桁数とは、出力対象のデータから小数点を取り除き、BigDecimalの場合はスケールに従い変換した後の桁数のことを指す。
(※処理を高速化するために内部的に出力対象データをlong型に変換し扱っているので、このような桁数の制約を設けている）

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

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

PackedDecimal()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`java.math.BigDecimal`	`convertOnRead(byte[] buff)` 入力時に読み込んだデータを変換する。
`byte[]`	`convertOnWrite(java.lang.Object data)` 出力時に書き込むデータの変換を行う。
`java.lang.Byte`	`getPackSignNibbleNegative()` 符号付きパック10進数値の末尾桁の下位4ビット（負数の場合）を返却する。
`java.lang.Byte`	`getPackSignNibblePositive()` 符号付きパック10進数値の末尾桁の下位4ビット（正数の場合）を返却する。
`PackedDecimal`	`initialize(java.lang.Object... args)` 初期化処理を行う。
`PackedDecimal`	`setDefaultPackSignNibbleNegative(java.lang.Byte defaultPackSignNibbleNegative)` デフォルトの符号付きパック10進数値の末尾桁の下位4ビット（負数の場合）を設定する。
`PackedDecimal`	`setDefaultPackSignNibblePositive(java.lang.Byte defaultPackSignNibblePositive)` デフォルトの符号付きパック10進数値の末尾桁の下位4ビット（正数の場合）を設定する。
`PackedDecimal`	`setPackNibble(java.lang.Byte packNibble)` パックNibbleを設定する。
`PackedDecimal`	`setPackSignNibbleNegative(java.lang.Integer nibble)` 符号付きパック10進数値の末尾桁の下位4ビット（負数の場合）を返却する。
`PackedDecimal`	`setPackSignNibblePositive(java.lang.Integer nibble)` 符号付きパック10進数値の末尾桁の下位4ビット（正数の場合）を返却する。
`PackedDecimal`	`setSigned(boolean signed)` 符号付きの整数として処理するかどうかを設定する。

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

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

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

- コンストラクタの詳細
  - PackedDecimal
```
public PackedDecimal()
```
- メソッドの詳細
  - initialize
```
public PackedDecimal initialize(java.lang.Object... args)
```
    初期化処理を行う。
    
    定義:
    
    initialize クラス内 DataType<java.math.BigDecimal,byte[]>
    
    パラメータ:
    
    args - データタイプのパラメータ
    
    戻り値:
    
    初期化されたデータタイプ（通常はthisをリターンする）
  - convertOnRead
```
public java.math.BigDecimal convertOnRead(byte[] buff)
```
    入力時に読み込んだデータを変換する。
    
    定義:
    
    convertOnRead クラス内 DataType<java.math.BigDecimal,byte[]>
    
    パラメータ:
    
    buff - フィールドの値データ
    
    戻り値:
    
    変換後の値
  - convertOnWrite
```
public byte[] convertOnWrite(java.lang.Object data)
```
    出力時に書き込むデータの変換を行う。
    出力対象のデータが以下の場合、InvalidDataFormatExceptionをスローする。
    - null
    - BigDecimalに変換できないオブジェクト
    - データから小数点を取り除き、またBigDecimalの場合はスケーリングした後の桁数が19桁以上の場合
    定義:
    
    convertOnWrite クラス内 DataType<java.math.BigDecimal,byte[]>
    
    パラメータ:
    
    data - 書き込みを行うデータ
    
    戻り値:
    
    変換後の値
  - setPackSignNibblePositive
```
public PackedDecimal setPackSignNibblePositive(java.lang.Integer nibble)
```
    符号付きパック10進数値の末尾桁の下位4ビット（正数の場合）を返却する。
    
    パラメータ:
    
    nibble - 符号付きパック10進数値の末尾桁の下位4ビット（正数の場合）
    
    戻り値:
    
    このオブジェクト自体
  - setPackSignNibbleNegative
```
public PackedDecimal setPackSignNibbleNegative(java.lang.Integer nibble)
```
    符号付きパック10進数値の末尾桁の下位4ビット（負数の場合）を返却する。
    
    パラメータ:
    
    nibble - 符号付きパック10進数値の末尾桁の下位4ビット（負数の場合）
    
    戻り値:
    
    このオブジェクト自体
  - getPackSignNibbleNegative
```
public java.lang.Byte getPackSignNibbleNegative()
```
    符号付きパック10進数値の末尾桁の下位4ビット（負数の場合）を返却する。
    
    戻り値:
    
    パック10進数値の下位4ビット（負数の場合）
  - getPackSignNibblePositive
```
public java.lang.Byte getPackSignNibblePositive()
```
    符号付きパック10進数値の末尾桁の下位4ビット（正数の場合）を返却する。
    
    戻り値:
    
    パック10進数値の下位4ビット（正数の場合）
  - setSigned
```
public PackedDecimal setSigned(boolean signed)
```
    符号付きの整数として処理するかどうかを設定する。
    
    パラメータ:
    
    signed - 符号付きの整数として扱う場合はtrue
    
    戻り値:
    
    このオブジェクト自体
  - setPackNibble
```
public PackedDecimal setPackNibble(java.lang.Byte packNibble)
```
    パックNibbleを設定する。
    
    パラメータ:
    
    packNibble - パックNibble
    
    戻り値:
    
    このオブジェクト自体
  - setDefaultPackSignNibbleNegative
```
public PackedDecimal setDefaultPackSignNibbleNegative(java.lang.Byte defaultPackSignNibbleNegative)
```
    デフォルトの符号付きパック10進数値の末尾桁の下位4ビット（負数の場合）を設定する。
    
    パラメータ:
    
    defaultPackSignNibbleNegative - デフォルトの符号付きパック10進数値の末尾桁の下位4ビット（負数の場合）
    
    戻り値:
    
    このオブジェクト自体
  - setDefaultPackSignNibblePositive
```
public PackedDecimal setDefaultPackSignNibblePositive(java.lang.Byte defaultPackSignNibblePositive)
```
    デフォルトの符号付きパック10進数値の末尾桁の下位4ビット（正数の場合）を設定する。
    
    パラメータ:
    
    defaultPackSignNibblePositive - デフォルトの符号付きパック10進数値の末尾桁の下位4ビット（正数の場合）
    
    戻り値:
    
    このオブジェクト自体

クラス PackedDecimal

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

メソッドのサマリー

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

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

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

コンストラクタの詳細

PackedDecimal

メソッドの詳細

initialize

convertOnRead

convertOnWrite

setPackSignNibblePositive

setPackSignNibbleNegative

getPackSignNibbleNegative

getPackSignNibblePositive

setSigned

setPackNibble

setDefaultPackSignNibbleNegative

setDefaultPackSignNibblePositive