パッケージ 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) useLocal 【TAG】ｼｽﾃﾑ定数でｸﾗｳﾄﾞ設定されていても､ｸﾗｳﾄﾞ環境を使用しない場合､trueを指定します(初期値:false) 8.0.1.0 (2021/10/29) 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`
  `setUseLocal(String flag)`
  【TAG】ｼｽﾃﾑ定数でｸﾗｳﾄﾞ設定されていても､ｸﾗｳﾄﾞ環境を使用しない場合､trueを指定します(初期値:false)｡
  `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, 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 属性を追加｡, 8.0.0.2 (2021/10/15) ﾛｰｶﾙﾌｧｲﾙとｸﾗｳﾄﾞﾌｧｲﾙ間の移動

  - ### 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 属性を追加｡, 8.0.1.0 (2021/10/29) useLocal 属性を追加｡

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

  - ### setUseLocal

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

  - ### 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を返しません