クラス FileUpdateTag

  • すべての実装されたインタフェース:
    Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

    public class FileUpdateTag
    extends CommonTagSupport
    ファイル検索リストを元に、action に基づいた処理を行うタグです。 command="ENTRY" 時のみ処理を行います。 fileQuery などで検索したファイル一覧のDBTableModel を元に、ファイルの コピー(COPY)、移動(MOVE,MODIFY)、削除(DELETE)などの処理を行います。 処理を行うオリジナルファイルは、PARENT,NAME というカラムでなければなりません。 ※ 7.2.7.0 (2020/08/07) parentClm,nameClm で指定可能になりました。 このカラム名は、fileQuery の検索時には、必ず作成されるカラムです。 また、各アクションに対応するターゲットファイルは、TO_PARENT,TO_NAME という カラムで指定するか、targetDir 属性を利用してフォルダを指定します。 TO_PARENT(先フォルダ)と、TO_NAME(先ファイル名)は、処理に応じて、必要なカラムが あれば、自動的に処理します。 つまり、TO_PARENT のみの場合は、ファイル名はオリジナルのまま、フォルダのみ変更します。 逆に、TO_NAME の場合は、フォルダはそのままで、ファイル名のみ指定します。 両方同時に指定することも可能です。 targetDir 属性で指定する場合は、TO_PARENT のみに同じ値を設定した場合と同じになります。 この属性を指定すると、TO_PARENT は無視されます。(TO_NAME は有効です。) COPY、MOVE(,MODIFY) の場合は、指定のフォルダに一括処理可能です。 COPY、MOVE(,MODIFY) などの処理で、ターゲットフォルダが存在しないときに、作成するか、エラーにするかは createDir属性 で指定できます。初期値は、(true:作成する) です。 これは、COPY先やMOVE(,MODIFY)先が存在している前提のシステムで、不要な箇所に間違ってフォルダを 自動作成されると困る場合に、(false:作成しない) とすれば、間違いに気づく確率が上がります。 ※ 7.2.7.0 (2020/08/07) PARENT,NAME,TO_PARENT,TO_NAME のカラム名を指定できるようにしました。 action にMKDIRS を追加しました。これは、TO_PARENT フォルダが作成できるかどうかを判定します。 ※ このタグは、Transaction タグの対象ではありません。
    関連項目:
    直列化された形式
    変更履歴:
    5.3.4.0 (2011/04/01) 新規追加
    機能分類
    ファイル出力
    形式サンプル:
    ●body:なし ●形式: ・<og:fileUpdate action = "COPY|MOVE|MODIFY|DELETE|MKDIRS" アクション属性(必須) command = "[ENTRY]" ENTRY 時のみ実行します(初期値:ENTRY) targetDir = "[指定フォルダ]" ターゲットとなるフォルダ createDir = "[true/false]" ターゲットとなるフォルダがなければ作成する(true)かどうか(初期値:true) tableId = [HybsSystem.TBL_MDL_KEY] DBTableModel を取り出すキー displayMsg = "MSG0040"; 処理結果を表示します(初期値:「 件登録しました。」) selectedAll = "[false/true]" データを全件選択済みとして処理する(true)かどうか指定(初期値:false) keepTimeStamp = "[false/true]" COPY,親違いMOVE(,MODIFY)の時にオリジナルのタイムスタンプを使用するかどうか(初期値:false) /> [action属性(必須)] COPY オリジナルファイルを、ターゲット(TO_PARENT,TO_NAMEで指定)にコピーします。 MOVE オリジナルファイルを、ターゲットに移動(COPY+DELETE)/名称変更(RENAME)します。 MODIFY (MOVE と同じ。エンジンの command を利用するための簡易action) DELETE オリジナルファイルを削除します(ターゲット(TO_PARENT,TO_NAME)は、関係しません)。 MKDIRS ターゲット(TO_PARENTで指定)フォルダを作成します。(PARENT,NAME,TO_NAMEは、関係しません)。 7.2.7.0 (2020/08/07) 新規追加 ●Tag定義: <og:fileUpdate action ○【TAG】アクション[COPY|MOVE|MODIFY|DELETE|MKDIRS]をセットします(必須)。 command 【TAG】コマンド[ENTRY]をセットします(初期値:ENTRY) targetDir 【TAG】ターゲットとなるフォルダを指定します createDir 【TAG】ターゲットとなるフォルダがなければ、作成するかどうかを指定します(初期値:true) parentClm 【TAG】7.2.7.0 (2020/08/07) fileQuery以外の場合の元親フォルダを示すカラム名を指定します(初期値:"PARENT") nameClm 【TAG】7.2.7.0 (2020/08/07) fileQuery以外の場合の元ファイル名を示すカラム名を指定します(初期値:"NAME") toParentClm 【TAG】7.2.7.0 (2020/08/07) fileQuery以外の場合の先親フォルダを示すカラム名を指定します(初期値:"TO_PARENT") toNameClm 【TAG】7.2.7.0 (2020/08/07) fileQuery以外の場合の先ファイル名を示すカラム名を指定します(初期値:"TO_NAME") tableId 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します scope 【TAG】キャッシュする場合のスコープ[request/page/session/application]を指定します(初期値:session) displayMsg 【TAG】処理結果を画面上に表示するメッセージリソースIDを指定します(初期値:MSG0040[ 件登録しました]) actErrMsg 【TAG】7.2.7.0 (2020/08/07) action実行時のエラーメッセージのメッセージリソースIDを指定します(初期値:ERR0050:アクション実行中にエラーが発生しました。アクション:{0} From:{1} To:{2}) selectedAll 【TAG】データを全件選択済みとして処理するかどうか[true/false]を指定します(初期値:false) keepTimeStamp 【TAG】オリジナルのタイムスタンプを利用するかどうかを指定します(初期値:false) inPath 【TAG】6.8.0.0 (2017/06/02) 入力共通パスを指定します(PARENTフォルダの共通部分、COPY/MOVE時にtargetDirと置換されます) 。 useTimeView 【TAG】処理時間を表示する TimeView を表示するかどうかを指定します (初期値:VIEW_USE_TIMEBAR[=])。 useSLabel 【TAG】7.0.7.0 (2019/12/13) エラーメッセージにSLABELを利用するかどうか[true/false]を指定します(初期値:false) useStop 【TAG】7.2.7.0 (2020/08/07) エラー時に処理後に停止するかどうか[true/false]を指定します(初期値:true) 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:fileUpdate command="{@command}" action="COPY" /> TO_PARENT または、 TO_NAME(両方指定も可)による行単位 COPY 処理 fileQuery の useUpdateClm="true" を設定し、検索結果に、TO_PARENT、 TO_NAMEカラムを追加します。 TO_PARENT または、 TO_NAME は、columnSet などで値をセットしておきます。 ・<og:fileUpdate command="{@command}" action="MODIFY" targetDir="AAA_DIR" /> fileQuery の検索結果を、AAA_DIR フォルダに移動します。 ファイル名は、そのままオリジナルの値が使用されます。
    バージョン
    4.0
    作成者
    Kazuhiko Hasegawa
    導入されたバージョン:
    JDK5.0,
    • フィールドの詳細

      • CMD_ENTRY

        public static final String CMD_ENTRY
        command 引数に渡す事の出来る コマンド 登録"ENTRY"
        関連項目:
        定数フィールド値
      • ACT_COPY

        public static final String ACT_COPY
        action 引数に渡す事の出来る アクションコマンド COPY "COPY"
        関連項目:
        定数フィールド値
      • ACT_MOVE

        public static final String ACT_MOVE
        action 引数に渡す事の出来る アクションコマンド MOVE "MOVE"
        関連項目:
        定数フィールド値
      • ACT_MODIFY

        public static final String ACT_MODIFY
        action 引数に渡す事の出来る アクションコマンド MODIFY "MODIFY"
        関連項目:
        定数フィールド値
      • ACT_DELETE

        public static final String ACT_DELETE
        action 引数に渡す事の出来る アクションコマンド DELETE "DELETE"
        関連項目:
        定数フィールド値
      • ACT_MKDIRS

        public static final String ACT_MKDIRS
        action 引数に渡す事の出来る アクションコマンド MKDIRS "MKDIRS"
        関連項目:
        定数フィールド値
    • コンストラクタの詳細

      • FileUpdateTag

        public FileUpdateTag()
        デフォルトコンストラクター
        変更履歴:
        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    • メソッドの詳細

      • doEndTag

        public int doEndTag()
        Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
        定義:
        doEndTag インタフェース内 javax.servlet.jsp.tagext.Tag
        オーバーライド:
        doEndTag クラス内 CommonTagSupport
        戻り値:
        後続処理の指示
        変更履歴:
        6.4.4.1 (2016/03/18) 意味のない、StringBuilderだったので、廃止します。, 6.9.9.0 (2018/08/20) 「ERR0041:検索処理中に割り込みの検索要求がありました」エラーを、標準のErrorMessageに追加するようにします。, 7.0.7.0 (2019/12/13) useSLabel 属性を追加。, 7.2.7.0 (2020/08/07) エラー時に処理後に停止(true)するかどうか(useStop対応)
      • release2

        protected void release2()
        タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
        オーバーライド:
        release2 クラス内 CommonTagSupport
        変更履歴:
        6.8.0.0 (2017/06/02) 入力共通パス(inPath)を指定します。, 7.0.7.0 (2019/12/13) useSLabel 属性を追加。, 7.2.7.0 (2020/08/07) outMessage 削除, 7.2.7.0 (2020/08/07) parentClm,nameClm,toParentClm,toNameClm 追加, 7.2.7.0 (2020/08/07) エラー時に処理後に停止(true)するかどうか(useStop対応), 7.2.7.0 (2020/08/07) ERR0050:アクション実行中にエラーが発生しました。
      • getParameterRows

        protected int[] getParameterRows()
        表示データの HybsSystem.ROW_SEL_KEY を元に、選ばれた 行を処理の対象とします。
        オーバーライド:
        getParameterRows クラス内 CommonTagSupport
        戻り値:
        選択行の配列
        このメソッドは、nullを返しません
      • setAction

        public void setAction​(String act)
        【TAG】アクション[COPY|MOVE|MODIFY|DELETE|MKDIRS]をセットします。
        パラメータ:
        act - アクション (public static final 宣言されている文字列)
        関連項目:
        アクション定数
        変更履歴:
        6.3.4.0 (2015/08/01) Arrays.toString から String.join に置き換え。, 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。
        説明:
        アクションは、ファイルをコピー(COPY)したり、移動(MOVE,MODIFY)したり、削除(DELETE)、 フォルダ作成(MKDIRS)するなどの操作を指定する必須属性です。
        action属性(必須)のキーワード
        action名称機能
        COPY コピーオリジナルファイルを、ターゲット(TO_PARENT,TO_NAMEで指定)にコピーします。
        MOVE 移動 オリジナルファイルを、ターゲットに移動(COPY+DELETE)/名称変更(RENAME)します。
        MODIFY移動 (MOVE と同じ。エンジンの command を利用するための簡易action)
        DELETE削除 オリジナルファイルを、削除します。(フォルダ、ファイルに関わらず)
        MKDIRS削除 ターゲット(TO_PARENTで指定)フォルダを作成します。 7.2.7.0 (2020/08/07)
      • setTargetDir

        public void setTargetDir​(String dir)
        【TAG】ターゲットとなるフォルダを指定します(初期値:null)。
        パラメータ:
        dir - ターゲットとなるフォルダ
        関連項目:
        setCreateDir( String )
        説明:
        targetDir 属性を利用する場合は、引数のファイル、またはフォルダが指定されたことに なります。COPY、MOVE(,MODIFY) の場合は、targetDir 属性にフォルダを指定することで一括処理可能です。 指定先のフォルダが存在しない場合は、createDir属性の値により処理が異なります。 createDir="true"(初期値)で、ターゲットフォルダが存在しない場合は、自動作成します。
      • setCreateDir

        public void setCreateDir​(String flag)
        【TAG】ターゲットとなるフォルダがなければ、作成するかどうかを指定します(初期値:true)。
        パラメータ:
        flag - フォルダ作成可否 [true:作成する/false:作成しない]
        説明:
        COPY,MOVE(,MODIFY) などの処理で、ターゲットフォルダが存在しないときに、作成するか、エラーにするかを createDir属性 で指定できます。 これは、COPY先やMOVE(,MODIFY)先が存在している前提のシステムで、不要な箇所に間違ってフォルダを 自動作成されると困る場合に、false:作成しない とすれば、間違いに気づく確率が上がります。 初期値は true:作成する です。
      • setParentClm

        public void setParentClm​(String clm)
        【TAG】fileQuery以外の場合の元親フォルダを示すカラム名を指定します(初期値:"PARENT")。
        パラメータ:
        clm - 元親フォルダを示すカラム名
        変更履歴:
        7.2.7.0 (2020/08/07) parentClm,nameClm,toParentClm,toNameClm 追加
        説明:
        通常、fileQueryで取得したフォルダとファイル名は、PARENT,NAME というカラムに作成されます。 ここでは、データベース等で管理しているフォルダやファイル名を検索した場合に処理できるように それぞれのカラム名を指定できるようにします。 (初期値:"PARENT")
      • setNameClm

        public void setNameClm​(String clm)
        【TAG】fileQuery以外の場合の元ファイル名を示すカラム名を指定します(初期値:"NAME")。
        パラメータ:
        clm - 元ファイル名を示すカラム名
        変更履歴:
        7.2.7.0 (2020/08/07) parentClm,nameClm,toParentClm,toNameClm 追加
        説明:
        通常、fileQueryで取得したフォルダとファイル名は、PARENT,NAME というカラムに作成されます。 ここでは、データベース等で管理しているフォルダやファイル名を検索した場合に処理できるように それぞれのカラム名を指定できるようにします。 (初期値:"NAME")
      • setToParentClm

        public void setToParentClm​(String clm)
        【TAG】fileQuery以外の場合の先親フォルダを示すカラム名を指定します(初期値:"TO_PARENT")。
        パラメータ:
        clm - 先親フォルダを示すカラム名
        変更履歴:
        7.2.7.0 (2020/08/07) parentClm,nameClm,toParentClm,toNameClm 追加
        説明:
        通常、fileQueryで取得したフォルダとファイル名は、PARENT,NAME というカラムに作成されます。 ここでは、データベース等で管理しているフォルダやファイル名を検索した場合に処理できるように それぞれのカラム名を指定できるようにします。 (初期値:"TO_PARENT")
      • setToNameClm

        public void setToNameClm​(String clm)
        【TAG】fileQuery以外の場合の先ファイル名を示すカラム名を指定します(初期値:"TO_NAME")。
        パラメータ:
        clm - 先ファイル名を示すカラム名
        変更履歴:
        7.2.7.0 (2020/08/07) parentClm,nameClm,toParentClm,toNameClm 追加
        説明:
        通常、fileQueryで取得したフォルダとファイル名は、PARENT,NAME というカラムに作成されます。 ここでは、データベース等で管理しているフォルダやファイル名を検索した場合に処理できるように それぞれのカラム名を指定できるようにします。 (初期値:"TO_NAME")
      • setTableId

        public void setTableId​(String id)
        【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します (初期値:HybsSystem#TBL_MDL_KEY[=])。
        パラメータ:
        id - テーブルID (sessionに登録する時のID)
        説明:
        検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に 渡す場合に、通常は、session を利用します。その場合の登録キーです。 query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、 この tableId 属性を利用して、メモリ空間を分けます。 (初期値:HybsSystem#TBL_MDL_KEY[=])。
      • setCommand

        public void setCommand​(String cmd)
        【TAG】コマンド (ENTRY)をセットします(初期値:ENTRY)。
        パラメータ:
        cmd - コマンド (public static final 宣言されている文字列)
        関連項目:
        コマンド定数
        説明:
        このタグは、command="ENTRY" でのみ実行されます。 コマンドは,HTMLから(get/post)指定されますので,CMD_xxx で設定される フィールド定数値のいづれかを、指定できます。 初期値は、ENTRY なので、何も指定しなければ、実行されます。
      • setDisplayMsg

        public void setDisplayMsg​(String id)
        【TAG】処理結果を画面上に表示するメッセージリソースIDを指定します(初期値:MSG0040[ 件登録しました])。
        パラメータ:
        id - 処理結果表示メッセージID
        説明:
        ここでは、検索結果の件数や登録された件数をまず出力し、 その次に、ここで指定したメッセージをリソースから取得して表示します。 表示させたくない場合は, displayMsg = "" をセットしてください。 displayMsg の初期値は、MSG0040[ 件登録しました]です。
      • setActErrMsg

        public void setActErrMsg​(String id)
        【TAG】action実行時のエラーメッセージのメッセージリソースIDを指定します(初期値:ERR0050:アクション実行中にエラーが発生しました。
        パラメータ:
        id - action実行時のエラーメッセージのメッセージリソースID
        変更履歴:
        7.2.7.0 (2020/08/07) MKDIRSアクション 追加
        説明:
        action実行時のエラーメッセージは、COPY|MOVE|MODIFY|DELETE|MKDIRS などのアクション実行時に エラーが発生した際に、表示するメッセージリソースのID をセットします。 エラーメッセージのため、未指定にすることはできません。 actErrMsg の初期値は、ERR0050:アクション実行中にエラーが発生しました。アクション:{0} From:{1} To:{2}
      • setSelectedAll

        public void setSelectedAll​(String all)
        【TAG】データを全件選択済みとして処理するかどうか[true/false]を指定します(初期値:false)。
        パラメータ:
        all - 全件選択済み指定 [true:全件選択済み/false:通常]
        説明:
        全てのデータを選択済みデータとして扱って処理します。 全件処理する場合に、(true/false)を指定します。 初期値は false です。
      • setKeepTimeStamp

        public void setKeepTimeStamp​(String flag)
        【TAG】オリジナルのタイムスタンプを利用するかどうかを指定します(初期値:false)。
        パラメータ:
        flag - タイムスタンプ利用 [true:する/false:しない]
        説明:
        COPYや親違いMOVE(,MODIFY)の時に、オリジナルのタイムスタンプをそのままコピー先のファイルにも 適用するかどうかを指定します。 タイムスタンプを初期化されたくない場合に、true に設定します。 初期値は 利用しない:false です。
      • setUseTimeView

        public void setUseTimeView​(String flag)
        【TAG】処理時間を表示する TimeView を表示するかどうか[true:する/false:しない]を指定します (初期値:VIEW_USE_TIMEBAR[=])。
        パラメータ:
        flag - 処理時間を表示 [true:する/false:しない]
        変更履歴:
        6.3.6.0 (2015/08/16) useTimeView の初期値を、VIEW_USE_TIMEBAR にする。
        説明:
        true に設定すると、処理時間を表示するバーイメージが表示されます。 これは、DB検索、APサーバー処理、画面表示の各処理時間をバーイメージで 表示させる機能です。処理時間の目安になります。 (初期値:VIEW_USE_TIMEBAR[=])。
      • setInPath

        public void setInPath​(String path)
        【TAG】入力共通パスを指定します。
        パラメータ:
        path - 入力共通パス
        変更履歴:
        6.8.0.0 (2017/06/02) 入力共通パスを指定します。, 7.0.5.0 (2019/09/13) inPath のパスは、正規パス名から作成。
        説明:
        通常、fileQueryタグ等で、検索した結果は、PARENT,NAME というカラムにセットされます。 この、fileQueryのfrom属性に、検索を開始するディレクトリを指定し、multi="true"で、 多段階展開 した場合、この、from属性に指定したパスを、inPath にセットすることで、 以下の階層フォルダそのままに、targetDir にCOPY または、MOVE することが出来ます。 逆に、指定しない場合は、フォルダ階層無しで、COPY,MOVE されます。
      • setUseSLabel

        public void setUseSLabel​(String prm)
        【TAG】エラーメッセージにSLABELを利用するかどうか[true/false]を指定します(初期値:false)。
        パラメータ:
        prm - SLABEL利用 [true:利用する/false:利用しない]
        変更履歴:
        7.0.7.0 (2019/12/13) 新規追加
        説明:
        通常のエラーメッセージは、ラベル(長)が使われますが、これをラベル(短)を使いたい場合に、true にセットします。 ここでのラベル(短)は、タグ修飾なしの、ラベル(短)です。 標準はfalse:利用しない=ラベル(長)です。 true/false以外を指定した場合はfalse扱いとします。 ラベルリソースの概要説明があれば表示しますが、useSLabel="true" 時は、概要説明を表示しません。
      • setUseStop

        public void setUseStop​(String flag)
        【TAG】エラー時に処理後に停止するかどうか[true/false]を指定します(初期値:true)。
        パラメータ:
        flag - 処理後停止 [true:する/それ以外:しない]
        変更履歴:
        7.2.7.0 (2020/08/07) エラー時に処理後に停止(true)するかどうか(useStop対応)
        説明:
        処理結果などに応じて、以下の処理を停止したい場合に、使用します。 false を指定すると、判定結果に無関係に、以下の処理を実行します。 処理は継続したいが、警告表示する場合に、useStop="false" を指定します。 初期値は、停止する ("true")です。
      • toString

        public String toString()
        このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
        オーバーライド:
        toString クラス内 CommonTagSupport
        戻り値:
        このクラスの文字列表現
        このメソッドは、nullを返しません