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

# クラス DirectWriteTableTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
jakarta.servlet.jsp.tagext.BodyTagSupport
org.opengion.hayabusa.taglib.CommonTagSupport
org.opengion.hayabusa.taglib.DirectWriteTableTag

すべての実装されたインタフェース:
  `BodyTag`, `IterationTag`, `JspTag`, `Tag`, `TryCatchFinally`, `Serializable`

public class DirectWriteTableTag extends CommonTagSupport
SELECT文を直接実行して、指定のファイルに出力するタグです。 中間の、データ(DBTableModel)を作成しないため、余計なメモリを取らず、 高速にデータを抜き出すことが可能です。 一方、抜き出すデータは生データのため、データの再利用等、システム的な 使用を想定しています。 JDBCErrMsg 形式のPL/SQL をコールして、その検索結果(カーソル)を抜く事もできます。 ※ このタグは、Transaction タグの対象です。

関連項目:
  - 直列化された形式
変更履歴:
  3.5.6.0 (2004/06/18) 新規作成, 3.6.1.0 (2005/01/05) PL/SQLコール(JDBCErrMsg 形式)の実行を追加
機能分類
  ファイル出力
形式ｻﾝﾌﾟﾙ:
  ●形式：<og:directWriteTable filename="[･･･]" ･･･ >SELECT * FROM ZYXX </og:directWriteTable > ●body：あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します) ●Tag定義： <og:directWriteTable fileURL 【TAG】保存先ディレクトリ名を指定します (初期値:FILE_URL[=filetemp/]) filename 【TAG】ファイルを作成するときのファイル名をセットします(初期値:システムパラメータのFILE_FILENAME) encode 【TAG】ファイルを作成するときのファイルエンコーディング名をセットします (初期値:FILE_ENCODE[=UnicodeLittle]) fileAppend 【TAG】追加モードで書き込むかどうか[true/false]を指定します(初期値:false[通常モード]) zip 【TAG】結果をファイルに出力するときに、ZIPで圧縮するかどうか[true/false]を指定します(初期値:false) zipFilename 【TAG】ZIPファイルを作成するときのZIPファイル名をセットします(初期値:filename + ".zip") separator 【TAG】可変長ファイルを作成するときの項目区切り文字をセットします (初期値:TAB_SEPARATOR) useHeader 【TAG】ヘッダーを書き込むかどうか[true/false]を指定します(初期値:true) useQuote 【TAG】データをダブルクオートで囲うかどうか指定します(初期値:false) useQuoteEscape 【TAG】データ中にダブルクオート文字が含まれる場合、エスケープするかどうか指定します(初期値:true) useReturnQuote 【TAG】データ中に改行コードが含まれる場合、ダブルクオートで囲うかどうか指定します(初期値:true) replaceFrom 【TAG】置換元文字を指定。一文字単位で置換します(初期値:null 置換なし)。 replaceTo 【TAG】置換先文字を指定。一文字単位で置換します。 displayMsg 【TAG】検索結果を画面上に表示するメッセージリソースIDを指定します(初期値:VIEW_DISPLAY_MSG[=]) notfoundMsg 【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした]) fetchSize 【TAG】(通常は使いません)データのフェッチサイズを指定します(初期値:DB_FETCH_SIZE[=]) names 【TAG】PL/SQLを利用する場合の引数にセットすべき データの名称をCSV形式で複数指定します queryType 【TAG】Query を発行する為のクラスID(JDBC,JDBCErrMsg)を指定します() dbid 【TAG】(通常は使いません)検索時のDB接続IDを指定します(初期値:DEFAULT) useNumber 【TAG】行番号を出力するかどうか(初期値:true) quotCheck 【TAG】リクエスト情報の シングルクォート(') 存在チェックを実施するかどうか[true/false]を設定します(初期値:USE_SQL_INJECTION_CHECK) xssCheck 【TAG】リクエスト情報の HTMLTag開始/終了文字(><) 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_XSS_CHECK[=true]) useTimeView 【TAG】処理時間を表示する TimeView を表示するかどうかを指定します (初期値:VIEW_USE_TIMEBAR[=])。 useSLabel 【TAG】7.0.7.0 (2019/12/13) ｴﾗｰﾒｯｾｰｼﾞにSLABELを利用するかどうか[true/false]を指定します(初期値:false) mapObjKey 【TAG】7.0.7.1 (2019/12/24) valueタグのaction=MAPOBJ を使用したﾗﾍﾞﾙ変換を行う場合の、MAPOBJｷｰを指定します。 caseKey 【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) caseVal 【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) caseNN 【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) caseNull 【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) caseIf 【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない) debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) > ... Body ... </og:directWriteTable> ●使用例 <og:directWriteTable dbid = "ORCL" 接続データベースID(初期値:DEFAULT) separator = "," ファイルの区切り文字(初期値:タブ) fileURL = "{@USER.ID}" 保存先ディレクトリ名 filename = "{@filename}" 保存ファイル名 encode = "UnicodeLittle" 保存ファイルエンコード名 useHeader = "true" 保存ファイルにヘッダーを出力するかどうか useQuote = "false" データをダブルクオートで囲うかどうか useQuoteEscape = "true" ダブルクオート文字が含まれる場合、エスケープするかどうか useReturnQuote = "true" 改行コードが含まれる場合、ダブルクオートで囲うかどうか replaceFrom = "',"*%|" 置換元文字を指定。一文字単位で置換します。 replaceTo = "’，”＊％｜" 置換先文字を指定。一文字単位で置換します。 zip = "true" ZIPファイルに圧縮するかどうか zipFilename = "Sample.zip" ZIPファイルのファイル名 fileAppend = "true" ファイルを追加モードで登録するかどうか displayMsg = "MSG0033" 実行後の表示メッセージ fetchSize = "200" DB検索する場合のフェッチするサイズ > SELECT * FROM ZYXX </og:directWriteTable > <og:directWriteTable fileURL = "{@USER.ID}" 保存先ディレクトリ名 filename = "{@filename}" 保存ファイル名 names = "AAA,BBB,CCC,･･･" 指定のキーに対応するリクエスト値を ARG_ARRAY にセットします。 queryType = "JDBCErrMsg" JDBCErrMsg 形式のPL/SQL をコールします。 > { call PL/SQL(?,?,?,? ) } </og:directWriteTable >
導入されたバージョン:
  JDK5.0,

- ## フィールドの概要

  ### クラスから継承されたフィールド org.opengion.hayabusa.taglib.CommonTagSupport

  `BR, BUFFER_MIDDLE, CR`

  ### クラスから継承されたフィールド jakarta.servlet.jsp.tagext.BodyTagSupport

  `bodyContent`

  ### クラスから継承されたフィールド jakarta.servlet.jsp.tagext.TagSupport

  `id, pageContext`

  ### インタフェースから継承されたフィールド jakarta.servlet.jsp.tagext.BodyTag

  `EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

  ### インタフェースから継承されたフィールド jakarta.servlet.jsp.tagext.IterationTag

  `EVAL_BODY_AGAIN`

  ### インタフェースから継承されたフィールド jakarta.servlet.jsp.tagext.Tag

  `EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

- ## コンストラクタの概要

  コンストラクタ
  コンストラクタ
  説明
  `DirectWriteTableTag()`
  デフォルトコンストラクター

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `int`
  `doAfterBody()`
  Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
  `int`
  `doEndTag()`
  Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
  `int`
  `doStartTag()`
  Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
  `protected void`
  `release2()`
  タグリブオブジェクトをリリースします。
  `void`
  `setDbid(String id)`
  【TAG】(通常は使いません)検索時のDB接続IDを指定します(初期値:DEFAULT)。
  `void`
  `setDisplayMsg(String id)`
  【TAG】検索結果を画面上に表示するメッセージリソースIDを指定します (初期値:VIEW_DISPLAY_MSG[=])。
  `void`
  `setEncode(String enc)`
  【TAG】ファイルを作成するときのファイルエンコーディング名をセットします (初期値:FILE_ENCODE[=])。
  `void`
  `setFetchSize(String size)`
  【TAG】(通常は使いません)データのフェッチサイズを指定します (初期値:DB_FETCH_SIZE[=])。
  `void`
  `setFileAppend(String flag)`
  【TAG】追加モードで書き込むかどうか[true/false]を指定します(初期値:false[新規モード])。
  `void`
  `setFilename(String fname)`
  【TAG】ファイルを作成するときのファイル名をセットします(初期値:システムパラメータのFILE_FILENAME)。
  `void`
  `setFileURL(String url)`
  【TAG】保存先ディレクトリ名を指定します (初期値:FILE_URL[=])。
  `void`
  `setMapObjKey(String key)`
  【TAG】valueタグのaction=MAPOBJ を使用したﾗﾍﾞﾙ変換を行う場合の、MAPOBJｷｰを指定します。
  `void`
  `setNames(String nm)`
  【TAG】PL/SQLを利用する場合の引数にセットすべき データの名称をCSV形式で複数指定します。
  `void`
  `setNotfoundMsg(String id)`
  【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした])。
  `void`
  `setQueryType(String id)`
  【TAG】Query を発行する為のクラスID(JDBC,JDBCErrMsg)を指定します()。
  `void`
  `setQuotCheck(String flag)`
  【TAG】リクエスト情報の シングルクォート(') 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_SQL_INJECTION_CHECK[=])。
  `void`
  `setReplaceFrom(String str)`
  【TAG】一文字単位で置換する置換元文字を指定します(初期値:null 置換なし)。
  `void`
  `setReplaceTo(String str)`
  【TAG】一文字単位で置換する置換先文字を指定します。
  `void`
  `setSeparator(String sep)`
  【TAG】可変長ファイルを作成するときの項目区切り文字(セパレータ)をセットします(初期値:TAB_SEPARATOR)。
  `void`
  `setUseHeader(String flag)`
  【TAG】ヘッダーを書き込むかどうか[true/false]を指定します(初期値:true)。
  `void`
  `setUseNumber(String flag)`
  【TAG】ファイル出力時に、行番号情報を、出力する/しない[true/false]を指定します(初期値:true)。
  `void`
  `setUseQuote(String flag)`
  【TAG】データをダブルクオートで囲うかどうか指定します(初期値:false)。
  `void`
  `setUseQuoteEscape(String flag)`
  【TAG】データ中にダブルクオート文字が含まれる場合、エスケープするかどうか指定します(初期値:true)。
  `void`
  `setUseReturnQuote(String flag)`
  【TAG】データ中に改行コードが含まれる場合、ダブルクオートで囲うかどうか指定します(初期値:true)。
  `void`
  `setUseSLabel(String prm)`
  【TAG】ｴﾗｰﾒｯｾｰｼﾞにSLABELを利用するかどうか[true/false]を指定します(初期値:false)。
  `void`
  `setUseTimeView(String flag)`
  【TAG】処理時間を表示する TimeView を表示するかどうか[true:する/false:しない]を指定します (初期値:VIEW_USE_TIMEBAR[=])。
  `void`
  `setXssCheck(String flag)`
  【TAG】リクエスト情報の HTMLTag開始/終了文字(><) 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_XSS_CHECK[=])。
  `void`
  `setZip(String flag)`
  【TAG】結果をファイルに出力するときに、ZIPで圧縮するかどうか[true/false]を指定します(初期値:false)。
  `void`
  `setZipFilename(String zipFile)`
  【TAG】ZIPファイルを作成するときのZIPファイル名をセットします(初期値:filename + ".zip")。
  `String`
  `toString()`
  このオブジェクトの文字列表現を返します。

  ### クラスから継承されたメソッド org.opengion.hayabusa.taglib.CommonTagSupport

  `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, doCatch, doFinally, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getCSVParameter, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLongLabel, getMsg, getMsglbl, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getTagName, getTransaction, getUser, getUserEditInfo, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, makeUrl, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseIf, setCaseKey, setCaseNN, setCaseNull, setCaseVal, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setNoTransitionRequest, setObject, setObject, setParameterNames, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, startQueryTransaction, sys, sysBool, sysInt, useMainTrans, useQuotCheck, useTag, useXssCheck`

  ### クラスから継承されたメソッド jakarta.servlet.jsp.tagext.BodyTagSupport

  `doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

  ### クラスから継承されたメソッド jakarta.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`

  ### インタフェースから継承されたメソッド jakarta.servlet.jsp.tagext.Tag

  `getParent, setPageContext, setParent`

- ## コンストラクタの詳細

  - ### DirectWriteTableTag

    public DirectWriteTableTag()
    デフォルトコンストラクター
    変更履歴:
      6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

- ## メソッドの詳細

  - ### doStartTag

    public int doStartTag()
    Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    定義:
      `doStartTag` インタフェース内 `Tag`
    オーバーライド:
      `doStartTag` クラス内 `CommonTagSupport`
    戻り値:
      後続処理の指示( EVAL_BODY_BUFFERED )
    変更履歴:
      6.0.3.0 (2014/11/13) 置換元文字,置換先文字のチェック, 6.3.4.0 (2015/08/01) caseKey,caseVal,caseNN,caseNull,caseIf 属性対応, 6.4.8.1 (2016/07/02) xssCheckを、doStartTag に移動

  - ### doAfterBody

    public int doAfterBody()
    Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
    定義:
      `doAfterBody` インタフェース内 `IterationTag`
    オーバーライド:
      `doAfterBody` クラス内 `CommonTagSupport`
    戻り値:
      後続処理の指示(SKIP_BODY)
    変更履歴:
      3.8.6.3 (2006/11/30) SQL 文の前後のスペースを取り除きます。, 6.2.2.0 (2015/03/27) XSSチェック,クォートチェック をサポートします。, 6.4.8.1 (2016/07/02) xssCheckを、doStartTag に移動

  - ### doEndTag

    public int doEndTag()
    Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    定義:
      `doEndTag` インタフェース内 `Tag`
    オーバーライド:
      `doEndTag` クラス内 `CommonTagSupport`
    戻り値:
      後続処理の指示
    変更履歴:
      3.6.1.0 (2005/01/05) PL/SQLコール(JDBCErrMsg 形式)への対応, 4.0.0.0 (2007/10/18) メッセージリソース統合( getResource().getMessage ⇒ getResource().getLabel ), 6.0.4.0 (2014/11/28) Zip処理を、ZipOutputStream → ZipArchiveOutputStream に変更, 6.3.4.0 (2015/08/01) caseKey,caseVal,caseNN,caseNull,caseIf 属性対応, 6.3.8.0 (2015/09/11) FileUtil#getPrintWriter( OutputStream,String ) を使用。, 7.0.7.0 (2019/12/13) useSLabel 属性を追加。

  - ### release2

    protected void release2()
    タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
    オーバーライド:
      `release2` クラス内 `CommonTagSupport`
    変更履歴:
      3.6.1.0 (2005/01/05) PL/SQLコール(JDBCErrMsg 形式)への対応, 4.0.0.0 (2007/10/10) dbid の初期値を、"DEFAULT" から null に変更, 5.5.7.1 (2012/10/05) useNumber追加, 6.0.3.0 (2014/11/13) useHeader,useQuote,useQuoteEscape,useReturnQuote,replaceFrom,replaceTo追加, 6.2.2.0 (2015/03/27) XSSチェック,クォートチェック をサポートします。, 6.9.3.0 (2018/03/26) fetchSizeの初期値を100→HybsConst.DB_FETCH_SIZE に変更, 7.0.7.0 (2019/12/13) useSLabel 属性を追加。, 7.0.7.1 (2019/12/24) mapObjKey 属性を追加。

  - ### setDbid

    public void setDbid(String id)
    【TAG】(通常は使いません)検索時のDB接続IDを指定します(初期値:DEFAULT)。
    パラメータ:
      `id` - DB接続ID
    説明:
      検索時のDB接続IDを指定します。初期値は、DEFAULT です。

  - ### setSeparator

    public void setSeparator(String sep)
    【TAG】可変長ファイルを作成するときの項目区切り文字(セパレータ)をセットします(初期値:TAB_SEPARATOR)。
    パラメータ:
      `sep` - セパレータ
    関連項目:
      - `TAB_SEPARATOR`
    説明:
      可変長ファイルを作成するときの項目区切り文字をセットします。 (初期値:ローカル定義のTAB_SEPARATOR)。

  - ### setFileURL

    public void setFileURL(String url)
    【TAG】保存先ディレクトリ名を指定します (初期値:FILE_URL[=])。
    パラメータ:
      `url` - 保存先ディレクトリ名
    関連項目:
      - `SystemData.FILE_URL`
    変更履歴:
      3.5.4.3 (2004/01/05) 内部処理を、makeFileURL に移動。, 4.0.0.0 (2005/01/31) StringUtil.urlAppend メソッドの利用, 4.0.0.0 (2007/11/20) 指定されたディレクトリ名の最後が"\"or"/"で終わっていない場合に、"/"を付加する。, 6.4.2.1 (2016/02/05) URLの最後に、"/" を追加する処理を廃止。
    説明:
      この属性で指定されるディレクトリに、ファイルをセーブします。 指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、２文字目が、 ":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、 fileURL = "{@USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、 さらに、各個人ID別のフォルダを作成して、そこにセーブします。 (初期値:システム定数のFILE_URL[=])。

  - ### setFilename

    public void setFilename(String fname)
    【TAG】ファイルを作成するときのファイル名をセットします(初期値:システムパラメータのFILE_FILENAME)。
    パラメータ:
      `fname` - ファイル名
    説明:
      ファイルを作成するときのファイル名をセットします。

  - ### setEncode

    public void setEncode(String enc)
    【TAG】ファイルを作成するときのファイルエンコーディング名をセットします (初期値:FILE_ENCODE[=])。
    パラメータ:
      `enc` - ファイルエンコーディング名
    関連項目:
      - IANA Charset Registry
      - `SystemData.FILE_ENCODE`
    変更履歴:
      2.2.0.0 (2002/12/17) 中国語(国際化)対応 エンコードの取得方法変更, 3.1.3.0 (2003/04/10) FILE_ENCODE から、エンコード情報を取得する。
    説明:
      "DEFAULT","JISAutoDetect" ,"JIS", "EUC_JP", "MS932", "SJIS" , "Windows-31J" , "Shift_JIS" (初期値:システム定数のFILE_ENCODE[=])。

  - ### setUseHeader

    public void setUseHeader(String flag)
    【TAG】ヘッダーを書き込むかどうか[true/false]を指定します(初期値:true)。
    パラメータ:
      `flag` - ヘッダー有無 [true:書き込む/false:書き込まない]
    説明:
      #Name ････ ヘッダーの書き込みを指定します。 通常は、書き込み(true)にしておき、使用側でコメントと解釈するように 処理を行うべきです。コメントのため、append モードで途中に現れても 無視できます。また、エンジン標準でデータを取り込む場合に、データの配置が 変更されても取り込みプログラムはそのまま使用できます。 初期値は、true(書き込む)です。

  - ### setUseQuote

    public void setUseQuote(String flag)
    【TAG】データをダブルクオートで囲うかどうか指定します(初期値:false)。
    パラメータ:
      `flag` - ダブルクオート使用 [true:書き込む/false:書き込まない]
    変更履歴:
      6.0.3.0 (2014/11/13) 新規追加
    説明:
      データを出力する場合、ダブルクオートで囲うかどうか指定します。 主に、区切り文字(separator)を、タブではなく、カンマを使う場合に、使用します。 なお、ヘッダー部は、この指定に関わらず、ダブルクオートで囲いません。 初期値は、false(囲わない)です。

  - ### setUseQuoteEscape

    public void setUseQuoteEscape(String flag)
    【TAG】データ中にダブルクオート文字が含まれる場合、エスケープするかどうか指定します(初期値:true)。
    パラメータ:
      `flag` - ダブルクオートエスケープ有無 [true:する/false:しない]
    変更履歴:
      6.0.3.0 (2014/11/13) 新規追加
    説明:
      データ中にダブルクオート文字が含まれる場合、エスケープするかどうか指定します。 ここでいうエスケープとは、ダブルクオート文字を重ねる処理を指します。 初期値は、互換性の関係で、true(処理する)です。

  - ### setUseReturnQuote

    public void setUseReturnQuote(String flag)
    【TAG】データ中に改行コードが含まれる場合、ダブルクオートで囲うかどうか指定します(初期値:true)。
    パラメータ:
      `flag` - 改行コード処理 [true:する/false:しない]
    関連項目:
      - `setUseQuote(String)`
    変更履歴:
      6.0.3.0 (2014/11/13) 新規追加
    説明:
      データ中に改行コードが含まれたテキストの場合、EXCELで開くと、改行されてしまう。 その場合、ダブルクオートで囲うと、セルに設定してくれます。 この処理は、useQuote="true" にすると、無条件に、データは囲われます。 初期値は、互換性の関係で、true(処理する)です。

  - ### setReplaceFrom

    public void setReplaceFrom(String str)
    【TAG】一文字単位で置換する置換元文字を指定します(初期値:null 置換なし)。
    パラメータ:
      `str` - 置換元文字
    変更履歴:
      6.0.3.0 (2014/11/13) 新規追加, 6.2.2.0 (2015/03/27) \n,\r,\t をサポートします。
    説明:
      データ出力時に、禁則文字を、置き換える元の文字を指定します。 ここでは、一文字単位で、置換しますので、禁則文字は、連続の文字列の 形で、指定します。 なお、ヘッダー部は、この指定に関わらず、ダブルクオートで囲いません。 初期値は、null の場合は、何も変換しません。 文字数は、replaceTo と同じでなければなりません。

  - ### setReplaceTo

    public void setReplaceTo(String str)
    【TAG】一文字単位で置換する置換先文字を指定します。
    パラメータ:
      `str` - 置換先文字
    変更履歴:
      6.0.3.0 (2014/11/13) 新規追加, 6.2.2.0 (2015/03/27) \n,\r,\t をサポートします。
    説明:
      データ出力時に、禁則文字を、置き換える先の文字を指定します。 ここでは、一文字単位で、置換しますので、禁則文字は、連続の文字列の 形で、指定します。(例えば、全角文字にするとか) 初期値は、null の場合は、何も変換しません。 文字数は、replaceFrom と同じでなければなりません。

  - ### setFileAppend

    public void setFileAppend(String flag)
    【TAG】追加モードで書き込むかどうか[true/false]を指定します(初期値:false[新規モード])。
    パラメータ:
      `flag` - 追加モード [true:追加モード/false:新規モード]
    説明:
      ファイルを書き込む場合、追加モードで書き込むかどうかをセットします。 新規モード(true)の場合、既存のファイルが存在し、かつ書き込み許可があれば、 上書きで新規に作成します。 初期値は、false(新規モード)です。

  - ### setZip

    public void setZip(String flag)
    【TAG】結果をファイルに出力するときに、ZIPで圧縮するかどうか[true/false]を指定します(初期値:false)。
    パラメータ:
      `flag` - ZIP圧縮 [true:する/それ以外:しない]
    関連項目:
      - `setZipFilename(String)`
    説明:
      大量に抜き出す場合、そのまま、サーバーから取り出すだけでも大変です。 zip 属性を、true にすると、GZIP で圧縮したファイルを作成します。 初期値は、false(圧縮しない)です。

  - ### setZipFilename

    public void setZipFilename(String zipFile)
    【TAG】ZIPファイルを作成するときのZIPファイル名をセットします(初期値:filename + ".zip")。
    パラメータ:
      `zipFile` - ZIPファイル名
    関連項目:
      - `setZip(String)`
    説明:
      zip 属性に、true を指定した場合に、ZIPファイル化します。その場合のファイル名を指定します。 なにも指定しない場合は、filename + ".zip" になります。

  - ### setDisplayMsg

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

  - ### setNotfoundMsg

    public void setNotfoundMsg(String id)
    【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした])。
    パラメータ:
      `id` - ゼロ件時表示メッセージID
    説明:
      ここでは、検索結果がゼロ件の場合のみ、特別なメッセージを表示させます。 従来は、displayMsg と兼用で、『0　件検索しました』という表示でしたが、 displayMsg の初期表示は、OFF になりましたので、ゼロ件の場合のみ別に表示させます。 表示させたくない場合は, notfoundMsg = "" をセットしてください。 初期値は、MSG0077[対象データはありませんでした]です。

  - ### setFetchSize

    public void setFetchSize(String size)
    【TAG】(通常は使いません)データのフェッチサイズを指定します (初期値:DB_FETCH_SIZE[=])。
    パラメータ:
      `size` - フェッチ行数
    説明:
      より多くの行が必要なときに、データベースから取り出す必要がある行数に ついてのヒントを JDBC ドライバに提供します。 指定された行数は、この Statement を使って作成された結果セットにだけ影響します。 指定された値が 0 の場合、ヒントは無視されます。 (初期値:システム定数のDB_FETCH_SIZE[=])。

  - ### setNames

    public void setNames(String nm)
    【TAG】PL/SQLを利用する場合の引数にセットすべき データの名称をCSV形式で複数指定します。
    パラメータ:
      `nm` - 引数の名称 (CSV形式)
    変更履歴:
      3.6.1.0 (2005/01/05) PL/SQLコール(JDBCErrMsg 形式)への対応
    説明:
      複数ある場合は、CSV形式で渡します。 PL/SQL を使用しない場合は、無視されます。

  - ### setQueryType

    public void setQueryType(String id)
    【TAG】Query を発行する為のクラスID(JDBC,JDBCErrMsg)を指定します()。
    パラメータ:
      `id` - Query発行クラスID
    変更履歴:
      3.6.1.0 (2005/01/05) PL/SQLコール(JDBCErrMsg 形式)への対応
    説明:
      ストアドプロシージャ等を実行する場合に、queryType="JDBCErrMsg" を 指定する必要があります。(それ以外の指定は、初期値の JDBC になります。) 初期値は、"JDBC" です。

  - ### setUseNumber

    public void setUseNumber(String flag)
    【TAG】ファイル出力時に、行番号情報を、出力する/しない[true/false]を指定します(初期値:true)。
    パラメータ:
      `flag` - 行番号出力 [true:する/それ以外:しない]
    変更履歴:
      5.5.7.1 (2012/10/05) 新規追加
    説明:
      通常のフォーマットでは、各行の先頭に行番号を出力します。 これは、#NAME 属性を使用する場合には、必ず出力する必要があります。 (#NAME 属性は、読み取り時にあれば、自動的にカラムに割り当てられます。) この、先頭の行番号が不要な場合(つまり、他のシステムへのデータ出力等) の為に出力する場合に、false を設定することで、行番号列を出力しない ようにできます。 初期値は、true(出力する) です。

  - ### setQuotCheck

    public void setQuotCheck(String flag)
    【TAG】リクエスト情報の シングルクォート(') 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_SQL_INJECTION_CHECK[=])。
    パラメータ:
      `flag` - クォートチェック [true:する/それ以外:しない]
    変更履歴:
      6.2.2.0 (2015/03/27) XSSチェック,クォートチェック をサポートします。
    説明:
      ＳＱＬインジェクション対策の一つとして、暫定的ではありますが、SQLのパラメータに 渡す文字列にシングルクォート(') を許さない設定にすれば、ある程度は防止できます。 数字タイプの引数には、 or 5=5 などのシングルクォートを使用しないコードを埋めても、 数字チェックで検出可能です。文字タイプの場合は、必ず (')をはずして、 ' or 'A' like 'A のような形式になる為、(')チェックだけでも有効です。 (') が含まれていたエラーにする(true)／かノーチェックか(false)を指定します。 初期値は、SystemData#USE_SQL_INJECTION_CHECK です。

  - ### setXssCheck

    public void setXssCheck(String flag)
    【TAG】リクエスト情報の HTMLTag開始/終了文字(><) 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_XSS_CHECK[=])。
    パラメータ:
      `flag` - XSSチェック [true:する/false:しない]
    関連項目:
      - `SystemData.USE_XSS_CHECK`
    変更履歴:
      6.2.2.0 (2015/03/27) XSSチェック,クォートチェック をサポートします。
    説明:
      クロスサイトスクリプティング(XSS)対策の一環としてless/greater than signについてのチェックを行います。 (><) が含まれていたエラーにする(true)／かノーチェックか(false)を指定します。 (初期値:システム定数のUSE_XSS_CHECK[=])

  - ### 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[=])。

  - ### 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" 時は、概要説明を表示しません。

  - ### setMapObjKey

    public void setMapObjKey(String key)
    【TAG】valueタグのaction=MAPOBJ を使用したﾗﾍﾞﾙ変換を行う場合の、MAPOBJｷｰを指定します。
    パラメータ:
      `key` - valueタグで作成したMAPOBJを取り出すときのｷｰ
    変更履歴:
      7.0.7.1 (2019/12/24) mapObjKey 属性を追加。
    説明:
      DirectWriteTableTagでは、SQL文から直接ﾌｧｲﾙを作成するため、headLabel はresource から 取得します。 通常の DBTableModel を作成する場合には、ColumnEditorTag でuseLabelMapとしてSQL文でｷｰとﾗﾍﾞﾙの Mapを作成してﾗﾍﾞﾙの書き換えが行えますが、それと同等の事を行うためには、一旦、valueタグで、 command="SQL" action=MAPOBJ で、ｷｰとﾗﾍﾞﾙのMapを作成して、ﾗﾍﾞﾙとして使用します。 なお、Mapｵﾌﾞｼﾞｪｸﾄは、scope="request" でのみやり取り可能です。

  - ### toString

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