スクリプト開発向けim-BizAPI

DecimalFormatterオブジェクト

コンポーネント情報
version8.0.7
コンポーネント概要
設定ファイルに記述したフォーマット情報を元に、指定された DecimalFormatHandler の実装クラスを内部で生成し、
これを利用して数値文字列の整形および解析を行うオブジェクトです。

このオブジェクトは、設定ファイル(conf/decimal-format-config/im-decimal-format-config.xml)に記述するフォーマット情報のうち、
<decimal-format>タグのid属性 をフォーマットIDとして、また class属性を実装クラスとして参照します。
標準で利用される実装クラスは StandardDecimalFormatHandler です。
class属性の実装クラス指定を変更することで、独自の DecimalFormatHandler の実装クラスを利用することも可能です。

以下は設定ファイルの記述例です。
 <decimal-format-config>
   <decimal-format id="sample" class="jp.co.intra_mart.foundation.i18n.number.format.StandardDecimalFormatHandler">
     <parameter param-name="pattern" param-value="#,##0.###"/>
     <parameter param-name="locale" param-value="ja"/>
     <parameter param-name="decimal-separator" param-value="."/>
     <parameter param-name="grouping-separator" param-value=","/>
   </decimal-format>
 </decimal-format-config>
このように記述した設定に対して、
   var formatter = DecimalFormatter.getInstance("sample");
と実行することで、実装クラス StandardDecimalFormatHandler を内部に持つオブジェクトのインスタンスを取得できます。

このオブジェクトに用意されたメソッドは、staticメソッドを除き、全て内部で保持している実装クラスに対して実行されます。

メソッドの概要

返却値の型 メソッド名
String format (BigDecimal num)
BigDecimal をフォーマットして文字列を作成します。
String format (BigInteger num)
BigInteger をフォーマットして文字列を作成します。
String format (Number num)
Numberをフォーマットして文字列を作成します。
DecimalFormatter getAccountInstance () static
現在のアカウントコンテキストに紐付くフォーマット情報を元に、このオブジェクトを生成します。
DecimalFormatter getInstance (String formatId) static
フォーマットIDで指定されるフォーマット情報を元に、このオブジェクトを生成します。
BigDecimal parseToBigDecimal (String text)
文字列からテキストを解析してBigDecimal を生成します。
Number parseToNumber (String text)
文字列からテキストを解析してNumberを生成します。
void setGroupingUsed (Boolean newValue)
この DecimalFormatter でグループ化を使用するかどうかを設定します。
void setMaximumFractionDigits (Number newValue)
数値の小数部分の最大桁数を設定します。
void setMaximumIntegerDigits (Number newValue)
数値の整数部分の最大桁数を設定します。
void setMinimumFractionDigits (Number newValue)
数値の小数部分の最小桁数を設定します。
void setMinimumIntegerDigits (Number newValue)
数値の整数部分の最小桁数を設定します。
void setRoundingMode (RoundingMode roundingMode)
この DecimalFormatter で使用される RoundingMode を設定します。

メソッドの詳細

String format (BigDecimal num)
BigDecimal をフォーマットして文字列を作成します。
パラメータ
num : BigDecimal
変換する数値
返却値
String
String フォーマットされた数値文字列
String format (BigInteger num)
BigInteger をフォーマットして文字列を作成します。
パラメータ
num : BigInteger
変換する数値
返却値
String
String フォーマットされた数値文字列
String format (Number num)
Numberをフォーマットして文字列を作成します。
パラメータ
num : Number
変換する数値
返却値
String
String フォーマットされた数値文字列
DecimalFormatter getAccountInstance () static
現在のアカウントコンテキストに紐付くフォーマット情報を元に、このオブジェクトを生成します。
返却値
DecimalFormatter
DecimalFormatter アカウントコンテキストに紐付くフォーマットを利用したオブジェクト
DecimalFormatter getInstance (String formatId) static
フォーマットIDで指定されるフォーマット情報を元に、このオブジェクトを生成します。
設定ファイル上に記述されたフォーマット情報の 実装クラスが不適切な場合、エラーが throw されます。
パラメータ
formatId : String
フォーマットID
返却値
DecimalFormatter
DecimalFormatter フォーマットIDで指定されるフォーマットを利用したオブジェクト。指定されたフォーマットが存在しない場合は null。
BigDecimal parseToBigDecimal (String text)
文字列からテキストを解析してBigDecimal を生成します。
無限大やNaNを表す文字列を与えた場合は文字列の解析に失敗します。
解析が失敗した場合は エラーをthrowします。
パラメータ
text : String
解析される文字列
返却値
BigDecimal
BigDecimal 解析された値
Number parseToNumber (String text)
文字列からテキストを解析してNumberを生成します。
Number型の範囲を超えた数値文字列を与えた場合は桁落ちが発生します。
無限大やNaNを表す文字列を与えた場合は文字列の解析に失敗します。
解析が失敗した場合はエラーをthrowします。
パラメータ
text : String
解析される文字列
返却値
Number
Number 解析された値
void setGroupingUsed (Boolean newValue)
この DecimalFormatter でグループ化を使用するかどうかを設定します。
パラメータ
newValue : Boolean
グループ化を使用する場合は true、そうでない場合は false
返却値
void
void setMaximumFractionDigits (Number newValue)
数値の小数部分の最大桁数を設定します。
パラメータ
newValue : Number
小数部分の最大表示桁数。
返却値
void
void setMaximumIntegerDigits (Number newValue)
数値の整数部分の最大桁数を設定します。
パラメータ
newValue : Number
整数部分の最大表示桁数。
返却値
void
void setMinimumFractionDigits (Number newValue)
数値の小数部分の最小桁数を設定します。
パラメータ
newValue : Number
小数部分の最小表示桁数。
返却値
void
void setMinimumIntegerDigits (Number newValue)
数値の整数部分の最小桁数を設定します。
パラメータ
newValue : Number
整数部分の最小表示桁数。
返却値
void
void setRoundingMode (RoundingMode roundingMode)
この DecimalFormatter で使用される RoundingMode を設定します。
パラメータ
roundingMode : RoundingMode
使用される RoundingMode
返却値
void

Copyright © 2012 NTT DATA INTRAMART CORPORATION