com.hamaf.hikyaku.extension
インタフェース MasterXmlControl

既知の実装クラスの一覧:
MasterXmlCntlImpl

public interface MasterXmlControl

タイトル:MasterXmlControl is Maste Data Xml File Controler interface.

説明:マスタ用XmlFileの操作を行う。


XMLの形式な以下のタグ構成とすること
   <_roottag_>
     <_const_>...
     <_const2_>...
       ・
       ・
     <_item_s>
       <_item_>
         <_item_Code>...
         <_item_Name>...
         <_任意のタグ_>...
         ・
         ・
       
       <_item_>
            ・
            ・
       
     
     <_item2_s>
          ・
          ・
     
   
   注)_付の名称は自由に指定できます。
 

サポートしているメソッド
読み込むXML Fileは飛脚制御ファイルにタグ名<MasterXml>で指定されたものを使用する。

著作権: Copyright (c) 2004/08/25

バージョン:
1.0
作成者:
y-hamanaka

メソッドの概要
 java.lang.String getConstant(java.lang.String constTag)
          Describe getConstant method : return child tag value.
 java.util.List<java.lang.String[]> getItemsList(java.lang.String item)
          Describe getItemsList method : return item code,name list.
 java.util.Map<java.lang.String,java.lang.String> getItemValue(java.lang.String item, java.lang.String code)
          Describe getItemValue method : return select tag,value Map.
 java.lang.String getTagValue(java.lang.String item, java.lang.String code, java.lang.String tag)
          Describe getTagValue method : return tag value.
 

メソッドの詳細

getConstant

java.lang.String getConstant(java.lang.String constTag)
                             throws java.lang.IllegalStateException,
                                    java.lang.IllegalArgumentException
Describe getConstant method : return child tag value.
ルートタグの直下にある指定されたタグの値を戻す。

パラメータ:
constTag - a String : 値を取得するタグ名
戻り値:
a String : 該当タグの値
例外:
java.lang.IllegalStateException - : マスタXMLが保持されていない場合
java.lang.IllegalArgumentException - if an error occurs

getItemsList

java.util.List<java.lang.String[]> getItemsList(java.lang.String item)
                                                throws java.lang.IllegalStateException,
                                                       java.lang.IllegalArgumentException
Describe getItemsList method : return item code,name list.
指定されたItemタグに含まれているコードと名称のString配列をListにして戻す。

パラメータ:
item - a String : 取得する親タグ名
戻り値:
a List : Code,Nameがセットされたリスト
例外:
java.lang.IllegalStateException - : マスタXMLが保持されていない場合
java.lang.IllegalArgumentException - if an error occurs

getItemValue

java.util.Map<java.lang.String,java.lang.String> getItemValue(java.lang.String item,
                                                              java.lang.String code)
                                                              throws java.lang.IllegalStateException,
                                                                     java.lang.IllegalArgumentException
Describe getItemValue method : return select tag,value Map.
指定したタグ内でコード値が一致するCOdeTagと同一レベルにあるtagの名称と値のMapを戻す。

パラメータ:
item - a String : 取得するタグ
code - a String : 該当データのコード値
戻り値:
a Map : タグ名称と値のMAP
例外:
java.lang.IllegalStateException - : マスタXMLが保持されていない場合
java.lang.IllegalArgumentException - if an error occurs

getTagValue

java.lang.String getTagValue(java.lang.String item,
                             java.lang.String code,
                             java.lang.String tag)
Describe getTagValue method : return tag value.
指定したItem内でcode値が一致するCodeTagと同一レベルにあるtagの値を戻す。

パラメータ:
item - a String : 取得するItemの名称
code - a String : 該当データのコード値
tag - a String : 値を取得するTag名
戻り値:
a String : 取得した値