com.hamaf.hikyaku.dataobject
インタフェース RetrieveKeysInterface

すべてのスーパーインタフェース:
java.lang.Iterable<java.util.List<java.lang.String>>
既知の実装クラスの一覧:
CommonSelectSearchDto, GroupSearchDto, MessageSearchDto, PluginSearchDto, PossibleSearchDto, RetrieveKeysBase, UserSearchDto, VInitSearchDto, VMenuSearchDto, VReserveSessionSearchDto, VRetrieveSearchDto

public interface RetrieveKeysInterface
extends java.lang.Iterable<java.util.List<java.lang.String>>

タイトル:RetrieveKeysInterface is DB retrieve information and saved key items.

説明:プライマリキー一覧取得用のインターフェース。


設定された条件で、該当するKeyの一覧を取得するときに使用する。
検索を依頼するクラスでの使用方法
  1. 検索項目とその値をsetRetrieveValue()で設定する。
  2. 項目ごとの検索条件(=,>,<,in,like,between etc.)をsetCondition()で指定する。
  3. 並べ替えが必要な場合は、setOrderItem()で項目と順番を設定する。
  4. 検索結果の配列(List)をgetKeys()で取得する。
  5. 取得した配列より、キー項目値の配列(List)を取得する。
サンプル
     XxxxxRetrieveKeysInstance xinst = new XxxxxRetrieveKeysInstance();
     xinst.setRetrieveValue(項目番号, "検索値");
     xinst.setCondition(項目番号, "LIKE");
     xinst.setOrderItem(項目番号,1);
     xinst = X____Get.xxx(xinst);
     List keys = xinst.getKeys();
     for (Iterator iter = keys.iterator(); iter.hasNext();) {
       List keysValue = (List) iter.next();
       // 処理を記述する
     }
 
検索を実行するクラスでの使用方法
注意:キー項目値として配列(List)では無く、 文字列(String)を使用しても良い。
サンプル
    StringBuffer sb = new StringBuffer();
    sb.append(Dto2SqlUtils.getSelectItemsWithExclusion(xinst));
    sb.append(" FROM UserInfTbl ");
    sb.append(Dto2SqlUtils.getWhereString(xinst));
    result = statment.executeQuery(sb.toString());
    while (result.next()) {
      List ls = new ArrayList();
      ls.add(result.getString(result, 1));
      ls.add(result.getString(result, 2));
      xinst.addKey(ls);
    }
    rs.close();
 

著作権: Copyright (c) 2004/06/15

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

メソッドの概要
 void addKey(java.util.List<java.lang.String> key)
          Method addKey is add key item value.
 void clearKeys()
          Method clearKeys is clear key item value.
 java.util.Map<java.lang.Integer,java.lang.String> getConditions()
          Method getConditions is return retrieve condition.
 java.lang.String getConstCond()
          Describe getAddCondition method : return Additional Condition.
 DetailItemsInterface.USE_FLG getDel()
           
 java.lang.String getItem(int pos)
          Describe getItem method : return item value.
 java.lang.String getKeyItem(int pos)
          Describe getKeyItem method : return item value.
 java.util.List<java.util.List<java.lang.String>> getKeys()
          Method getKeys is return key item list.
 java.util.Map<java.lang.Integer,java.lang.String> getOrderItems()
          Method getOrderItems is return order information.
 java.util.Map<java.lang.Integer,java.lang.Integer> getOrderPos()
          Describe getOrderPos method : setting orderinf.
 java.util.List<java.lang.String> getPkeyFld()
          Describe getPkeyFld method : return PrimaryKeu Fields Name.
 java.util.Map<java.lang.Integer,java.lang.String> getRetriveValues()
          Method getRetriveValues is return retrive item value.
 java.lang.String getSysId()
           
 int itemCount()
          Describe ItemCount method : return items count.
 int keyCount()
          Describe keyCount method : return key items count.
 void setCondition(int item, java.lang.String cond)
          Method setRetriveCondition is set retrieve condition.
 void setConstCond(java.lang.String constCond)
          Describe setConstCond method : set Additional Condition.
 void setDel(DetailItemsInterface.USE_FLG del)
           
 void setKeys(java.util.List<java.util.List<java.lang.String>> keys)
          Method setKeys is set all key item value.
 void setOrderItem(int item, int seq)
          Method setOrderItem is set order.
 void setPkeyFld(java.util.List<java.lang.String> keys)
          Describe setPkeyFld method : set PrimaryKey Fields Name.
 void setRetrieveValue(int item, java.lang.String val)
          Method setRetrieveValue is set retrieve item value.
 void setSysId(java.lang.String del)
           
 
インタフェース java.lang.Iterable から継承されたメソッド
iterator
 

メソッドの詳細

setRetrieveValue

void setRetrieveValue(int item,
                      java.lang.String val)
                      throws java.lang.IllegalArgumentException
Method setRetrieveValue is set retrieve item value.
検索項目とその値を設定する。
検索条件が"IN"の場合は、'値','値',・・・を設定し、 "BETWEENの場合は、'値' AND '値' を設定する。

パラメータ:
item - an int : 項目番号
val - a String : 検索値
例外:
java.lang.IllegalArgumentException

getRetriveValues

java.util.Map<java.lang.Integer,java.lang.String> getRetriveValues()
Method getRetriveValues is return retrive item value.
設定されている検索値を渡す。
検索値はMap<項目番号(Integer),検索値(String)≥で設定される。

戻り値:
a Map<Integer, String> : 検索値が設定されているMap
例外:
java.lang.IllegalArgumentException

setCondition

void setCondition(int item,
                  java.lang.String cond)
                  throws java.lang.IllegalArgumentException
Method setRetriveCondition is set retrieve condition.
検索条件("=","<","IN","LIKE","BETWEEN","IS" etc.)を設定する。
規定値は、等しい("=")とする。

パラメータ:
item - an int : 項目番号
cond - a String : 検索条件式
例外:
java.lang.IllegalArgumentException

getConditions

java.util.Map<java.lang.Integer,java.lang.String> getConditions()
Method getConditions is return retrieve condition.
設定されている検索条件を渡す。
検索条件はMap<項目番号(Integer),検索条件(String)≥で設定される。

戻り値:
a Map<Integer, String> : 検索条件式が設定されているMap
例外:
java.lang.IllegalArgumentException

setOrderItem

void setOrderItem(int item,
                  int seq)
                  throws java.lang.IllegalArgumentException
Method setOrderItem is set order.
表示順の設定を行う。
表示順は、並び替え項目順に小さい値を設定する。
同一の表示順が設定された場合の動作は不定。
規定値は昇順とし、降順とする場合は、表示順にマイナス値で指定する。
マイナス値を指定した場合は、絶対値が順序とする。

パラメータ:
item - an int : 項目番号
seq - an int : 表示順
例外:
java.lang.IllegalArgumentException

getOrderItems

java.util.Map<java.lang.Integer,java.lang.String> getOrderItems()
Method getOrderItems is return order information.
設定されている表示順を渡す。
並び替え情報はMap<表示順(Integer),項目名+並び順(String)≥で設定される。

戻り値:
an Map<Integer, String> : 表示順

getOrderPos

java.util.Map<java.lang.Integer,java.lang.Integer> getOrderPos()
Describe getOrderPos method : setting orderinf.
表示順の指定値をそのまま返す。

戻り値:
a Map : 指定された表示順情報

itemCount

int itemCount()
Describe ItemCount method : return items count.
項目数を戻す。

戻り値:
an int : キー項目数

keyCount

int keyCount()
Describe keyCount method : return key items count.
キー項目数を戻す。

戻り値:
an int : キー項目数

getItem

java.lang.String getItem(int pos)
                         throws java.lang.IllegalArgumentException
Describe getItem method : return item value.
指定された位置の項目内容を戻す。

パラメータ:
pos - : 項目番号
戻り値:
a String : フィールド名
例外:
java.lang.IllegalArgumentException

getKeyItem

java.lang.String getKeyItem(int pos)
                            throws java.lang.IllegalArgumentException
Describe getKeyItem method : return item value.
指定された位置のKey項目名を戻す。

パラメータ:
pos - an int : Key項目の番号
戻り値:
a String : フィールド名
例外:
java.lang.IllegalArgumentException

clearKeys

void clearKeys()
Method clearKeys is clear key item value.
Key項目値の保存領域を初期化する。


addKey

void addKey(java.util.List<java.lang.String> key)
Method addKey is add key item value.
検索で取得されたレコードのKey項目値を登録する。

パラメータ:
key - an Object : キー値

setKeys

void setKeys(java.util.List<java.util.List<java.lang.String>> keys)
Method setKeys is set all key item value.
検索で取得したレコードのキー値を一括して登録する。
キー値は引数のリストですべて置き換えられます。

パラメータ:
keys - a List : キー値が設定されたリスト

getKeys

java.util.List<java.util.List<java.lang.String>> getKeys()
Method getKeys is return key item list.
キー項目値のリストを戻す。

戻り値:
List

getSysId

java.lang.String getSysId()
戻り値:
システムID

setSysId

void setSysId(java.lang.String del)
パラメータ:
del - : システムID を設定します。

getDel

DetailItemsInterface.USE_FLG getDel()
戻り値:
削除フラグ

setDel

void setDel(DetailItemsInterface.USE_FLG del)
パラメータ:
del - : 削除フラグ を設定します。

setConstCond

void setConstCond(java.lang.String constCond)
Describe setConstCond method : set Additional Condition.
追加の検索条件を設定する。

パラメータ:
constCond - a String : 追加の検索条件

getConstCond

java.lang.String getConstCond()
Describe getAddCondition method : return Additional Condition.
追加の検索条件を戻す。

戻り値:
a String : 追加の検索条件

setPkeyFld

void setPkeyFld(java.util.List<java.lang.String> keys)
Describe setPkeyFld method : set PrimaryKey Fields Name.
キー項目名のリストを設定する。

パラメータ:
keys - a : キー項目のフィールド名

getPkeyFld

java.util.List<java.lang.String> getPkeyFld()
Describe getPkeyFld method : return PrimaryKeu Fields Name.
キー項目名のリストを戻す。

戻り値:
a List : キー項目のフィールド名