org.opengion.hayabusa.develop

## クラス AbstractJspCreate

- java.lang.Object
- - org.opengion.hayabusa.develop.AbstractJspCreate

- すべての実装されたインタフェース:
    JspParserFilter
  直系の既知のサブクラス:
    JspCreate_COLUMN, JspCreate_COMMENT, JspCreate_ORDER_BY, JspCreate_QUERY, JspCreate_TABLE_UPDATE, JspCreate_VIEW

      public abstract class AbstractJspCreate
      extends Object
      implements JspParserFilter

       コンストラクタに引数で与えられたマスタデータ情報を元に、特定のJSPタグ情報を生成する基底クラス。
       マスタデータ情報はGF92のNMSYORIカラムの種別毎にJspConvertEntityオブジェクトに事前に準備する必要がある。

       例)
       JspConvertEntity e = new JspConvertEntity("RESULT");
       e.setTableName("GF92");
       e.setColumnName("NMSYORI");

       継承先のクラスのexecuteメソッドでは、引数のマスタデータ情報からJSPタグの文字列を生成する処理を実装します。

  作成者
    Takeshi.Takada

- - ### フィールドのサマリー

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `protected static int` | `BUFFER_MIDDLE` StringBilderなどの初期値を設定します。
    `protected static String` | `CR` システムの改行コードを設定します。
    `static String` | `T1` タブを定数化しておきます。
    `static String` | `T2`
    `static String` | `T3`

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

    コンストラクタ
    修飾子 | コンストラクタと説明
    --- | ---
    `protected` | `AbstractJspCreate(String key, String names)` タグ名とファイル名を指定するコンストラクター タグ名は、og:XXXX , :XXX , XXX いづれの形式でも可能です。

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド abstractメソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `protected String` | `chainChar(List list, String sep)` 引数のリストを連結文字列で連結した文字列を作成して返します。
    `protected abstract String` | `execute(OGElement ele, String nameSpace)` JSPに出力するタグの内容を作成します。
    `OGDocument` | `filter(OGDocument doc)` ドキュメントオブジェクト を変換します。
    `protected abstract void` | `init(Map master)` 初期化メソッド 内部で使用する JspConvertEntity の List のマップを受け取り、初期化を行います。
    `protected boolean` | `isExecute(String name)` ファイル名から、処理対象かどうかを判断します。
    `protected boolean` | `isNotEmpty(List list)` 指定のListオブジェクトが null でなく、かつ、空でないか、判定する。

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

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### フィールドの詳細

    - #### T1

          public static final String T1

      タブを定数化しておきます。
      関連項目:
        定数フィールド値

    - #### T2

          public static final String T2

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

    - #### T3

          public static final String T3

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

    - #### CR

          protected static final String CR

      システムの改行コードを設定します。

    - #### BUFFER_MIDDLE

          protected static final int BUFFER_MIDDLE

      StringBilderなどの初期値を設定します。 200
      関連項目:
        定数フィールド値

  - ### コンストラクタの詳細

    - #### AbstractJspCreate

          protected AbstractJspCreate(String key,
                                      String names)

      タグ名とファイル名を指定するコンストラクター タグ名は、og:XXXX , :XXX , XXX いづれの形式でも可能です。部分一致で判断するので、 og固定にしないのであれば、:XXX 形式で指定するのが良いと思います。 ファイル名(names)は、拡張子なしのファイル名(index,query,result,・・・)などになります。 先に指定しているファイル名と部分一致(大文字小文字は区別)するかどうかで判定します。
      パラメータ:
        `key` - タグ名の指定(og:XXXX , :XXX , XXX いづれの形式でも可)
        `names` - 処理対象のファイル名(複数のファイル名をCSV形式で指定可能)
      変更履歴:

        6.3.9.1 (2015/11/27) コンストラクタを用意して、KEY,NAME をセットするように変更します。

  - ### メソッドの詳細

    - #### isExecute

          protected boolean isExecute(String name)

      ファイル名から、処理対象かどうかを判断します。 ファイル名は、拡張子なしのファイル名(index,query,result,・・・)などになります。 先に指定しているファイル名と部分一致するかどうかで判定します。
      パラメータ:
        `name` - 処理対象のファイル名
      戻り値:
        処理対象なら true/ そうでなければ、false
      変更履歴:

        5.6.1.2 (2013/02/22) NAME は、複数のファイル名をCSV形式で与えられるように変更。

    - #### init

          protected abstract void init(Map master)

      初期化メソッド 内部で使用する JspConvertEntity の List のマップを受け取り、初期化を行います。
      パラメータ:
        `master` - JspConvertEntityのリストのマップ

    - #### execute

          protected abstract String execute(OGElement ele,
                                            String nameSpace)
                                     throws Throwable

      JSPに出力するタグの内容を作成します。 引数より作成前のタグの属性内容を確認するする事が出来ます。
      パラメータ:
        `ele` - エレメントオブジェクト
        `nameSpace` - このドキュメントのnameSpace( og とか mis とか )
      戻り値:
        変換された文字列
      例外:
        `Throwable` - 変換時のエラー
      変更履歴:

        5.2.1.0 (2010/10/01) メソッドの引数を、OGAttributes から OGElement に変更します。

    - #### filter

          public OGDocument filter(OGDocument doc)

      ドキュメントオブジェクト を変換します。 引数に null が設定された場合も、正常に処理を行います。(return null とする) 後続処理を行いたくない場合にも、null を返します。
      定義:
        `filter` インタフェース内 `JspParserFilter`
      パラメータ:
        `doc` - 処理を行う ドキュメントオブジェクト
      戻り値:
        処理した結果の ドキュメントオブジェクト
      関連項目:
        `JspParserFilter.filter( OGDocument )`
      変更履歴:

        5.2.1.0 (2010/10/01) メソッドの引数を、OGAttributes から OGElement に変更します。
        6.4.2.0 (2016/01/29) ex.printStackTrace() を、ThrowUtil#ogStackTrace(Throwable) に置き換え。

    - #### chainChar

          protected String chainChar(List list,
                                     String sep)

      引数のリストを連結文字列で連結した文字列を作成して返します。
      パラメータ:
        `list` - 処理を行うドキュメントリスト
        `sep` - 連結する区切り文字
      戻り値:
        連結された文字列
      このメソッドは、nullを返しません

    - #### isNotEmpty

          protected boolean isNotEmpty(List list)

      指定のListオブジェクトが null でなく、かつ、空でないか、判定する。
      パラメータ:
        `list` - 、判定するListオブジェクト
      戻り値:
        nullでなく、かつ、空でない場合、true
      変更履歴:

        5.2.1.0 (2010/10/01) 新規追加

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.