com.hamaf.hikyaku.ui
クラス ListProcessBase

java.lang.Object
  上位を拡張 com.hamaf.hikyaku.ui.ProcessBase
      上位を拡張 com.hamaf.hikyaku.ui.ListProcessBase
直系の既知のサブクラス:
StandardListProcess

public abstract class ListProcessBase
extends ProcessBase

タイトル:ListProcessBase is List Process Bean base class.

説明:一覧表示用JavaBeanのベースとなるクラス。


ProcessBeanexecメソッドをOverWriteし、
継承したクラスが実装すべき次のアブストラクトメソッドを定義します。 一覧用のKey項目配列を管理するために、KeyListクラスをインスタンス化し Kye項目配列を設定してsessionに保存します。
制御ファイル(Hikyaku.xml)で<KeySave>タグに"Yes"を設定すると KeyList.KeyDataをファイルに退避させクリアさせる。
(sessionに保持するメモリー量を削減させることが出来ます)

リクエストメッセージのpageActionの値により、動作が決定されます。 1ページに表示される行数は pageAction が get,reget の時に次の順で決定されます。
  1. リクエストメッセージ内の、pageLineの値
  2. 飛脚制御Xml内のPageLineの値
  3. 規定値 30 Line/Page

著作権: Copyright (c) 2003/12/27

バージョン:
1.0
作成者:
Hamanaka

フィールドの概要
protected  int _keyPos
           
protected  KeyList _keys
           
protected  java.lang.String _pageAct
           
 
クラス com.hamaf.hikyaku.ui.ProcessBase から継承されたフィールド
clnm, controlXml, log, msgHed, process, request, resource, response, saveObj, sconfig, session, sysId
 
コンストラクタの概要
ListProcessBase()
           
 
メソッドの概要
 CommonMessage exec(CommonMessage msg)
          Describe exec method : Hikyaku Process exec Method.
protected abstract  java.util.Map<java.lang.String,java.lang.String> getItem(java.util.List<java.lang.String> keyItem)
          Describe getItem method : set Linr Item.
protected abstract  KeyList getKeys(KeyList key)
          Describe getKeys method : set Key List.
protected  java.lang.Object getSpare()
          Describe getSpare method : get object at current position in spare area of keyList.
protected  void saveSpare(java.lang.Object val)
          Describe saveSpare method : save Obejct at current position in spare area of keyList.
protected  CommonMessage spareAction(CommonMessage msg, java.lang.String act)
          Describe spareAction method : spare process.
protected  CommonMessage supplementEdit(CommonMessage msg, KeyList kl, java.lang.String pact)
          Describe supplementEdit method : supplement CommonMessage.
 
クラス 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
 

フィールドの詳細

_keys

protected KeyList _keys

_pageAct

protected java.lang.String _pageAct

_keyPos

protected int _keyPos
コンストラクタの詳細

ListProcessBase

public ListProcessBase()
メソッドの詳細

exec

public final CommonMessage exec(CommonMessage msg)
                         throws java.lang.Exception
Describe exec method : Hikyaku Process exec Method.
飛脚業務処理クラスの実行(exec)メソッドを一覧表示用にオーバーライト

定義:
クラス ProcessBase 内の exec
パラメータ:
msg - a CommonMessage : 共通処理メッセージ
戻り値:
a CommonMessage : 共通処理メッセージ
例外:
java.lang.Exception - if an error occurs

getKeys

protected abstract KeyList getKeys(KeyList key)
                            throws IllegalRetrieveDataException
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に設定する。

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

getItem

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

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

spareAction

protected CommonMessage spareAction(CommonMessage msg,
                                    java.lang.String act)
                             throws java.lang.Exception
Describe spareAction method : spare process.
一覧処理での予備処理用のメソッド。
一覧処理の最初に呼び出されます。

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

saveSpare

protected final void saveSpare(java.lang.Object val)
Describe saveSpare method : save Obejct at current position in spare area of keyList.
KeyListの予備領域に現在の位置で保存する。

パラメータ:
val - an Object : 保存する値

getSpare

protected final java.lang.Object getSpare()
Describe getSpare method : get object at current position in spare area of keyList.
KeyListの予備領域から現在位置の値を取得する。

戻り値:
an Object : 取得した値

supplementEdit

protected CommonMessage supplementEdit(CommonMessage msg,
                                       KeyList kl,
                                       java.lang.String pact)
                                throws java.lang.Exception
Describe supplementEdit method : supplement CommonMessage.
CommonMessageへの補足設定を行う、予備処理用のメソッド。
一覧処理の最後に呼び出されます。

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