org.opengion.fukurou.xml

## クラス TagElement

- java.lang.Object
- - org.opengion.fukurou.xml.TagElement

-     public class TagElement
      extends Object

       このクラスは、XMLファイルのタグエレメントを表すオブジェクトです。
       タグとしては、コンストラクタにMapを指定すれば(defaultMap)タグのカラムを
       初期設定します。この場合、Map に LinkedHashMap を指定すれば、カラムの
       順番も指定順になります。
       ここで指定したMapの値は、put メソッドにより上書きされます。
       setAfterMap で指定したMapは、既存の内部情報を上書きします。キーがあれば、
       afterMap の値が上書きされ、キーが無ければ新規にキーが追加されます。
       一般には、XMLファイルから構築された後で、XMLファイルの情報を一括して
       書き換える場合などに使用します。
       処理の途中にセットした場合は、それまでの値が上書きされ、それ以降の値は、
       put により設定された値が 優先されます。
       toString() により、簡易的に オラクルＸＤＫ形式のＸＭＬファイルの
       １レコード 分の情報を返します。
       オラクルＸＤＫ形式のＸＭＬファイルとは、下記のような ROWSET をトップとする ROW の
       集まりで１レコードを表し、各ROWには、カラム名をキーとするXMLになっています。

         <ROWSET>
             <ROW num="1">                         ← この部分のみ
                 <カラム1>値1</カラム1>      ← この部分のみ
                   ･･･                                   ← この部分のみ
                 <カラムn>値n</カラムn>      ← この部分のみ
             </ROW>                                ← この部分のみ
              ･･･
             <ROW num="n">
                ･･･
             </ROW>
         <ROWSET>

       この形式であれば、XDK(Oracle XML Developer's Kit)を利用すれば、非常に簡単に
       データベースとXMLファイルとの交換が可能です。

       XDK(Oracle XML Developer's Kit)

  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

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

    コンストラクタ
    コンストラクタと説明
    `TagElement(String name)` Tag名を指定して、オブジェクトを構築します。
    `TagElement(String name, Map defaultMap)` Tag名と初期化マップを指定して、オブジェクトを構築します。

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `String` | `get(String key)` キーを指定して値を取得します。
    `String` | `getBody()` BODY部の文字列を取得します。
    `String[]` | `getKeys()` カラムの配列を返します。
    `String` | `getName()` Tag名を取得します。
    `String` | `getRowNo()` 行番号を取得します。
    `String[]` | `getValues()` カラム配列の順と同じ、値の配列を返します。
    `String[]` | `getValues(List clms)` 引数のカラム名のListの順番で、カラム配列の値の配列を返します。
    `String[]` | `getValues(String[] clms)` 引数のカラム名の配列の順番で、カラム配列の値の配列を返します。
    `void` | `put(String key, String val)` カラムと値のペアを登録します。
    `void` | `setAfterMap(Map afterMap)` すでに構築済みの カラムと値に、上書きで マップ情報を追加します。
    `void` | `setBody(String body)` BODY部の文字列を設定します。
    `void` | `setRowNo(String num)` 行番号を設定します。
    `String` | `toString()` 内部情報の文字列表現を返します。

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

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

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

    - #### TagElement

          public TagElement(String name)

      Tag名を指定して、オブジェクトを構築します。
      パラメータ:
        `name` - Tag名

    - #### TagElement

          public TagElement(String name,
                            Map defaultMap)

      Tag名と初期化マップを指定して、オブジェクトを構築します。
      パラメータ:
        `name` - Tag名
        `defaultMap` - 初期化マップ
      変更履歴:

        6.4.3.1 (2016/02/12) Collections.synchronizedMap に置き換え。ついでに変数名変更。

  - ### メソッドの詳細

    - #### getName

          public String getName()

      Tag名を取得します。
      戻り値:
        Tag名

    - #### put

          public void put(String key,
                          String val)

      カラムと値のペアを登録します。 すでに 内部に同一カラムが存在する場合は、値の書き換えを、カラムが 存在しない場合は、カラムの追加を行います。 カラムは、追加された順番を再現してXML化できます。
      パラメータ:
        `key` - カラム
        `val` - 値
      変更履歴:

        5.6.6.1 (2013/07/12) key が null や ゼロ文字列の場合は、Map に追加しません。
        6.4.3.1 (2016/02/12) Collections.synchronizedMap に置き換え。ついでに変数名変更。

    - #### setAfterMap

          public void setAfterMap(Map afterMap)

      すでに構築済みの カラムと値に、上書きで マップ情報を追加します。 すでに 内部に同一カラムが存在する場合は、値の書き換えを、カラムが 存在しない場合は、カラムの追加を行います。 カラムは、追加された順番を再現してXML化できます。
      パラメータ:
        `afterMap` - 後設定マップ
      変更履歴:

        6.4.3.1 (2016/02/12) Collections.synchronizedMap に置き換え。ついでに変数名変更。

    - #### get

          public String get(String key)

      キーを指定して値を取得します。
      パラメータ:
        `key` - カラム
      戻り値:
        値
      変更履歴:

        6.4.3.1 (2016/02/12) Collections.synchronizedMap に置き換え。ついでに変数名変更。

    - #### getRowNo

          public String getRowNo()

      行番号を取得します。
      戻り値:
        値

    - #### setRowNo

          public void setRowNo(String num)

      行番号を設定します。
      パラメータ:
        `num` - 値

    - #### getBody

          public String getBody()

      BODY部の文字列を取得します。
      戻り値:
        値

    - #### setBody

          public void setBody(String body)

      BODY部の文字列を設定します。
      パラメータ:
        `body` - 値

    - #### getKeys

          public String[] getKeys()

      カラムの配列を返します。
      戻り値:
        カラムの配列(順序は、カラムの登録順)
      変更履歴:

        6.4.3.1 (2016/02/12) Collections.synchronizedMap に置き換え。ついでに変数名変更。

      このメソッドは、nullを返しません

    - #### getValues

          public String[] getValues()

      カラム配列の順と同じ、値の配列を返します。
      戻り値:
        値の配列(順序は、カラムの登録順と一致しています。)
      変更履歴:

        6.4.3.1 (2016/02/12) Collections.synchronizedMap に置き換え。ついでに変数名変更。

      このメソッドは、nullを返しません

    - #### getValues

          public String[] getValues(List clms)

      引数のカラム名のListの順番で、カラム配列の値の配列を返します。
      パラメータ:
        `clms` - カラム名のListオブジェクト
      戻り値:
        値の配列(順序は、カラムの登録順と一致しています。)
      変更履歴:

        6.4.3.1 (2016/02/12) Collections.synchronizedMap に置き換え。ついでに変数名変更。

    - #### getValues

          public String[] getValues(String[] clms)

      引数のカラム名の配列の順番で、カラム配列の値の配列を返します。 カラム名が、存在しない場合は、値は、null を返します。
      パラメータ:
        `clms` - カラム名の文字列配列(可変長引数)
      戻り値:
        値の配列(順序は、カラムの配列順と一致しています。)
      変更履歴:

        6.4.3.1 (2016/02/12) Collections.synchronizedMap に置き換え。ついでに変数名変更。

    - #### toString

          public String toString()

      内部情報の文字列表現を返します。 １レコード分を表す ROW のXML表現を作成します。前後に、ROWSET を 追加すれば、オラクルXDK形式のXMLを作成できます。
      オーバーライド:
        `toString` クラス内 `Object`
      戻り値:
        内部情報の文字列表現
      このメソッドは、nullを返しません

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