openGionopenGion
5.4.3.5

org.opengion.hayabusa.taglib
クラス FileUpdateTag

java.lang.Object
  上位を拡張 javax.servlet.jsp.tagext.TagSupport
      上位を拡張 javax.servlet.jsp.tagext.BodyTagSupport
          上位を拡張 org.opengion.hayabusa.taglib.CommonTagSupport
              上位を拡張 org.opengion.hayabusa.taglib.FileUpdateTag
すべての実装されたインタフェース:
java.io.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 というカラムでなければなりません。 このカラム名は、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:作成しない) とすれば、間違いに気づく確率が上がります。 ※ このタグは、Transaction タグの対象ではありません。

関連項目:
直列化された形式
形式サンプル:
 ●body:なし
 ●形式:
      ・<og:fileUpdate
          action      = "COPY|MOVE|MODIFY|DELETE" アクション属性(必須)
          command     = "[ENTRY]"                 ENTRY 時のみ実行します。(初期値:ENTRY)
          targetDir   = "[指定フォルダ]"          ターゲットとなるフォルダ
          createDir   = "[true/false]"            ターゲットとなるフォルダがなければ作成する(true)かどうか(初期値:true)
          tableId     = [HybsSystem.TBL_MDL_KEY]  DBTableModel を取り出すキー
          outMessage  = "[true/false]"            検索結果のメッセージを表示する(true)かどうかを指定(初期値:true)
          displayMsg  = "MSG0040";                処理結果を表示します。(初期値:「 件登録しました。」)
          selectedAll = "[false/true]"            データを全件選択済みとして処理する(true)かどうか指定(初期値:false)
          keepTimeStamp = "[false/true]"          COPY,親違いMOVE(,MODIFY)の時にオリジナルのタイムスタンプを使用するかどうか(初期値:false)
      />

    [action属性(必須)]
      COPY   オリジナルファイルを、ターゲットにコピーします。
      MOVE   オリジナルファイルを、ターゲットに移動(COPY+DELETE)/名称変更(RENAME)します。
      MODIFY (MOVE と同じ。エンジンの command を利用するための簡易action)
      DELETE オリジナルファイルを、削除します。(フォルダ、ファイルに関わらず)

 ●使用例
       ・<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 フォルダに移動します。
             ファイル名は、そのままオリジナルの値が使用されます。
変更履歴:
5.3.4.0 (2011/04/01) 新規追加
機能階層
ファイル出力
バージョン
4.0
作成者
Kazuhiko Hasegawa
導入されたバージョン:
JDK5.0,

フィールドの概要
static java.lang.String ACT_COPY
          action 引数に渡す事の出来る アクションコマンド COPY "COPY"
static java.lang.String ACT_DELETE
          action 引数に渡す事の出来る アクションコマンド DELETE "DELETE"
static java.lang.String ACT_MODIFY
          action 引数に渡す事の出来る アクションコマンド MODIFY "MODIFY"
static java.lang.String ACT_MOVE
          action 引数に渡す事の出来る アクションコマンド MOVE "MOVE"
static java.lang.String CMD_ENTRY
          command 引数に渡す事の出来る コマンド 登録"ENTRY"
 
クラス javax.servlet.jsp.tagext.BodyTagSupport から継承されたフィールド
bodyContent
 
クラス javax.servlet.jsp.tagext.TagSupport から継承されたフィールド
id, pageContext
 
インタフェース javax.servlet.jsp.tagext.BodyTag から継承されたフィールド
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
インタフェース javax.servlet.jsp.tagext.IterationTag から継承されたフィールド
EVAL_BODY_AGAIN
 
インタフェース javax.servlet.jsp.tagext.Tag から継承されたフィールド
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
コンストラクタの概要
FileUpdateTag()
           
 
メソッドの概要
 int doEndTag()
          Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
protected  int[] getParameterRows()
          表示データの HybsSystem.ROW_SEL_KEY を元に、選ばれた 行を 処理の対象とします。
protected  void release2()
          タグリブオブジェクトをリリースします。
 void setAction(java.lang.String act)
          【TAG】アクション(SAVE,LOAD,DELETE)をセットします。
 void setCommand(java.lang.String cmd)
          【TAG】コマンド(ENTRY)をセットします。
 void setCreateDir(java.lang.String flag)
          【TAG】ターゲットとなるフォルダがなければ、作成するかどうかを指定します(初期値:true)。
 void setDisplayMsg(java.lang.String id)
          【TAG】処理結果を画面上に表示するメッセージリソースIDを指定します(初期値:MSG0033[ 件検索しました])。
 void setKeepTimeStamp(java.lang.String flag)
          【TAG】オリジナルのタイムスタンプを利用するかどうかを指定します(初期値:false)。
 void setOutMessage(java.lang.String flag)
          【TAG】検索結果のメッセージを表示する/しない(true/false)を指定します(初期値:true)。
 void setSelectedAll(java.lang.String all)
          【TAG】データを全件選択済みとして処理するかどうか(true/false)を指定します(初期値:false)。
 void setTableId(java.lang.String id)
          【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します。
 void setTargetDir(java.lang.String dir)
          【TAG】ターゲットとなるフォルダを指定します。
 java.lang.String toString()
          このオブジェクトの文字列表現を返します。
 
クラス org.opengion.hayabusa.taglib.CommonTagSupport から継承されたメソッド
add, add, addEventColumn, addEventColumn, check, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, doStartTag, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getLabel, getLabelInterface, getLanguage, getLongLabel, getMsglbl, getObject, getParameterNames, getRequest, getRequestAttribute, getRequestCacheData, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getTagName, getUser, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseKey, setCaseVal, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setNoTransitionRequest, setObject, setObject, setParameterNames, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, startQueryTransaction, sys, sysBool, sysInt, useMainTrans, useQuotCheck, useTag, useXssCheck
 
クラス javax.servlet.jsp.tagext.BodyTagSupport から継承されたメソッド
doInitBody, getBodyContent, getPreviousOut, release, setBodyContent
 
クラス javax.servlet.jsp.tagext.TagSupport から継承されたメソッド
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
インタフェース javax.servlet.jsp.tagext.Tag から継承されたメソッド
getParent, setPageContext, setParent
 

フィールドの詳細

CMD_ENTRY

public static final java.lang.String CMD_ENTRY
command 引数に渡す事の出来る コマンド 登録"ENTRY"

関連項目:
定数フィールド値

ACT_COPY

public static final java.lang.String ACT_COPY
action 引数に渡す事の出来る アクションコマンド COPY "COPY"

関連項目:
定数フィールド値

ACT_MOVE

public static final java.lang.String ACT_MOVE
action 引数に渡す事の出来る アクションコマンド MOVE "MOVE"

関連項目:
定数フィールド値

ACT_MODIFY

public static final java.lang.String ACT_MODIFY
action 引数に渡す事の出来る アクションコマンド MODIFY "MODIFY"

関連項目:
定数フィールド値

ACT_DELETE

public static final java.lang.String ACT_DELETE
action 引数に渡す事の出来る アクションコマンド DELETE "DELETE"

関連項目:
定数フィールド値
コンストラクタの詳細

FileUpdateTag

public FileUpdateTag()
メソッドの詳細

doEndTag

public int doEndTag()
Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。

定義:
インタフェース javax.servlet.jsp.tagext.Tag 内の doEndTag
オーバーライド:
クラス CommonTagSupport 内の doEndTag
戻り値:
int 後続処理の指示

release2

protected void release2()
タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。

オーバーライド:
クラス CommonTagSupport 内の release2

getParameterRows

protected int[] getParameterRows()
表示データの HybsSystem.ROW_SEL_KEY を元に、選ばれた 行を 処理の対象とします。

オーバーライド:
クラス CommonTagSupport 内の getParameterRows
戻り値:
int[]

setAction

public void setAction(java.lang.String act)
【TAG】アクション(SAVE,LOAD,DELETE)をセットします。

パラメータ:
act - アクション(public static final 宣言されている文字列)
関連項目:
アクション定数
説明:
 アクションは,HTMLから(get/post)指定されますので,ACT_xxx で設定される
 フィールド定数値のいづれかを、指定できます。
 無指定の場合は、なにもしません。

 
action 名称機能
SAVE 登録指定の keys のキーに vals の値をセットします。
LOAD 取得指定の keys のクッキーを(リクエスト中に)取得します。
DELETE 削除指定の keys のクッキーを削除します。

setTargetDir

public void setTargetDir(java.lang.String dir)
【TAG】ターゲットとなるフォルダを指定します。

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

setCreateDir

public void setCreateDir(java.lang.String flag)
【TAG】ターゲットとなるフォルダがなければ、作成するかどうかを指定します(初期値:true)。

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

setTableId

public void setTableId(java.lang.String id)
【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します。

パラメータ:
id - sessionに登録する時の ID
説明:
 検索結果より、DBTableModel オブジェクトを作成します。これを、以下のview 等のタグに
 渡す場合に、通常は、session を利用します。その場合の登録キーです。
 query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、
 この tableId 属性を利用して、メモリ空間を分けます。
 初期値は、HybsSystem.TBL_MDL_KEY です。

setCommand

public void setCommand(java.lang.String cmd)
【TAG】コマンド(ENTRY)をセットします。

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

setOutMessage

public void setOutMessage(java.lang.String flag)
【TAG】検索結果のメッセージを表示する/しない(true/false)を指定します(初期値:true)。

パラメータ:
flag - 表示する ("true")/含めない (それ以外)
説明:
 初期値は、表示する:true です。

setDisplayMsg

public void setDisplayMsg(java.lang.String id)
【TAG】処理結果を画面上に表示するメッセージリソースIDを指定します(初期値:MSG0033[ 件検索しました])。

パラメータ:
id - ディスプレイに表示させるメッセージ ID
説明:
 ここでは、検索結果の件数や登録された件数をまず出力し、
 その次に、ここで指定したメッセージをリソースから取得して表示します。
 表示させたくない場合は, displayMsg = "" をセットしてください。
 なお、システムリソースの VIEW_USE_DISPLAY_MSG にて、表示する/しない を指定できます。
 VIEW_USE_DISPLAY_MSG の初期値は、false(表示しない)です。
 displayMsg の初期値は、MSG0033[ 件検索しました]です。

setSelectedAll

public void setSelectedAll(java.lang.String all)
【TAG】データを全件選択済みとして処理するかどうか(true/false)を指定します(初期値:false)。

パラメータ:
all - データを全件選択済み(true) / 通常(false)
説明:
 全てのデータを選択済みデータとして扱って処理します。
 全件処理する場合に、(true/false)を指定します。
 初期値は false です。

setKeepTimeStamp

public void setKeepTimeStamp(java.lang.String flag)
【TAG】オリジナルのタイムスタンプを利用するかどうかを指定します(初期値:false)。

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

toString

public java.lang.String toString()
このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。

オーバーライド:
クラス CommonTagSupport 内の toString
戻り値:
このクラスの文字列表現

openGion 5.4.3.5

Webアプリケーションフレームワーク openGion
SourceForge.JPCopyright (c) 2009 The openGion Project.