org.opengion.hayabusa.taglib

## クラス DocConvertTag

- java.lang.Object
- - javax.servlet.jsp.tagext.TagSupport
  - - javax.servlet.jsp.tagext.BodyTagSupport
    - - org.opengion.hayabusa.taglib.CommonTagSupport
      - - org.opengion.hayabusa.taglib.DocConvertTag

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

      public class DocConvertTag
      extends CommonTagSupport

  ドキュメントの変換・マージを行うタグです。 変換を行うことのできる入出力のフォーマット以下の通りです。 [対応フォーマット] 入力[Calc(ods) ,Excel(xls) ] ⇒ 出力[Calc(ods) ,Excel(xls) ,PDF] 入力[Writer(odt) ,Word(doc) ] ⇒ 出力[Writer(odt) ,Word(doc) ,PDF] 入力[Impress(odp),PowerPoint(ppt)] ⇒ 出力[Impress(odp),PowerPoint(ppt),PDF] 入出力のフォーマットは、入出力ファイルの拡張子により自動判別されます。 また、入出力ファイル名が同じ場合は何も処理されません。 入力ファイルを、カンマ区切りで複数指定することで、複数の入力ファイルをマージして 出力することもできます。 ※2 現状は、ファイルのマージは、入力ファイルがExcelまたはCalcの場合のみ対応しています。 ※1 この機能を利用するには、OpenOfficeが正しく設定されている必要があります。
  関連項目:
    直列化された形式
  形式サンプル:

         ●形式：<og:docConvert fileURL="…" inputFile="…" outputFile="…" />
         ●body：なし

         ●Tag定義：
           <og:docConvert
               fileURL            【TAG】操作するファイルのディレクトリを指定します (初期値:FILE_URL[=filetemp/])
               inputFile        ○【TAG】入力ファイル名を指定します(必須)。
               inputStorageType   【TAG】入力ファイルのストレージタイプを指定します。(初期値:CLOUD_TARGET)
               inputBucketName     【TAG】入力ファイルのバケット名を指定します。(初期値:CLOUD_BUCKET)
               outputFile       ○【TAG】出力ファイル名を指定します(必須)。
               outputStorageType  【TAG】出力ファイルのストレージタイプを指定します。(初期値:CLOUD_TARGET)
               outputBucketName    【TAG】出力ファイルのバケット名を指定します。(初期値:CLOUD_BUCKET)
               delInput           【TAG】ドキュメント変換後、元のファイルを削除するかどうかを指定します(初期値:false[=削除しない])
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           />

         ●使用例
            ・Calc(ods)ファイルをPDFに変換
                <og:docConvert inputFile="temp.ods" outputFile="out.pdf" />

            ・Excel(xls)ファイルを連結
                <og:docConvert inputFile="temp1.xls,temp2.xls" outputFile="out.xls" />

  変更履歴:

    5.10.9.0 (2019/03/01) oota クラウドストレージ対応を追加。(Fileクラスを拡張)

  機能分類
    その他部品
  バージョン
    4.0
  作成者
    Hiroki Nakamura
  導入されたバージョン:
    JDK5.0,

- - ### フィールドのサマリー

    - ### クラスから継承されたフィールド 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`

  - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `DocConvertTag()`

  - ### メソッドのサマリー

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    `int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setDelInput(java.lang.String flg)` 【TAG】ドキュメント変換後、元のファイルを削除するかどうかを指定します(初期値:false[=削除しない])。
    `void` | `setFileURL(java.lang.String url)` 【TAG】操作するファイルのディレクトリを指定します (初期値:FILE_URL[=filetemp/])。
    `void` | `setInputBucketName(java.lang.String inBucket)` 【TAG】読み取り元バケット名を設定します。
    `void` | `setInputFile(java.lang.String fname)` 【TAG】入力ファイル名を指定します。
    `void` | `setInputStorageType(java.lang.String inStorage)` 【TAG】読み取り元ストレージタイプを設定します。
    `void` | `setOutputBucketName(java.lang.String outBucket)` 【TAG】保存先バケット名を設定します。
    `void` | `setOutputFile(java.lang.String fname)` 【TAG】出力ファイル名を指定します。
    `void` | `setOutputStorageType(java.lang.String outStorage)` 【TAG】保存先ストレージタイプを設定します。
    `java.lang.String` | `toString()` このオブジェクトの文字列表現を返します。

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

      `add, add, addEventColumn, addEventColumn, check, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLASTAttri, getLongLabel, getMsglbl, getNVLAttri, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getTagName, getUser, getUserEditInfo, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, 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`

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

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

    - #### DocConvertTag

          public DocConvertTag()

  - ### メソッドの詳細

    - #### doStartTag

          public int doStartTag()

      Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
      定義:
        `doStartTag` インタフェース内 `Tag`
      オーバーライド:
        `doStartTag` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示( SKIP_BODY )

    - #### doEndTag

          public int doEndTag()

      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
        `doEndTag` インタフェース内 `Tag`
      オーバーライド:
        `doEndTag` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示

    - #### release2

          protected void release2()

      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
        `release2` クラス内 `CommonTagSupport`

    - #### setFileURL

          public void setFileURL(java.lang.String url)

      【TAG】操作するファイルのディレクトリを指定します (初期値:FILE_URL[=filetemp/])。
      パラメータ:
        `url` - ファイルURL
      関連項目:
        `SystemData.FILE_URL`
      説明:

             この属性で指定されるディレクトリのファイルを操作します。
             指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、２文字目が、
             ":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、
             (初期値:システム定数のFILE_URL[={@og.value org.opengion.hayabusa.common.SystemData#FILE_URL}])。

    - #### setInputFile

          public void setInputFile(java.lang.String fname)

      【TAG】入力ファイル名を指定します。
      パラメータ:
        `fname` - 入力ファイル名
      説明:

             入力ファイル名を指定します。

             入力ファイルは、カンマ区切りで複数指定することができます。
             この場合、複数の入力ファイルをマージして出力を行います。

             ※現状は、ファイルのマージは、入力ファイルがExcelまたはCalcの場合のみ対応しています。
               また、マージを行う場合、印刷範囲など、ドキュメントに関連する情報は、1つ目のファイルの
               情報が使用されます。

    - #### setOutputFile

          public void setOutputFile(java.lang.String fname)

      【TAG】出力ファイル名を指定します。
      パラメータ:
        `fname` - 出力ファイル名
      説明:

             出力ファイル名を指定します。
             出力ファイルには、拡張子のみ(xls,ods等)を指定することもできます。
             この場合、出力ファイル名は、入力ファイル名と同じになります。(拡張子のみが変換される)

    - #### setDelInput

          public void setDelInput(java.lang.String flg)

      【TAG】ドキュメント変換後、元のファイルを削除するかどうかを指定します(初期値:false[=削除しない])。
      パラメータ:
        `flg` - 出力元のファイルを削除するかどうか名
      説明:

             ドキュメント変換後、元のファイルを削除するかどうかを指定します。
             (初期値:false(削除しない))

    - #### setInputStorageType

          public void setInputStorageType(java.lang.String inStorage)

      【TAG】読み取り元ストレージタイプを設定します。
      パラメータ:
        `inStorage` - ストレージタイプ
      説明:

             ファイルを読み取り元の、ストレージタイプを設定します。
             未設定の場合は、システムリソースの「CLOUD_TARGET」が参照されます。
             自身のサーバを指定する場合は、「default」を設定してください。

      変更履歴:

        5.10.9.0 (2019/03/01) 新規追加

    - #### setInputBucketName

          public void setInputBucketName(java.lang.String inBucket)

      【TAG】読み取り元バケット名を設定します。
      パラメータ:
        `inBucket` - バケット名
      説明:

             ファイルを読み取り元の、バケット名を指定します。
             クラウドストレージ利用時のみ有効です。
             未設定の場合は、システムリソースの「CLOUD_BUKET」が参照されます。

      変更履歴:

        5.10.9.0 (2019/03/01) 新規追加

    - #### setOutputStorageType

          public void setOutputStorageType(java.lang.String outStorage)

      【TAG】保存先ストレージタイプを設定します。
      パラメータ:
        `outStorage` - ストレージタイプ
      説明:

             ファイルを保存するストレージタイプを設定します。
             未設定の場合は、システムリソースの「CLOUD_TARGET」が参照されます。
             自身のサーバを指定する場合は、「default」を設定してください。

      変更履歴:

        5.10.9.0 (2019/03/01) 新規追加

    - #### setOutputBucketName

          public void setOutputBucketName(java.lang.String outBucket)

      【TAG】保存先バケット名を設定します。
      パラメータ:
        `outBucket` - バケット名
      説明:

             ファイルを保存するバケット名を指定します。
             クラウドストレージ利用時のみ有効です。
             未設定の場合は、システムリソースの「CLOUD_BUKET」が参照されます。

      変更履歴:

        5.10.9.0 (2019/03/01) 新規追加

    - #### toString

          public java.lang.String toString()

      このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
      オーバーライド:
        `toString` クラス内 `CommonTagSupport`
      戻り値:
        このクラスの文字列表現
      変更履歴:

        5.10.9.0 (2019/03/01) inputStorageType,inputBucketName, outputStorageType,outputBucketNameを属性に追加。

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