パッケージ org.opengion.hayabusa.taglib

クラス FileSearchTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
jakarta.servlet.jsp.tagext.BodyTagSupport
org.opengion.hayabusa.taglib.CommonTagSupport
org.opengion.hayabusa.taglib.FileSearchTag
すべての実装されたインタフェース:
BodyTag, IterationTag, JspTag, Tag, TryCatchFinally, Serializable
public class FileSearchTag extends CommonTagSupport
DBTableModel の [NAME(ﾌﾙﾊﾟｽ)]、または [PARENT(ﾊﾟｽ名),NAME(ﾌｧｲﾙ名)] から ﾌｧｲﾙ内の特定の文字列を検索するﾀｸﾞです。 FileQueryTag と併用すると、様々な条件でﾌｧｲﾙ検索ができます。 IDXTEXT,CONTEXT のｶﾗﾑが DBTableModel にｾｯﾄされます。 [ｶﾗﾑ名] 以下のｶﾗﾑ名で作成されます。 IDXTEXT : ｼｰﾄ名などの位置 CONTEXT : 特定の文字列を含む部分文字列 実行後にﾘｸｴｽﾄﾊﾟﾗﾒｰﾀに以下の値がｾｯﾄされます。 DB.COUNT : 実行結果の件数 DB.ERR_MSG : 実行結果のｴﾗｰﾒｯｾｰｼﾞ
関連項目:
変更履歴:
8.5.4.0 (2023/12/01) 新規作成
機能分類
その他入力
形式ｻﾝﾌﾟﾙ:
●形式：<og:fileSearch keyword="…" /> ●body：なし ●前提：DBTableModel に NAME のｶﾗﾑが必要です。 ●Tag定義： <og:fileSearch keyword ○【TAG】検索する文字列を指定します (必須) ignoreCase 【TAG】大文字/小文字を区別しないかどうか[true/false]を指定します (初期値:false[区別する]) useNormalize 【TAG】正規化(半角全角)を変換するかどうか[true/false]を指定します (初期値:false(変換しない)) fromBase 【TAG】fromBase指定のﾊﾟｽを連結して絶対ﾊﾟｽを作成します fromScope 【TAG】参照ﾃｰﾌﾞﾙのscope[request/session/application]を指定します (初期値:session) toScope 【TAG】出力ﾃｰﾌﾞﾙのscope[request/session/application]を指定します (初期値:session) fromTableId 【TAG】参照ﾃｰﾌﾞﾙのtableIdを指定します (初期値:HybsSystem#TBL_MDL_KEY[=h_tblmdl]) toTableId 【TAG】出力ﾃｰﾌﾞﾙのtableIdを指定します (初期値:HybsSystem#TBL_MDL_KEY[=h_tblmdl]) maxRowCount 【TAG】(通常は使いません)ﾃﾞｰﾀの最大読込件数を指定します (初期値:DB_MAX_ROW_COUNT[=1000])(0:[無制限]) displayMsg 【TAG】検索結果を画面上に表示するﾒｯｾｰｼﾞﾘｿｰｽIDを指定します (初期値:VIEW_DISPLAY_MSG[=]) overflowMsg 【TAG】検索ﾃﾞｰﾀが最大検索数をｵｰﾊﾞｰした場合に表示するﾒｯｾｰｼﾞﾘｿｰｽIDを指定します (初期値:MSG0007[検索結果が、制限行数を超えましたので、残りはｶｯﾄされました]) notfoundMsg 【TAG】検索結果がｾﾞﾛ件の場合に表示するﾒｯｾｰｼﾞﾘｿｰｽIDを指定します (初期値:MSG0077[対象ﾃﾞｰﾀはありませんでした]) dispError 【TAG】ｴﾗｰ時にﾒｯｾｰｼﾞを表示するか[true/false]を設定します (初期値:true) stopZero 【TAG】検索結果が0件のとき処理を続行するかどうか[true/false]を指定します (初期値:false[続行する]) useTimeView 【TAG】処理時間を表示する TimeView を表示するかどうかを指定します (初期値:VIEW_USE_TIMEBAR[=])。 useLocal 【TAG】ｼｽﾃﾑ定数でｸﾗｳﾄﾞ設定されていても、ｸﾗｳﾄﾞ環境を使用しない場合、trueを指定します (初期値:false) caseKey 【TAG】このﾀｸﾞ自体を利用するかどうかの条件ｷｰを指定します (初期値:null) caseVal 【TAG】このﾀｸﾞ自体を利用するかどうかの条件値を指定します (初期値:null) caseNN 【TAG】指定の値が、null/ｾﾞﾛ文字列 でない場合(Not Null=NN)は、このﾀｸﾞは使用されます(初期値:判定しない) caseNull 【TAG】指定の値が、null/ｾﾞﾛ文字列 の場合は、このﾀｸﾞは使用されます (初期値:判定しない) caseIf 【TAG】指定の値が、true/TRUE文字列の場合は、このﾀｸﾞは使用されます (初期値:判定しない) debug 【TAG】ﾃﾞﾊﾞｯｸﾞ情報を出力するかどうか[true/false]を指定します (初期値:false) /> ●使用例 <og:fileQuery from = "d:/webapps/dbdef/jsp/" multi = "true" fileType = "FILE" /> <og:fileSearch keyword = "hoge" /> ●注意事項 ・この機能は簡易的なものなので、ﾃﾞｰﾀﾍﾞｰｽなどに全文検索機能があれば、その機能を利用してください。 ・useNormalize="true" を指定すると、正規化変換後の文字列で表示されます。
導入されたバージョン:
JDK17.0,

  • コンストラクタの詳細

    • FileSearchTag

      public FileSearchTag()
      ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ

  • メソッドの詳細

    • doEndTag

      public int doEndTag()
      Taglibの終了ﾀｸﾞが見つかったときに処理する doEndTag() を ｵｰﾊﾞｰﾗｲﾄﾞします。 ﾀｸﾞ本体が空の場合は、呼ばれないので、従来の doAfterBody() 処理を、 doEndTag() に持っていきます。
      定義:
      doEndTag インタフェース内 Tag
      オーバーライド:
      doEndTag クラス内 CommonTagSupport
      戻り値:
      後続処理の指示
      変更履歴:
      8.5.4.2 (2024/01/12) PMD 7.0.0 LocalVariableNamingConventions 対応

    • release2

      protected void release2()
      ﾀｸﾞﾘﾌﾞｵﾌﾞｼﾞｪｸﾄをﾘﾘｰｽします。 ｷｬｯｼｭされて再利用されるので、ﾌｨｰﾙﾄﾞの初期設定を行います。
      オーバーライド:
      release2 クラス内 CommonTagSupport

    • setKeyword

      public void setKeyword(String kw)
      【TAG】検索する文字列を指定します。
      パラメータ:
      kw - 文字列
      説明:
      ｽﾍﾟｰｽ連結の「AAA BBB」は、AAA とBBB のAND形式 OR文字列の連結の「CCC OR DDD」は、CCC と DDD のOR形式になります。 優先順位を付ける"(" などは使えません。常に、OR で分解後、ｽﾍﾟｰｽ分解で、AND因子を求めます。 例) AAA BBB OR CCC ⇒「AAA BBB」OR 「CCC」 AAA OR BBB CCC ⇒「AAA」OR 「BBB CCC」

    • setIgnoreCase

      public void setIgnoreCase(String flag)
      【TAG】大文字/小文字を区別しないかどうか[true/false]を指定します(初期値:false(区別する))。
      パラメータ:
      flag - 大文字/小文字の区別 [true:しない/false:する]
      説明:
      ture(区別しない) の場合、aaa と AAA は、一致したとみなされます。 初期値は、false(区別する)です。

    • setUseNormalize

      public void setUseNormalize(String flag)
      【TAG】正規化(半角全角)を変換するかどうか[true/false]を指定します(初期値:false(変換しない))。
      パラメータ:
      flag - 正規化(半角全角)を変換 [true:する/false:しない]
      説明:
      ture(変換する) の場合、ﾎｹﾞ と ホゲ は、一致したとみなされます。 初期値は、false(変換しない)です。 ture を指定すると、半角ｶﾀｶﾅ が 全角カタカナ に変換されて比較されます。 ① なども １ として比較されます。 正規化変換後の文字数が、元と同じ場合は、元の文字列で表示されますが、 "ｶﾞ"(2文字) が "ガ"(1文字) となるように異なる場合は、正規化変換後の 文字例で表示されます。

    • setFromBase

      public void setFromBase(String base)
      【TAG】PARENT列から、fromBase指定のﾊﾟｽを連結して絶対ﾊﾟｽを作成します。
      パラメータ:
      base - PARENT列から、fromBase指定のﾊﾟｽを連結して絶対ﾊﾟｽを作成
      説明:
      DBTableModel の PARENT列が相対ﾊﾟｽの場合、fromBase指定のﾊﾟｽを連結して 絶対ﾊﾟｽを作成します。

    • setFromScope

      public void setFromScope(String scp)
      【TAG】参照ﾃｰﾌﾞﾙのｽｺｰﾌﾟ[request/session/application]を指定します(初期値:session)。
      パラメータ:
      scp - ｽｺｰﾌﾟ [request/session/application]
      関連項目:
      説明:
      参照元となる DBTableModel をﾒﾓﾘから取り出す場合のｽｺｰﾌﾟを指定します。 初期値は、session です。

    • setToScope

      public void setToScope(String scp)
      【TAG】出力ﾃｰﾌﾞﾙのｽｺｰﾌﾟ[request/session/application]を指定します(初期値:session)。
      パラメータ:
      scp - ｽｺｰﾌﾟ [request/session/application]
      説明:
      出力する DBTableModel を管理するｽｺｰﾌﾟを指定します。 初期値は、session です。

    • setFromTableId

      public void setFromTableId(String id)
      【TAG】参照ﾃｰﾌﾞﾙのtableIdを指定します (初期値:HybsSystem#TBL_MDL_KEY[=])。
      パラメータ:
      id - 参照ﾃｰﾌﾞﾙID
      説明:
      参照元となる DBTableModel をﾒﾓﾘから取り出す場合のｷｰ(tableId)を指定します。 初期値は、HybsSystem#TBL_MDL_KEY です。

    • setToTableId

      public void setToTableId(String id)
      【TAG】出力ﾃｰﾌﾞﾙのtableIdを指定します (初期値:HybsSystem#TBL_MDL_KEY[=])。
      パラメータ:
      id - 出力ﾃｰﾌﾞﾙID
      説明:
      出力する DBTableModel を管理するｷｰ(tableId)を指定します。 talbeIdを指定しない場合、参照元となる DBTableModel と同一ﾒﾓﾘに配置される為、 この tableId 属性を利用して、ﾒﾓﾘ空間を分けます。 初期値は、HybsSystem#TBL_MDL_KEY です。

    • setMaxRowCount

      public void setMaxRowCount(String count)
      【TAG】(通常は使いません)ﾃﾞｰﾀの最大読込件数を指定します (初期値:DB_MAX_ROW_COUNT[=])。
      パラメータ:
      count - 最大件数
      関連項目:
      説明:
      参照ﾃｰﾌﾞﾙを元に全てのﾌｧｲﾙを検索しますが、ｻｰﾊﾞｰのﾒﾓﾘ資源と応答時間の確保の為、 DBTableModelのﾃﾞｰﾀとして登録する最大件数をこの値に設定します。 0 をｾｯﾄすると、無制限(Integer.MAX_VALUE)になります。 初期値は、SystemData#DB_MAX_ROW_COUNT です。

    • setDisplayMsg

      public void setDisplayMsg(String id)
      【TAG】検索結果を画面上に表示するﾒｯｾｰｼﾞﾘｿｰｽIDを指定します (初期値:VIEW_DISPLAY_MSG[=])。
      パラメータ:
      id - 表示ﾒｯｾｰｼﾞID
      関連項目:
      説明:
      ここでは、検索結果の件数や登録された件数をまず出力し、 その次に、ここで指定したﾒｯｾｰｼﾞをﾘｿｰｽから取得して表示します。 件数を表示させる場合は、displayMsg = "MSG0033"[　件検索しました] をｾｯﾄしてください。 表示させたくない場合は、displayMsg = "" をｾｯﾄしてください。 初期値は、SystemData#VIEW_DISPLAY_MSG です。

    • setOverflowMsg

      public void setOverflowMsg(String id)
      【TAG】検索ﾃﾞｰﾀが最大検索数をｵｰﾊﾞｰした場合に表示するﾒｯｾｰｼﾞﾘｿｰｽIDを指定します (初期値:MSG0007[検索結果が、制限行数を超えましたので、残りはｶｯﾄされました])。
      パラメータ:
      id - ｵｰﾊﾞｰ時ﾒｯｾｰｼﾞID
      説明:
      検索結果が、maxRowCount で設定された値より多い場合、何らかのﾃﾞｰﾀは検索されず 切り捨てられたことになります。 ここでは、displayMsg を表示した後、必要に応じて、このﾒｯｾｰｼﾞを表示します。 表示させたくない場合は、overflowMsg = "" をｾｯﾄしてください。 初期値は、MSG0007[検索結果が、制限行数を超えましたので、残りはｶｯﾄされました]です。

    • setNotfoundMsg

      public void setNotfoundMsg(String id)
      【TAG】検索結果がｾﾞﾛ件の場合に表示するﾒｯｾｰｼﾞﾘｿｰｽIDを指定します(初期値:MSG0077[対象ﾃﾞｰﾀはありませんでした])。
      パラメータ:
      id - ｾﾞﾛ件ﾒｯｾｰｼﾞID
      説明:
      ここでは、検索結果がｾﾞﾛ件の場合のみ、特別なﾒｯｾｰｼﾞを表示させます。 従来は、displayMsg と兼用で、『0　件検索しました』という表示でしたが、 displayMsg の初期表示は、OFF になりましたので、ｾﾞﾛ件の場合のみ別に表示させます。 表示させたくない場合は、notfoundMsg = "" をｾｯﾄしてください。 初期値は、MSG0077[対象ﾃﾞｰﾀはありませんでした]です。

    • setDispError

      public void setDispError(String flag)
      【TAG】処理ｴﾗｰの時にｴﾗｰを画面表示するか[true/false]を設定します(初期値:true)。
      パラメータ:
      flag - [true:表示する/false:表示しない]
      説明:
      false(表示しない)に設定する場合、後続処理では、{@DB.ERR_MSG}の値により、 本来表示されるはずだったﾒｯｾｰｼﾞを取得可能です。 初期値は、true(表示する)です。 ※false指定の場合は件数や、overFlowﾒｯｾｰｼﾞ等も表示されなくなります。

    • setStopZero

      public void setStopZero(String flag)
      【TAG】検索結果が0件のとき処理を停止するかどうか[true/false]を指定します(初期値:false[続行する])。
      パラメータ:
      flag - 0件時停止可否 [true:処理を中止する/false:続行する]
      説明:
      初期値は、false(続行する)です。

    • setUseTimeView

      public void setUseTimeView(String flag)
      【TAG】処理時間を表示する TimeView を表示するかどうか[true:する/false:しない]を指定します (初期値:VIEW_USE_TIMEBAR[=])。
      パラメータ:
      flag - 処理時間を表示 [true:する/false:しない]
      説明:
      true に設定すると、処理時間を表示するﾊﾞｰｲﾒｰｼﾞが表示されます。 これは、DB検索、APｻｰﾊﾞｰ処理、画面表示の各処理時間をﾊﾞｰｲﾒｰｼﾞで 表示させる機能です。処理時間の目安になります。 初期値は、SystemData#VIEW_USE_TIMEBAR です。

    • setUseLocal

      public void setUseLocal(String flag)
      【TAG】ｼｽﾃﾑ定数でｸﾗｳﾄﾞ設定されていても、ｸﾗｳﾄﾞ環境を使用しない場合、trueを指定します(初期値:false)。
      パラメータ:
      flag - ﾛｰｶﾙ環境のみ [true:ﾛｰｶﾙのみ/false:設定どおり]
      説明:
      ｸﾗｳﾄﾞ設定は、ｼｽﾃﾑ定数の『CLOUD_TARGET』と『CLOUD_BUCKET』の設定で自動的に使用しますが、 どうしてもﾛｰｶﾙでのみ使いたい場合は、この属性を true に設定します。 標準はfalse:設定どおりとなります。 true/false以外を指定した場合はfalse扱いとします。

    • toString

      public String toString()
      このｵﾌﾞｼﾞｪｸﾄの文字列表現を返します。 基本的にﾃﾞﾊﾞｯｸﾞ目的に使用します。
      オーバーライド:
      toString クラス内 CommonTagSupport
      戻り値:
      このｸﾗｽの文字列表現
      このﾒｿｯﾄﾞは、nullを返しません