com.hamaf.hikyaku.ui
クラス StandardDetailProcess

java.lang.Object
  上位を拡張 com.hamaf.hikyaku.ui.ProcessBase
      上位を拡張 com.hamaf.hikyaku.ui.StandardDetailProcess
直系の既知のサブクラス:
GroupModIni, InitModIni, MessageDelIni, PluginDeleteIni, PossibleModIni, UserModIni, UserSelfModIni

public abstract class StandardDetailProcess
extends ProcessBase

タイトル: StandardDetailProcess 標準詳細表示処理 ProcessBase.

説明:詳細項目表示用のProcessBase拡張クラス。


以下の処理を記述します
メッソド名 必須/任意 概略
newDataObj 必須 詳細取得用のDetaObejctを生成して戻す
callControl 必須 処理コントロールの呼び出しを行う
setJspMapping 任意 DetaObjectの項目番号とJSPの項目名称の紐付けクラスを登録する
DiContainarにより、コンストラクターで_jimに設定する場合は不要です。
setItems 任意 DetaObjectの項目番号とJSPの項目名称の紐付けを登録する
上記、setJspMappingで設定する場合は不要です。
setKeys 任意 DetaObejctCommonMessageからPrimaryKey値を設定する このメソッドの戻り値はtrueを指定します。
setPrimaryValue 任意 DetaObejctKeyListのkey値(List)からPrimaryKey値を設定する
editItems 任意 編集を行う項目をレスポンス領域に設定する

DiContainerを利用する場合、コンストラクタで以下の引数が設定可能です。

Created: Mon Feb 21 13:39:36 2005

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

フィールドの概要
protected  JspItemsMapping _jim
          _jim a JspItemsMapping : JSP項目名称:データオブジェクト項目対応クラス
 
クラス com.hamaf.hikyaku.ui.ProcessBase から継承されたフィールド
clnm, controlXml, log, msgHed, process, request, resource, response, saveObj, sconfig, session, sysId
 
コンストラクタの概要
StandardDetailProcess()
           
 
メソッドの概要
protected  void addItem(java.lang.String jspnm, int pos)
          Describe addItem method : 取得項目番号:表示項目名称用Mapへの登録.
protected abstract  DetailItemsInterface callControl(DetailItemsInterface dii)
          Describe callControl method : コントロールクラスを呼び出す.
protected  CommonMessage editItems(CommonMessage msg)
          Describe editItems method : 項目編集処理.
 CommonMessage exec(CommonMessage msg)
          Describe exec method : 詳細表示用の項目取得処理を行う.
protected abstract  DetailItemsInterface newDataObj()
          Describe newDataObj method : 詳細用DataObjectの生成.
protected  void setItems()
          Describe setItems method : 処理項目の登録処理.
protected  JspItemsMapping setJspMapping()
          Describe setJspMapping method : JSPマッピングの設定を行う.
protected  boolean setKeys(DetailItemsInterface dii, CommonMessage msg)
          Describe setKeys method : DataObjectのKey項目をメッセージより設定する.
protected  void setPrimaryValue(DetailItemsInterface dii, java.util.List<java.lang.String> key, java.util.List<java.lang.String> keyFld)
          Describe setPrimaryValue method : DetaObjectにPrimaryKey値を設定する.
 
クラス com.hamaf.hikyaku.ui.ProcessBase から継承されたメソッド
finish, getUerDto, getUserID, init, newCommonMessage, setSconfig
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

_jim

protected JspItemsMapping _jim
_jim a JspItemsMapping : JSP項目名称:データオブジェクト項目対応クラス

コンストラクタの詳細

StandardDetailProcess

public StandardDetailProcess()
メソッドの詳細

exec

public final CommonMessage exec(CommonMessage msg)
                         throws java.lang.Exception
Describe exec method : 詳細表示用の項目取得処理を行う.
  1. setItems()を呼び出し、_items(Map)を設定する。
  2. setGetKey()より、検索キーが設定されているDataObjectを取得する。
  3. DataObjectに取得項目を_itemより設定する。
  4. callControl()にてコントロール処理クラスの呼び出しを行う。
  5. DataObjectの内容をレスポンス領域に設定する。
  6. 編集項目の設定処理editItemsを呼び出す。

定義:
クラス ProcessBase 内の exec
パラメータ:
commonMessage - a CommonMessage :
戻り値:
a CommonMessage :
例外:
java.lang.Exception - if an error occurs

newDataObj

protected abstract DetailItemsInterface newDataObj()
Describe newDataObj method : 詳細用DataObjectの生成.
詳細データ取得用のDataObjectを生成する。
基本的には、
return new _DetailDTO_();
となります。

戻り値:
a DetailItemsInterface : DataObject

addItem

protected final void addItem(java.lang.String jspnm,
                             int pos)
Describe addItem method : 取得項目番号:表示項目名称用Mapへの登録.
_items(Map)に項目番号とJSPでの項目名の紐付けを登録する。
  1. key : JSPで指定されている項目の名称(String)
  2. value : DetailItemsInterface実装クラスの項目番号

パラメータ:
jspnm - a String : JSPでの項目名称
pos - an int : データObjectで定義されている項目位置

setJspMapping

protected JspItemsMapping setJspMapping()
Describe setJspMapping method : JSPマッピングの設定を行う.
(DiContainaerを使用しコンストラクターで設定する場合は、不要です。)
JspItemsMappingの継承クラスをインスタンス化し、戻す。
return new xxxMapping();


setItems

protected void setItems()
Describe setItems method : 処理項目の登録処理.
(JspItemsMappingの拡張クラスを使用する場合は、setJspMappingを利用します)
処理する項目のDeataObjectの定義値(int)とJSPでの名称との 紐付けを登録する。
基本的には
addItem(DataObject.ITEM_NAME, "JSPでの項目名");
にて必要項目分、紐付け登録を行う。


callControl

protected abstract DetailItemsInterface callControl(DetailItemsInterface dii)
                                             throws java.lang.Exception
Describe callControl method : コントロールクラスを呼び出す.
コントロールクラスを呼び出し、戻り値のDetaObjectを戻す。
  1. _Process_Control xcntl = new _Process_Control();
  2. return xcntl.getDetail(dii);

パラメータ:
dii - a DetailItemsInterface :
dii - a DetailItemsInterface :
戻り値:
a DetailItemsInterface :
例外:
java.lang.Exception - if an error occurs

setKeys

protected boolean setKeys(DetailItemsInterface dii,
                          CommonMessage msg)
Describe setKeys method : DataObjectのKey項目をメッセージより設定する.
CommonMessageの内容により、取得するデータのPrimaryKey値を設定する。
設定した場合は、trueを戻り値として戻す。
KeyListからではなく、リクエストの項目より取得するデータのPrimaryKey値を設定する場合に、このメッソドをオーバーライドします。

パラメータ:
dii - a DetailItemsInterface :
msg - a CommonMessage :
戻り値:
a boolean : trueを戻す。

setPrimaryValue

protected void setPrimaryValue(DetailItemsInterface dii,
                               java.util.List<java.lang.String> key,
                               java.util.List<java.lang.String> keyFld)
Describe setPrimaryValue method : DetaObjectにPrimaryKey値を設定する.
KeyList Objectに保存してある値をDetaObejctのKey項目へ設定する
DetaObjectでPrimaryKey項目が0番目より順番に定義され、
KeyListに保存されているKeyがPrimaryKey項目の場合には、
そのまま使用できます。
上記以外の場合には、overrideして、Key値の設定を行います。
PrimariKey項目が1つだけの場合は、
  1. dii.setItemValue(_DataObject_.KEY_ITEM, (String)key.get(0));
となります。

パラメータ:
dii - a DetailItemsInterface :
key - a List<String> : KeyList上の該当位置のオブジェクト
keyFld - a List<String> : キー項目名称のリスト

editItems

protected CommonMessage editItems(CommonMessage msg)
                           throws java.lang.Exception
Describe editItems method : 項目編集処理.
編集して表示する項目をレスポンス領域に設定する場合、overrideする。

パラメータ:
msg - a CommonMessage :
戻り値:
a CommonMessage :
例外:
java.lang.Exception - if an error occurs