jp.terasoluna.fw.web.taglib
クラス DecimalTag

java.lang.Object
  上位を拡張 javax.servlet.jsp.tagext.TagSupport
      上位を拡張 jp.terasoluna.fw.web.taglib.DecimalTag
すべての実装されたインタフェース:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class DecimalTag
extends javax.servlet.jsp.tagext.TagSupport

decimalタグの実装クラス。

符号、および小数点付き数値をフォーマットして出力、 あるいはスクリプティング変数として定義する。

フォーマット対象となる数値データは、java.math.BigDecimal 型、あるいは java.lang.String 型をサポートする。 java.lang.String 型の場合、BigDecimal のコンストラクタによって解釈可能な文字列となっている必要がある。

BigDecimal のコンストラクタで解釈不能であった場合は、 NumberFormatException がスローされる。


タグがサポートする属性

DecimalTag では、以下の属性をサポートする。

属性名 デフォルト値 必須性 実行時式 概要
id なし false false フォーマットされた文字列をレスポンスへ出力せずに、 スクリプティング変数にセットする際に指定する。 フォーマットされた文字列をスクリプティング変数にセットする場合には、 filter 属性の指定に関わらずHTML 特殊文字はエスケープされない。
filter true false true フォーマットされた文字列を出力する際に、HTML特殊文字を エスケープするかどうかを指定する。ただし、id 属性が 指定されていた場合には、無視される。
ignore false false true name 属性で指定した beanが 見つからなかったときに無視するかどうかを指定する。false を 指定すると、beanが見つからなかったときに JspException が投げられる。
name なし false true フォーマット対象の文字列をプロパティに持つbeanの名前。 property 属性が指定されていなかったときには、 name 属性で指定されたインスタンス がフォーマットの対象となる。この場合は、そのインスタンス自身が java.math.BigDecimal 型であるか、あるいは java.lang.String 型(かつ右側の空白除去後に BigDecimal のコンストラクタによって解釈可能であるもの) のどちらかである必要がある。value 属性が指定されていた場合には、無視される。
property なし false true name 属性で指定された bean においてアクセスされるプロパティの名前。value 属性が 指定されていた場合には無視される。
scope findAttribute() メソッドの検索順序) false true name 属性で指定されたbean を検索する際のスコープ。
value なし false true フォーマットする文字列。文字列は、右側の空白除去後に BigDecimal のコンストラクタによって解釈可能である必要がある。value 属性を指定した場合には、name 属性、および property 属性は無視される。
pattern なし true true フォーマットする出力形式。pattern 属性で指定した出力形式は、DecimalFormat クラスのパターンとして解釈される。詳細は、DecimalFormat クラスのドキュメントを参照のこと。
scale なし false true 丸め動作後の小数点以下桁数。n を指定した場合には、小数第 n + 1 位が丸められる。 丸めモードはround属性で指定する。round 属性が指定されていない場合は、四捨五入が行われる。
round なし false true 丸めモード。scale属性が 指定されている時、有効になる。ROUND_HALF_UP(四捨五入)、 ROUND_FLOOR(切り捨て)、ROUND_CEILING (切り上げ)が 設定可能である。デフォルトはROUND_HALF_UP が実行される。これら3つの設定以外を指定した場合は、 IllegalArgumentExceptionがスローされる。
カスタムタグのスクリプティング変数

DecimalTag では以下の変数をサポートする。

変数名 有効範囲 記述
カスタムタグの id 属性で指定された名前 String 開始タグ以降 このカスタムタグで出力せず、スクリプティング変数へ 設定する場合の変数名。

関連項目:
直列化された形式

フィールドの概要
protected  boolean filter
          HTML特殊文字を出力する際にフィルターするかどうか。
protected  java.lang.String id
          そのページ内で利用できるようにするためのスクリプティング変数の名前。
protected  boolean ignore
          beanが見つからなかったときに、単に無視する(何も出力しない)かどうか。
private static org.apache.commons.logging.Log log
          ログクラス。
protected  java.lang.String name
          フォーマット対象のデータを含むbeanの名前。
protected  java.lang.String pattern
          出力のフォーマットを指定するパターン。
protected  java.lang.String property
          指定されたbeanにおいてアクセスされるプロパティの名前。
protected  java.lang.String round
          丸めモード。
protected  int scale
          四捨五入後の小数点以下の桁数。
protected  java.lang.String scope
          指定されたbeanを検索するスコープ。
private static long serialVersionUID
          シリアルバージョンID
protected  java.lang.String value
          フォーマット対象の値(文字列)。
 
クラス javax.servlet.jsp.tagext.TagSupport から継承されたフィールド
pageContext
 
インタフェース javax.servlet.jsp.tagext.IterationTag から継承されたフィールド
EVAL_BODY_AGAIN
 
インタフェース javax.servlet.jsp.tagext.Tag から継承されたフィールド
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
コンストラクタの概要
DecimalTag()
           
 
メソッドの概要
 int doStartTag()
          タグ評価開始時に呼ばれるメソッド。
 boolean getFilter()
          出力中のHTML特殊文字をフィルターするかどうかを取得する。
 java.lang.String getId()
          スクリプティング変数の名前を取得する。
 boolean getIgnore()
          beanが見つからなかった場合に無視するかどうかを取得する。
 java.lang.String getName()
          フォーマット対象のデータを含むbeanの名前を取得する。
 java.lang.String getPattern()
          出力のフォーマットを指定するパターンを取得する。
 java.lang.String getProperty()
          指定されたbeanにおいてアクセスされるプロパティの名前を取得する。
 java.lang.String getRound()
          丸めモードを取得する。
 int getScale()
          四捨五入後の小数点以下の桁数を取得する。
 java.lang.String getScope()
          指定されたbeanを検索するスコープを取得する。
 java.lang.String getValue()
          フォーマット対象の値を取得する。
 void release()
          すべてのアロケートされた資源を解放する。
 void setFilter(boolean filter)
          出力中のHTML特殊文字をフィルターするかどうかを設定する。
 void setId(java.lang.String id)
          スクリプティング変数の名前を設定する。
 void setIgnore(boolean ignore)
          beanが見つからなかった場合に無視するかどうかを設定する。
 void setName(java.lang.String name)
          フォーマット対象のデータを含むbeanの名前を設定する。
 void setPattern(java.lang.String pattern)
          出力のフォーマットを指定するパターンを設定する。
 void setProperty(java.lang.String property)
          指定されたbeanにおいてアクセスされるプロパティの名前を設定する。
 void setRound(java.lang.String round)
          丸めモードを設定する。
 void setScale(int scale)
          四捨五入後の小数点以下の桁数を設定する。
 void setScope(java.lang.String scope)
          指定されたbeanを検索するスコープを設定する。
 void setValue(java.lang.String value)
          フォーマット対象の値を設定する。
 
クラス javax.servlet.jsp.tagext.TagSupport から継承されたメソッド
doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

serialVersionUID

private static final long serialVersionUID
シリアルバージョンID

関連項目:
定数フィールド値

log

private static org.apache.commons.logging.Log log
ログクラス。


id

protected java.lang.String id
そのページ内で利用できるようにするためのスクリプティング変数の名前。


filter

protected boolean filter
HTML特殊文字を出力する際にフィルターするかどうか。デフォルトは true


ignore

protected boolean ignore
beanが見つからなかったときに、単に無視する(何も出力しない)かどうか。 無視しない場合には、例外を投げる。デフォルトは false (例外を投げる)。


name

protected java.lang.String name
フォーマット対象のデータを含むbeanの名前。


property

protected java.lang.String property
指定されたbeanにおいてアクセスされるプロパティの名前。


scope

protected java.lang.String scope
指定されたbeanを検索するスコープ。


pattern

protected java.lang.String pattern
出力のフォーマットを指定するパターン。 DecimalFormat と同じ書式で指定する。


value

protected java.lang.String value
フォーマット対象の値(文字列)。


scale

protected int scale
四捨五入後の小数点以下の桁数。n を指定した場合には、 小数第 n + 1 位が四捨五入される。


round

protected java.lang.String round
丸めモード。

コンストラクタの詳細

DecimalTag

public DecimalTag()
メソッドの詳細

getId

public java.lang.String getId()
スクリプティング変数の名前を取得する。

オーバーライド:
クラス javax.servlet.jsp.tagext.TagSupport 内の getId
戻り値:
スクリプティング変数

setId

public void setId(java.lang.String id)
スクリプティング変数の名前を設定する。

オーバーライド:
クラス javax.servlet.jsp.tagext.TagSupport 内の setId
パラメータ:
id - スクリプティング変数の名前

getFilter

public boolean getFilter()
出力中のHTML特殊文字をフィルターするかどうかを取得する。

戻り値:
出力中のHTML特殊文字をフィルターする場合は true

setFilter

public void setFilter(boolean filter)
出力中のHTML特殊文字をフィルターするかどうかを設定する。

パラメータ:
filter - 出力中のHTML特殊文字をフィルターする場合は true

getIgnore

public boolean getIgnore()
beanが見つからなかった場合に無視するかどうかを取得する。

戻り値:
無視する場合は true

setIgnore

public void setIgnore(boolean ignore)
beanが見つからなかった場合に無視するかどうかを設定する。

パラメータ:
ignore - 無視する場合は true

getName

public java.lang.String getName()
フォーマット対象のデータを含むbeanの名前を取得する。

戻り値:
beanの名前

setName

public void setName(java.lang.String name)
フォーマット対象のデータを含むbeanの名前を設定する。

パラメータ:
name - beanの名前

getProperty

public java.lang.String getProperty()
指定されたbeanにおいてアクセスされるプロパティの名前を取得する。

戻り値:
指定されたbeanにおいてアクセスされるプロパティの名前

setProperty

public void setProperty(java.lang.String property)
指定されたbeanにおいてアクセスされるプロパティの名前を設定する。

パラメータ:
property - 指定されたbeanにおいてアクセスされるプロパティの名前

getScope

public java.lang.String getScope()
指定されたbeanを検索するスコープを取得する。

戻り値:
スコープ

setScope

public void setScope(java.lang.String scope)
指定されたbeanを検索するスコープを設定する。

パラメータ:
scope - 指定されたbeanを検索するスコープ

getPattern

public java.lang.String getPattern()
出力のフォーマットを指定するパターンを取得する。

戻り値:
出力のフォーマットを指定するパターン

setPattern

public void setPattern(java.lang.String pattern)
出力のフォーマットを指定するパターンを設定する。

パラメータ:
pattern - パターン

getValue

public java.lang.String getValue()
フォーマット対象の値を取得する。

戻り値:
フォーマット対象の値

setValue

public void setValue(java.lang.String value)
フォーマット対象の値を設定する。

パラメータ:
value - フォーマット対象の値

getScale

public int getScale()
四捨五入後の小数点以下の桁数を取得する。

戻り値:
小数点以下の桁数

setScale

public void setScale(int scale)
四捨五入後の小数点以下の桁数を設定する。

パラメータ:
scale - 小数点以下の桁数

getRound

public java.lang.String getRound()
丸めモードを取得する。

戻り値:
丸めモード

setRound

public void setRound(java.lang.String round)
丸めモードを設定する。

パラメータ:
round - 丸めモード

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
タグ評価開始時に呼ばれるメソッド。

定義:
インタフェース javax.servlet.jsp.tagext.Tag 内の doStartTag
オーバーライド:
クラス javax.servlet.jsp.tagext.TagSupport 内の doStartTag
戻り値:
処理制御指示。常に SKIP_BODY
例外:
javax.servlet.jsp.JspException - JSP例外

release

public void release()
すべてのアロケートされた資源を解放する。

定義:
インタフェース javax.servlet.jsp.tagext.Tag 内の release
オーバーライド:
クラス javax.servlet.jsp.tagext.TagSupport 内の release