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

# クラス FileOptionTag

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

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

public class FileOptionTag extends CommonTagSupport
ﾌｧｲﾙのﾌﾟﾙﾀﾞｳﾝﾘｽﾄの作成するﾀｸﾞです｡ SelectﾀｸﾞのBODY部に指定します｡ 並び替えについては､このﾀｸﾞで指定しますが､ﾌｧｲﾙの選別は､ BODY 部に記述する fileWhere ﾀｸﾞで指定します｡

関連項目:
  - 直列化された形式
変更履歴:
  2.1.1.0 (2002/11/11) 新規作成, 4.0.0.0 (2005/01/31) 内部ﾛｼﾞｯｸ改定
機能分類
  その他入力
形式ｻﾝﾌﾟﾙ:
  ●形式：<og:fileOption from="…" value="[…]" ･･･ >･･･</og:fileOption> ●body：あり(EVAL_BODY_BUFFERED:BODYを評価し､{@XXXX} を解析します) ●Tag定義： <og:fileOption from 【TAG】ﾌｧｲﾙの検索元となるﾃﾞｨﾚｸﾄﾘを指定します (初期値:FILE_URL[=filetemp/]) value 【TAG】Optionの初期値で選ばれる値を指定します nameOnly 【TAG】ﾌｧｲﾙの拡張子を除いた名前部分のみの値で行います｡7.2.4.0 (2020/05/11) groupDir 【TAG】optgroupを､ﾃﾞｨﾚｸﾄﾘの値で作成します(１ﾚﾍﾞﾙのみ)｡ orderBy 【TAG】検索した結果を表示する表示順をﾌｧｲﾙ属性名で指定します(初期値:自然順序) desc 【TAG】表示順を逆転するかどうか[true/false]を指定します(初期値:false) useLocal 【TAG】ｼｽﾃﾑ定数でｸﾗｳﾄﾞ設定されていても､ｸﾗｳﾄﾞ環境を使用しない場合､trueを指定します(初期値:false) 8.0.1.0 (2021/10/29) caseKey 【TAG】このﾀｸﾞ自体を利用するかどうかの条件ｷｰを指定します(初期値:null) 6.8.0.0 (2017/06/02) caseVal 【TAG】このﾀｸﾞ自体を利用するかどうかの条件値を指定します(初期値:null) 6.8.0.0 (2017/06/02) caseNN 【TAG】指定の値が､null/ｾﾞﾛ文字列 でない場合(Not Null=NN)は､このﾀｸﾞは使用されます(初期値:判定しない) 6.8.0.0 (2017/06/02) caseNull 【TAG】指定の値が､null/ｾﾞﾛ文字列 の場合は､このﾀｸﾞは使用されます(初期値:判定しない) 6.8.0.0 (2017/06/02) caseIf 【TAG】指定の値が､true/TRUE文字列の場合は､このﾀｸﾞは使用されます(初期値:判定しない) 6.8.0.0 (2017/06/02) debug 【TAG】ﾃﾞﾊﾞｯｸﾞ情報を出力するかどうか[true/false]を指定します(初期値:false) X useDir 【廃止】(廃止：7.2.6.0 (2020/06/30))optionﾘｽﾄの作成を､ﾃﾞｨﾚｸﾄﾘの値で行います｡ > ... Body ... </og:fileOption> ●使用例 ･<og:fileOption val1="ABCD" val2="{@value}" > <og:fileWhere startsWith="ABCD" ･･･ /> </og:fileOption>
導入されたバージョン:
  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`

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

  コンストラクタ
  コンストラクタ
  説明
  `FileOptionTag()`
  ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `int`
  `doAfterBody()`
  Taglibのﾀｸﾞ本体を処理する doAfterBody() を ｵｰﾊﾞｰﾗｲﾄﾞします｡
  `int`
  `doEndTag()`
  Taglibの終了ﾀｸﾞが見つかったときに処理する doEndTag() を ｵｰﾊﾞｰﾗｲﾄﾞします｡
  `int`
  `doStartTag()`
  Taglibの開始ﾀｸﾞが見つかったときに処理する doStartTag() を ｵｰﾊﾞｰﾗｲﾄﾞします｡
  `protected void`
  `release2()`
  ﾀｸﾞﾘﾌﾞｵﾌﾞｼﾞｪｸﾄをﾘﾘｰｽします｡ ｷｬｯｼｭされて再利用されるので､ﾌｨｰﾙﾄﾞの初期設定を行います｡
  `void`
  `setDesc(String flag)`
  【TAG】表示順を逆転するかどうか[true/false]を指定します(初期値:false)｡
  `protected void`
  `setFileFilter(FileFilter filter)`
  FileFilterｵﾌﾞｼﾞｪｸﾄをｾｯﾄします｡ これは､BODY 部に登録した､FileWhereﾀｸﾞによって設定された ﾌｧｲﾙﾌｨﾙﾀｰです｡
  `void`
  `setFrom(String url)`
  【TAG】ﾌｧｲﾙの検索元となるﾃﾞｨﾚｸﾄﾘを指定します (初期値:FILE_URL[=])｡
  `void`
  `setGroupDir(String flag)`
  【TAG】optgroupを､ﾃﾞｨﾚｸﾄﾘの値で作成します(１ﾚﾍﾞﾙのみ)(初期値:false)｡
  `void`
  `setNameOnly(String flag)`
  【TAG】ﾌｧｲﾙの拡張子を除いた名前部分のみの値で行います(初期値:false)｡
  `void`
  `setOrderBy(String ordr)`
  【TAG】検索した結果を表示する表示順をﾌｧｲﾙ属性名[null/NAME/LASTMODIFIED/FILE_LENGTH]で指定します(初期値:自然順序)｡
  `void`
  `setUseDir(String flag)`
  【廃止】optionﾘｽﾄの作成を､ﾃﾞｨﾚｸﾄﾘの値で行います(初期値:false)｡
  `void`
  `setUseLocal(String flag)`
  【TAG】ｼｽﾃﾑ定数でｸﾗｳﾄﾞ設定されていても､ｸﾗｳﾄﾞ環境を使用しない場合､trueを指定します(初期値:false)｡
  `void`
  `setValue(String val)`
  【TAG】Optionの初期値で選ばれる値を指定します｡
  `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`

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

  - ### FileOptionTag

    public FileOptionTag()
    ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ
    変更履歴:
      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.8.0.0 (2017/06/02) caseKey,caseVal,caseNN,caseNull 属性を追加

  - ### doAfterBody

    public int doAfterBody()
    Taglibのﾀｸﾞ本体を処理する doAfterBody() を ｵｰﾊﾞｰﾗｲﾄﾞします｡
    定義:
      `doAfterBody` インタフェース内 `IterationTag`
    オーバーライド:
      `doAfterBody` クラス内 `CommonTagSupport`
    戻り値:
      後続処理の指示(SKIP_BODY)

  - ### doEndTag

    public int doEndTag()
    Taglibの終了ﾀｸﾞが見つかったときに処理する doEndTag() を ｵｰﾊﾞｰﾗｲﾄﾞします｡
    定義:
      `doEndTag` インタフェース内 `Tag`
    オーバーライド:
      `doEndTag` クラス内 `CommonTagSupport`
    戻り値:
      後続処理の指示
    変更履歴:
      3.1.1.2 (2003/04/04) Tomcat4.1 対応｡release2() を doEndTag()で呼ぶ｡, 6.3.4.0 (2015/08/01) useDir 属性と､groupDir 属性 を追加します｡, 6.8.0.0 (2017/06/02) caseKey,caseVal,caseNN,caseNull 属性を追加, 8.0.0.1 (2021/10/08) cloud対応

  - ### release2

    protected void release2()
    ﾀｸﾞﾘﾌﾞｵﾌﾞｼﾞｪｸﾄをﾘﾘｰｽします｡ ｷｬｯｼｭされて再利用されるので､ﾌｨｰﾙﾄﾞの初期設定を行います｡
    オーバーライド:
      `release2` クラス内 `CommonTagSupport`
    変更履歴:
      3.1.1.2 (2003/04/04) Tomcat4.1 対応｡release2() を doEndTag()で呼ぶ｡, 6.3.4.0 (2015/08/01) useDir 属性と､groupDir 属性 を追加します｡, 7.2.4.0 (2020/05/11) nameOnly 属性 を追加します｡, 7.2.6.0 (2020/06/30) ﾃﾞｨﾚｸﾄﾘ処理を統一します｡, 8.0.1.0 (2021/10/29) useLocal 属性を追加｡

  - ### setValue

    public void setValue(String val)
    【TAG】Optionの初期値で選ばれる値を指定します｡
    パラメータ:
      `val` - 初期値で選ばれる値
    説明:
      ｷｰになるのは､ﾌｧｲﾙ属性の NAME です｡(ﾃﾞｨﾚｸﾄﾘなしのﾌｧｲﾙ名) ここで value属性に指定した場合､このﾌｧｲﾙ名と(大文字小文字を無視して) 一致する場合に､ﾌﾟﾙﾀﾞｳﾝの初期値に表示されます｡(selected 属性が設定される｡)

  - ### setUseDir

    public void setUseDir(String flag)
    【廃止】optionﾘｽﾄの作成を､ﾃﾞｨﾚｸﾄﾘの値で行います(初期値:false)｡
    パラメータ:
      `flag` - ﾃﾞｨﾚｸﾄﾘ名のﾘｽﾄで､ｵﾌﾟｼｮﾝを作成するかどうか [true:ﾃﾞｨﾚｸﾄﾘ/false:ﾌｧｲﾙ]
    変更履歴:
      6.3.4.0 (2015/08/01) useDir 属性の追加, 7.2.6.0 (2020/06/30) ﾃﾞｨﾚｸﾄﾘ処理を統一します｡
    説明:
      ﾌｧｲﾙ検索で､ﾃﾞｨﾚｸﾄﾘ名のﾘｽﾄで､ｵﾌﾟｼｮﾝを作成します｡ 初期値は､false (ﾌｧｲﾙ名でﾘｽﾄ) です｡

  - ### setNameOnly

    public void setNameOnly(String flag)
    【TAG】ﾌｧｲﾙの拡張子を除いた名前部分のみの値で行います(初期値:false)｡
    パラメータ:
      `flag` - ﾌｧｲﾙの拡張子を除いた名前部分のみで､ｵﾌﾟｼｮﾝを作成するかどうか [true:名前部分のみ/false:ﾌｧｲﾙ名]
    変更履歴:
      7.2.4.0 (2020/05/11) nameOnly 属性 を追加します｡
    説明:
      ﾌｧｲﾙ検索の値を､ﾌｧｲﾙの拡張子を取り除いた値のみで､ｵﾌﾟｼｮﾝを作成します｡ 初期値は､false (拡張子付きﾌｧｲﾙ名でﾘｽﾄ) です｡

  - ### setGroupDir

    public void setGroupDir(String flag)
    【TAG】optgroupを､ﾃﾞｨﾚｸﾄﾘの値で作成します(１ﾚﾍﾞﾙのみ)(初期値:false)｡
    パラメータ:
      `flag` - ﾃﾞｨﾚｸﾄﾘで階層ﾒﾆｭｰを作成するかどうか [true:階層/false:通常]
    変更履歴:
      6.3.4.0 (2015/08/01) groupDir 属性の追加
    説明:
      optgroupをﾃﾞｨﾚｸﾄﾘで作成することで､階層のﾒﾆｭｰを作成します｡ 初期値は､false(通常) です｡

  - ### setFrom

    public void setFrom(String url)
    【TAG】ﾌｧｲﾙの検索元となるﾃﾞｨﾚｸﾄﾘを指定します (初期値:FILE_URL[=])｡
    パラメータ:
      `url` - ﾌｧｲﾙの検索元となるﾃﾞｨﾚｸﾄﾘ
    関連項目:
      - `SystemData.FILE_URL`
    変更履歴:
      4.0.0.0 (2007/11/20) 指定されたﾃﾞｨﾚｸﾄﾘ名の最後が"\"or"/"で終わっていない場合に､"/"を付加する｡, 6.4.2.1 (2016/02/05) URLの最後に､"/" を追加する処理を廃止｡, 6.4.2.1 (2016/02/05) HybsSystem.url2dir に引数追加｡
    説明:
      ﾌｧｲﾙの検索元となるﾃﾞｨﾚｸﾄﾘを指定します｡ (初期値:ｼｽﾃﾑ定数のFILE_URL[=])｡

  - ### setOrderBy

    public void setOrderBy(String ordr)
    【TAG】検索した結果を表示する表示順をﾌｧｲﾙ属性名[null/NAME/LASTMODIFIED/FILE_LENGTH]で指定します(初期値:自然順序)｡
    パラメータ:
      `ordr` - ｿｰﾄｷｰ [null/NAME/LASTMODIFIED/FILE_LENGTH]
    変更履歴:
      3.5.6.2 (2004/07/05) 文字列の連結にStringBuilderを使用します｡, 4.0.0.0 (2005/01/31) 新規ﾛｼﾞｯｸで改定, 5.3.4.0 (2011/04/01) ORDER_BYﾘｽﾄの出力方法 見直し, 6.3.4.0 (2015/08/01) Arrays.toString から String.join に置き換え｡, 6.4.3.4 (2016/03/11) String配列 から､Setに置き換えます｡
    説明:
      ﾌｧｲﾙをｿｰﾄする順(Comparator)を指定します｡ｿｰﾄに指定できる ﾌｧｲﾙ属性名は､"NAME","LASTMODIFIED","FILE_LENGTH" の内のどれかひとつです｡ 何も指定しない場合は､Fileｵﾌﾞｼﾞｪｸﾄの自然順序でのｿｰﾄになります｡ (※ 下位互換性のため､LENGTH も残しますが､廃止予定です｡)

  - ### setDesc

    public void setDesc(String flag)
    【TAG】表示順を逆転するかどうか[true/false]を指定します(初期値:false)｡
    パラメータ:
      `flag` - 表示順を逆転するかどうか [true:逆順/false:昇順]
    説明:
      orderBy 属性で指定した表示順を､逆順にするかどうかを指定できます｡ 初期値は､false (昇順) です｡

  - ### 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扱いとします｡

  - ### setFileFilter

    protected void setFileFilter(FileFilter filter)
    FileFilterｵﾌﾞｼﾞｪｸﾄをｾｯﾄします｡ これは､BODY 部に登録した､FileWhereﾀｸﾞによって設定された ﾌｧｲﾙﾌｨﾙﾀｰです｡
    パラメータ:
      `filter` - ｵﾌﾞｼﾞｪｸﾄ

  - ### toString

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