パッケージ org.opengion.hayabusa.taglib

クラス AppearTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
jakarta.servlet.jsp.tagext.BodyTagSupport
org.opengion.hayabusa.taglib.CommonTagSupport
org.opengion.hayabusa.taglib.AppearTag
すべての実装されたインタフェース:
BodyTag, IterationTag, JspTag, Tag, TryCatchFinally, Serializable
public class AppearTag extends CommonTagSupport
指定された value 値の{@XXXX} 変数が設定された場合のみ表示するタグです。 value 値に、{@XXXX} 変数を使用して、リクエスト値が設定された場合のみ その値を表示します。これは、{@XXXX} 変数と固定値を組み合わせた場合でも 同様に、値が設定されていない場合は、使用されません。 defaultVal が設定されており、リクエスト値が設定されていない場合、defaultVal 値が 使用されます。 このタグが使用されるケースの代表は、SQLでの order by 句です。一般のリクエスト時には、 order by 句をリクエストで設定して、ユーザーが検索する時に、切り替えができるように します。別画面から、リンク等で画面を呼び出す場合は、通常 order by 句の条件まで、 指定しません。そのような場合に備えて、og:appear タグでdefaultVal 値を設定しておき、 未指定時の検索順を予め指定しておきます。
関連項目:
機能分類
画面部品
形式ｻﾝﾌﾟﾙ:
●形式：<og:appear startKey="[order by|…]" value="…" defaultVal="[…]" /> ●body：なし ●Tag定義 <og:appear startKey 【TAG】開始文字列を設定します(初期値:"") value ○【TAG】値をセットします(指定された値が 設定されている場合のみ使用されます)(必須) defaultVal 【TAG】初期値を設定します(value値がNULLの場合に、この初期値が表示) quotCheck 【TAG】リクエスト情報の シングルクォート(') 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_SQL_INJECTION_CHECK[=true]) xssCheck 【TAG】リクエスト情報の HTMLTag開始/終了文字(><) 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_XSS_CHECK[=true]) debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) /> ●使用例 <!-- DB検索 SQL文記述 debug="true" でSQL文を確認できます。--> <og:query command="{@command}" debug="{@debug}" maxRowCount="{@maxRowCount}"> select CLM,NAME_JA,LABEL_NAME,URL,KBSAKU, SYSTEM_ID,LANG,FGJ,(CASE WHEN URL IS NULL THEN 0 ELSE 1 END) AS ONMARK from GF41 <!-- 検索条件でWhereTagを使用すれば{@xxxx}がNULLの場合、その条件は無視されます。 --> <og:where> <og:and value = "FGJ in ('0','1')" /> <og:and value = "SYSTEM_ID = '{@SYSTEM_ID}'" /> <og:and value = "LANG = '{@LANG}'" /> <og:and value = "CLM like '{@CLM}%'" /> <og:and value = "NAME_JA like '{@NAME_JA}%'" /> <og:and value = "LABEL_NAME like '{@LABEL_NAME}%'" /> <og:and value = "KBSAKU = '{@KBSAKU}'" /> </og:where> <!-- ORDER BY句でAppearTagを使用すれば{@ORDER_BY}がNULLの場合、ORDER BY句は無視されます。 --> <!-- また、{@ORDER_BY}がNULLの場合に、defaultVal属性を指定すれば、その値でORDER BY表示されます。 --> <og:appear startKey = "order by" value = "{@ORDER_BY}" defaultVal = "SYSTEM_ID,CLM,LANG" /> </og:query>
導入されたバージョン:
JDK5.0,

  • コンストラクタの詳細

    • AppearTag

      public AppearTag()
      デフォルトコンストラクター
      変更履歴:
      6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

  • メソッドの詳細

    • doStartTag

      public int doStartTag()
      Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
      定義:
      doStartTag インタフェース内 Tag
      オーバーライド:
      doStartTag クラス内 CommonTagSupport
      戻り値:
      後続処理の指示( EVAL_BODY_BUFFERED )
      変更履歴:
      6.4.8.1 (2016/07/02) xssCheckを、doStartTag に移動

    • doEndTag

      public int doEndTag()
      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
      doEndTag インタフェース内 Tag
      オーバーライド:
      doEndTag クラス内 CommonTagSupport
      戻り値:
      後続処理の指示(EVAL_PAGE)
      変更履歴:
      3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 5.7.8.1 (2014/07/18) quotCheck,xssCheck 追加, 6.4.8.1 (2016/07/02) xssCheckを、doStartTag に移動

    • release2

      protected void release2()
      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
      release2 クラス内 CommonTagSupport
      変更履歴:
      2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加, 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 5.7.8.1 (2014/07/18) quotCheck , xssCheck 追加

    • setStartKey

      public void setStartKey(String val)
      【TAG】開始文字列を設定します(初期値:"")。
      パラメータ:
      val - 開始文字列 (例：startKey="order by")
      説明:
      このキーは、バリューと接続される場合に空白文字を一つ挿入します。

    • setValue

      public void setValue(String val)
      【TAG】値をセットします(指定された値が 設定されている場合のみ使用されます)。
      パラメータ:
      val - 値
      説明:
      指定された値が 設定されている場合のみ、開始文字列(startKey)と組み合わせれて、使用されます。 これは、一般にvalue値が変動する場合に、defaultVal 等に重複する値を 設定したくない場合に使用します。{@XXXX}文字が使用できます。

    • setDefaultVal

      public void setDefaultVal(String val)
      【TAG】value属性に値がセットされていないとき使用する、初期値を指定します。
      パラメータ:
      val - 初期値
      説明:
      value属性に値がセットされていないときに、この初期値を使用します。 8.4.3.0 (2023/03/31) defaultVal の設定値の取り扱い(変更なし) {@XXXX} は、ﾘｸｴｽﾄ変数 ⇒ valueﾀｸﾞｾｯﾄ値 を確認 値がなければ、null となる。… なにも現れない。 通常の固定値は、そのまま使用されるが、""(空文字列)の場合は、 null となる。… なにも現れない。 defaultVal属性を使用しない場合は、 null のままで、なにも現れない。

    • setQuotCheck

      public void setQuotCheck(String flag)
      【TAG】リクエスト情報の シングルクォート(') 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_SQL_INJECTION_CHECK[=])。
      パラメータ:
      flag - クォートチェック [true:する/それ以外:しない]
      関連項目:
      変更履歴:
      4.0.0.0 (2005/08/31) 新規追加
      説明:
      ＳＱＬインジェクション対策の一つとして、暫定的ではありますが、SQLのパラメータに 渡す文字列にシングルクォート(') を許さない設定にすれば、ある程度は防止できます。 数字タイプの引数には、 or 5=5 などのシングルクォートを使用しないコードを埋めても、 数字チェックで検出可能です。文字タイプの場合は、必ず (')をはずして、 ' or 'A' like 'A のような形式になる為、(')チェックだけでも有効です。 (') が含まれていたエラーにする(true)／かノーチェックか(false)を指定します。 (初期値:システム定数のUSE_SQL_INJECTION_CHECK[=])。

    • setXssCheck

      public void setXssCheck(String flag)
      【TAG】リクエスト情報の HTMLTag開始/終了文字(><) 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_XSS_CHECK[=])。
      パラメータ:
      flag - XSSチェック [true:する/false:しない]
      関連項目:
      変更履歴:
      5.0.0.2 (2009/09/15) 新規追加
      説明:
      クロスサイトスクリプティング(XSS)対策の一環としてless/greater than signについてのチェックを行います。 (><) が含まれていたエラーにする(true)／かノーチェックか(false)を指定します。 (初期値:システム定数のUSE_XSS_CHECK[=])。

    • toString

      public String toString()
      このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
      オーバーライド:
      toString クラス内 CommonTagSupport
      戻り値:
      このクラスの文字列表現
      このﾒｿｯﾄﾞは、nullを返しません