com.hamaf.hikyaku.ui
クラス StandardListProcess

java.lang.Object
  上位を拡張 com.hamaf.hikyaku.ui.ProcessBase
      上位を拡張 com.hamaf.hikyaku.ui.ListProcessBase
          上位を拡張 com.hamaf.hikyaku.ui.StandardListProcess
直系の既知のサブクラス:
CommonSelectList, ExistSearch, GroupList, GroupSelect, InitSearch, MessageList, PossibleList, UserList

public abstract class StandardListProcess
extends ListProcessBase

タイトル: StandardListProcess 標準一覧表示用 ListProcess.

説明:一覧表示用のListProcessBase拡張クラス。


以下の処理を記述します
メッソド名 必須/任意 概略
setRetrieveVal 必須 検索用DetaObjectに検索条件を設定する
findKeys 必須 コントロール処理を呼び出し検索結果のDetaObjectを戻す
newDataObj 必須 詳細取得用のDetaObejctを生成して戻す
callControl 必須 処理コントロールの呼び出しを行う
checkDelete 必須 削除データかのチェックを行う
getCheckFolder 任意 検索項目の項目チェック用のフォルダ名を戻す
DiContainarにより、コンストラクターで_cfldに設定してもかまいません。
selectKeys 任意 検索結果のキーリストを編集する。
setJspMapping 任意 DetaObjectの項目番号とJSPの項目名称の紐付けクラスを登録する
DiContainarにより、コンストラクターで_jimに設定する場合は不要です。
setItems 任意 DetaObjectの項目番号とJSPの項目名称の紐付けを登録する
上記、setJspMappingで設定する場合は不要です。
editItems 任意 一覧表示用項目の編集を行う

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

著作権: Copyright (c) 2007/05/29

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

フィールドの概要
protected  java.lang.String _chkFld
          _cfld a String : 項目チェック用のフォルダー
protected  JspItemsMapping _jim
          _jim a JspItemsMapping : JSP項目名称:データオブジェクト項目対応クラス
static java.lang.String POSNM
           
 
クラス com.hamaf.hikyaku.ui.ListProcessBase から継承されたフィールド
_keyPos, _keys, _pageAct
 
クラス com.hamaf.hikyaku.ui.ProcessBase から継承されたフィールド
clnm, controlXml, log, msgHed, process, request, resource, response, saveObj, sconfig, session, sysId
 
コンストラクタの概要
StandardListProcess()
           
 
メソッドの概要
protected  void addItem(java.lang.String jspnm, int pos)
          Describe addItem method : 取得項目番号:表示項目名称用Mapへの登録.
protected abstract  DetailItemsInterface callControl(DetailItemsInterface dii)
          Describe callControl method : コントロールクラスを呼び出す.
protected abstract  java.lang.String[] checkDelete(DetailItemsInterface dii)
          Describe checkDelete method : 削除データのチェック.
protected  boolean delCheck(DetailItemsInterface dii)
          Describe delCheck method : .
protected  java.util.Map<java.lang.String,java.lang.String> editItems(DetailItemsInterface dii, java.util.Map<java.lang.String,java.lang.String> mp)
          Describe editItems method : 項目編集処理.
protected abstract  RetrieveKeysInterface findKeys(RetrieveKeysInterface rki)
          Describe findKeys method : 検索結果を取得する.
protected  java.lang.String getCheckFolder()
          Describe getCheckFolder method : 項目チェックフォルダの取得.
protected  java.util.Map<java.lang.String,java.lang.String> getItem(java.util.List<java.lang.String> keyItem)
          Describe getItem method : set Linr Item.
protected  KeyList getKeys(KeyList key)
          Describe getKeys method : set Key List.
protected abstract  DetailItemsInterface newDataObj()
          Describe newDataObj method : 詳細用DataObjectの生成.
protected  java.util.List<java.util.List<java.lang.String>> selectKeys(java.util.List<java.util.List<java.lang.String>> keys)
          Describe selectKeys method : キーの一覧から選択を行う.
protected  DetailItemsInterface setGetKey(DetailItemsInterface dii, java.util.List<java.lang.String> key)
          Describe setGetKey method : 一覧表示用検索キーの設定.
protected  void setItems()
          Describe setItems method : 処理項目の登録処理.
protected  JspItemsMapping setJspMapping()
          Describe setJspMapping method : JSPマッピングの設定を行う.
protected abstract  RetrieveKeysInterface setRetrieveVal(KeyList keyl)
          Describe setRetrieveVal method : 検索用DateObjectの生成、検索値の設定.
 
クラス com.hamaf.hikyaku.ui.ListProcessBase から継承されたメソッド
exec, getSpare, saveSpare, spareAction, supplementEdit
 
クラス 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
 

フィールドの詳細

POSNM

public static final java.lang.String POSNM
関連項目:
定数フィールド値

_chkFld

protected java.lang.String _chkFld
_cfld a String : 項目チェック用のフォルダー


_jim

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

コンストラクタの詳細

StandardListProcess

public StandardListProcess()
メソッドの詳細

getKeys

protected final KeyList getKeys(KeyList key)
                         throws IllegalRetrieveDataException
クラス ListProcessBase の記述:
Describe getKeys method : set Key List.
一覧表示の各行に対応するKey値のListを設定する。
以下の手順でKeyList Classに設定します。
  1. KeyList Class に設定されている検索項目のMapより、getRetrieve()で検索値を取得する。
  2. 検索項目にエラーがある場合は、例外を投げる。
  3. 検索値より一覧表示対象データのKey Objectを取得する。
  4. 取得したKey ObjectをsetKey()メソッドを使用して、KeyList Classに設定する。

定義:
クラス ListProcessBase 内の getKeys
パラメータ:
key - a KeyList : 一覧表示処理用のキーリスト管理クラス
戻り値:
a KeyList : 一覧表示処理用のキーリスト管理クラス
例外:
IllegalRetrieveDataException - : 検索項目にエラーがある場合に投げる例外

getCheckFolder

protected java.lang.String getCheckFolder()
Describe getCheckFolder method : 項目チェックフォルダの取得.
(DiContainaerを使用しコンストラクターで設定する場合は、不要です。)
検索項目の項目チェックを行う場合に、overrideしてフォルダ名を戻す。
項目チェックを行わない場合は、不要です。

戻り値:
a String : 項目チェックのフォルダ名

setRetrieveVal

protected abstract RetrieveKeysInterface setRetrieveVal(KeyList keyl)
                                                 throws IllegalRetrieveDataException
Describe setRetrieveVal method : 検索用DateObjectの生成、検索値の設定.
検索用DetaObject (RetrieveKeysInterface rki) を生成し検索項目を設定する。
ex. RetrieveKeysInterface rki = new xxxxRetDtObj();
rki.setRetrieveValue(XXTblListDto.KEY_ITEM, keyl.getRetrieve("jsp項目名"));

検索項目設定時にエラーが発生した場合は、IllegalRetrieveDataException を生成して戻す。

 その際、エラー項目名とエラーメッセージを設定したMapを設定する。
    ex. Map<String, String> errmp = new HashMap<String, String>();
        errmp.put("jsp項目名", "エラーメッセージ");
        throws new IllegalRetrieveDataException("メッセージ", errmp);
 

パラメータ:
keyl - a KeyList
例外:
IllegalRetrieveDataException - if an error occurs

findKeys

protected abstract RetrieveKeysInterface findKeys(RetrieveKeysInterface rki)
                                           throws java.lang.Exception
Describe findKeys method : 検索結果を取得する.
コントロールクラスを呼び出し、戻り値のDetaObjectを戻す。
  1. _Process_Control xcntl = new _Process_Control();
  2. return xcntl.getKeys(rki);

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

selectKeys

protected java.util.List<java.util.List<java.lang.String>> selectKeys(java.util.List<java.util.List<java.lang.String>> keys)
Describe selectKeys method : キーの一覧から選択を行う.
コントロールより取得したキーリストから、データの選択を行う場合に使用する。

パラメータ:
keys - a List<List<String>> : 取得したキーのリスト
戻り値:
a List<List<String>> : 選択後のキーのリスト

getItem

protected final java.util.Map<java.lang.String,java.lang.String> getItem(java.util.List<java.lang.String> keyItem)
                                                                  throws java.lang.Exception
クラス ListProcessBase の記述:
Describe getItem method : set Linr Item.
一覧表示用の項目を取得する。
Key値のオブジェクトより、一覧表示の1行分の項目を設定したObjectを生成し戻す。

定義:
クラス ListProcessBase 内の getItem
パラメータ:
keyItem - an Object : Key値のオブジェクト
戻り値:
an Map : 表示項目のオブジェクト
例外:
java.lang.Exception - if an error occurs

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での項目名");
にて必要項目分、紐付け登録を行う。


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で定義されている項目位置

newDataObj

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

戻り値:
a DetailItemsInterface : DataObject

setGetKey

protected DetailItemsInterface setGetKey(DetailItemsInterface dii,
                                         java.util.List<java.lang.String> key)
Describe setGetKey method : 一覧表示用検索キーの設定.
データオブジェクトに、キー項目値を設定して戻す。
DetaObjectでPrimaryKey項目名が、検索時の項目名と一致する場合は、
そのまま使用できます。
上記以外の場合には、overrideして、Key値の設定を行います。
  1. データオブジェクトにkeysより、検索キー値を設定する。
    ex. dtobj.setItemValue(_XXDtlDto_.KEY_ITEM, keys.get(0));
  2. データオブジェクトを戻す。
    ex. return dtobj;

パラメータ:
dii - a DetailItemsInterface
key - a List : KeyListに保存したKeyの値の配列
戻り値:
a DetailItemsInterface

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 :
戻り値:
a DetailItemsInterface :
例外:
java.lang.Exception - if an error occurs

checkDelete

protected abstract java.lang.String[] checkDelete(DetailItemsInterface dii)
Describe checkDelete method : 削除データのチェック.
DataObejctにデータが存在し、削除FLGがOFFかチェックする。
削除データの場合は、削除の旨を表示する項目名と表示内容のString[2]を戻します。
ex.
    if (dii.isNotFound() || dii.getCommFld(COMMFLD.DEL).equals("1")) {
      String[] ret = {"jsp項目名", super.resource.getString("DelLine")};
      return ret;
    }
    return null;
 

パラメータ:
dii - a DetailItemsInterface
戻り値:
a String : メッセージを表示させる項目の名称

delCheck

protected final boolean delCheck(DetailItemsInterface dii)
Describe delCheck method : .
削除されたデータ化をチェックする。 削除データの場合、true を戻す

パラメータ:
dii - a DetailItemsInterface :
戻り値:
a boolean : 削除データの場合 true

editItems

protected java.util.Map<java.lang.String,java.lang.String> editItems(DetailItemsInterface dii,
                                                                     java.util.Map<java.lang.String,java.lang.String> mp)
                                                              throws java.lang.Exception
Describe editItems method : 項目編集処理.
編集して表示する項目をMapに設定する場合、overrideする。
編集した項目をJSP項目名をKeyにしてmpに登録する。

パラメータ:
dii - a DetailItemsInterface :
mp - a Map : 編集項目を設定するMap
戻り値:
a Map : 編集後のMap
例外:
java.lang.Exception - if an error occurs