org.opengion.hayabusa.report2

## クラス ExecQueue

- java.lang.Object
- - org.opengion.hayabusa.report2.ExecQueue

-     public class ExecQueue
      extends Object

       帳票処理要求を管理するキューオブジェクトです。
       このオブジェクトでは、帳票の定義及びデータと、処理中に発生したエラーメッセージを管理します。
       また、このキューを生成したオブジェクトもこのオブジェクトにセットされます。

  機能分類
    帳票システム
  バージョン
    4.0
  作成者
    Hiroki.Nakamura
  導入されたバージョン:
    JDK1.6

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

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `protected static String` | `CSV_PRINT` 実行方法 "G"
    `protected static String` | `CSV_PRINT_EXCEL` 実行方法 "H"
    `protected static String` | `CSV_PRINT_EXCEL2` 実行方法 "J"
    `protected static String` | `CSV_PRINT_PDF` 実行方法 "I"
    `protected static String` | `IN_EXEC_ONLY` 実行方法 "6"
    `protected static String` | `IN_INPUT_EXEC` 実行方法 "7"
    `protected static String` | `IN_INPUT_ONLY` 実行方法 "5"
    `protected static int` | `MAX_SHEETS_PER_FILE` 最大シート数 256
    `protected static String` | `OUT_ODS_EXCEL` 実行方法 "E"
    `protected static String` | `OUT_ODS_ODS` 実行方法 "S"
    `protected static String` | `OUT_ODS_ONLY` 実行方法 "1"
    `protected static String` | `OUT_ODS_PDF` 実行方法 "P"
    `protected static String` | `OUT_ODS_PRINT` 実行方法 "3"
    `protected static String` | `OUT_ODS_PRINT_PDF` 実行方法 "Q"
    `protected static String` | `OUT_PRINT_ONLY` 実行方法 "2"
    `protected static String` | `RFID_ALLERASE` 実行方法 "C"
    `protected static String` | `RFID_ALLPRINT` 実行方法 "B"
    `protected static String` | `RFID_PRINT` 実行方法 "A"
    `protected static String` | `RFID_SEQERASE` 実行方法 "D"

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `addExecPageCnt(int pgs)` 処理したページ数を引数の分だけカウントアップします。
    `void` | `addMsg(String msg)` エラーメッセージをセットします。
    `DBTableModel` | `getBody()` ボディー部分のDBTableModelを取得します。
    `String` | `getDmnGrp()` デーモングループを取得します。
    `int` | `getExecPagesCnt()` 処理したページ数を返します。
    `int` | `getExecRowCnt()` 処理した行数を返します。
    `DBTableModel` | `getFooter()` フッター部分のDBTableModelを取得します。
    `String` | `getGrpId()` グループIDを取得します。
    `DBTableModel` | `getHeader()` ヘッダー部分のDBTableModelを取得します。
    `String` | `getLang()` 言語を取得します。
    `String` | `getListId()` 帳票IDを取得します。
    `String` | `getMsg()` エラーメッセージを取得します。
    `String` | `getOutputName()` 出力ファイル名を取得します。
    `String` | `getOutputType()` 出力タイプを取得します。
    `String` | `getPdfPasswd()` PDFパスワードを取得します。
    `String` | `getPrgDir()` 実行ファイルディレクトリを取得します。
    `String` | `getPrgFile()` 実行ファイル名を取得します。
    `String` | `getPrinterName()` プリンター名を取得します。
    `String` | `getPrtId()` プリンタIDを取得します。
    `String` | `getSystemId()` システムIDを取得します。
    `String` | `getTemplateName()` 雛形ファイル名を取得します。
    `String` | `getThreadId()` 処理要求を処理するスレッドIDを取得します。
    `String` | `getYkno()` 要求NOを取得します。
    `boolean` | `isEnd()` 全ての行が処理されているかを返します。
    `boolean` | `isFgcut()` ページエンドカットフラグを取得します。
    `boolean` | `isFglocal()` ローカルリソース使用フラグを取得します。
    `boolean` | `isUseSheetName()` PAGEBREAKカラムの値を、シート名として使うかどうかを取得します。
    `void` | `setBody(DBTableModel body)` ボディー部分のDBTableModelをセットします。
    `void` | `setComplete()` キューを完了済の状態に更新します。
    `void` | `setData()` 帳票処理データをセットします。
    `void` | `setDmnGrp(String name)` デーモングループをセットします。
    `void` | `setEnd(boolean flag)` 全ての行が処理されたかをセットします(初期値:false)。
    `void` | `setError()` キューをエラーの状態に更新します。
    `void` | `setExecRowCnt(int rws)` 処理した行数をセットします。
    `void` | `setExecute()` キューを実行中の状態に更新します。
    `void` | `setFgcut(boolean fgcut)` ページエンドカットフラグをセットします(初期値:false)。
    `void` | `setFglocal(boolean fglocal)` ローカルリソース使用フラグをセットします(初期値:false)。
    `void` | `setFooter(DBTableModel footer)` フッター部分のDBTableModelをセットします。
    `void` | `setGrpId(String id)` グループIDをセットします。
    `void` | `setHeader(DBTableModel header)` ヘッダー部分のDBTableModelをセットします。
    `void` | `setLang(String lang)` 言語をセットします。
    `void` | `setListId(String listId)` 帳票IDをセットします。
    `void` | `setManager(QueueManager manager)` キューマネージャーをセットします。
    `void` | `setOutputName(String outputName)` 出力ファイル名をセットします。
    `void` | `setOutputName(String outputDir, String outputFile, String type, String yokyu)` 出力ファイル名を設定します。
    `void` | `setOutputType(String outputType)` 実行方法をセットします。
    `void` | `setPdfPasswd(String pdfPasswd)` PDFパスワードをセットします。
    `void` | `setPrgDir(String dir)` 実行ファイルディレクトリを指定します。
    `void` | `setPrgFile(String file)` 実行ファイル名をセットします。
    `void` | `setPrinterName(String printerName)` プリンター名をセットします。
    `void` | `setPrtId(String id)` プリンタIDをセットします。
    `void` | `setSystemId(String systemId)` システムIDをセットします。
    `void` | `setTemplateName(String templateName)` 雛形ファイル名をセットします。
    `void` | `setThreadId(String threadId)` 処理要求を処理するスレッドIDをセットします。
    `void` | `setUseSheetName(boolean useSheetName)` PAGEBREAKカラムの値を、シート名として使うかどうかをセットします(初期値:false)。
    `void` | `setYkno(String ykno)` 要求NOをセットします。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### フィールドの詳細

    - #### OUT_ODS_ONLY

          protected static final String OUT_ODS_ONLY

      実行方法 "1"
      関連項目:
        定数フィールド値

    - #### OUT_PRINT_ONLY

          protected static final String OUT_PRINT_ONLY

      実行方法 "2"
      関連項目:
        定数フィールド値

    - #### OUT_ODS_PRINT

          protected static final String OUT_ODS_PRINT

      実行方法 "3"
      関連項目:
        定数フィールド値

    - #### OUT_ODS_PDF

          protected static final String OUT_ODS_PDF

      実行方法 "P"
      関連項目:
        定数フィールド値

    - #### OUT_ODS_PRINT_PDF

          protected static final String OUT_ODS_PRINT_PDF

      実行方法 "Q"
      関連項目:
        定数フィールド値

    - #### OUT_ODS_EXCEL

          protected static final String OUT_ODS_EXCEL

      実行方法 "E"
      関連項目:
        定数フィールド値

    - #### OUT_ODS_ODS

          protected static final String OUT_ODS_ODS

      実行方法 "S"
      関連項目:
        定数フィールド値

    - #### IN_INPUT_ONLY

          protected static final String IN_INPUT_ONLY

      実行方法 "5"
      関連項目:
        定数フィールド値

    - #### IN_EXEC_ONLY

          protected static final String IN_EXEC_ONLY

      実行方法 "6"
      関連項目:
        定数フィールド値

    - #### IN_INPUT_EXEC

          protected static final String IN_INPUT_EXEC

      実行方法 "7"
      関連項目:
        定数フィールド値

    - #### RFID_PRINT

          protected static final String RFID_PRINT

      実行方法 "A"
      関連項目:
        定数フィールド値

    - #### RFID_ALLPRINT

          protected static final String RFID_ALLPRINT

      実行方法 "B"
      関連項目:
        定数フィールド値

    - #### RFID_ALLERASE

          protected static final String RFID_ALLERASE

      実行方法 "C"
      関連項目:
        定数フィールド値

    - #### RFID_SEQERASE

          protected static final String RFID_SEQERASE

      実行方法 "D"
      関連項目:
        定数フィールド値

    - #### CSV_PRINT

          protected static final String CSV_PRINT

      実行方法 "G"
      関連項目:
        定数フィールド値

    - #### CSV_PRINT_EXCEL

          protected static final String CSV_PRINT_EXCEL

      実行方法 "H"
      関連項目:
        定数フィールド値

    - #### CSV_PRINT_PDF

          protected static final String CSV_PRINT_PDF

      実行方法 "I"
      関連項目:
        定数フィールド値

    - #### CSV_PRINT_EXCEL2

          protected static final String CSV_PRINT_EXCEL2

      実行方法 "J"
      関連項目:
        定数フィールド値

    - #### MAX_SHEETS_PER_FILE

          protected static final int MAX_SHEETS_PER_FILE

      最大シート数 256
      関連項目:
        定数フィールド値

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

    - #### ExecQueue

          public ExecQueue()

      デフォルトコンストラクター
      変更履歴:

        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

  - ### メソッドの詳細

    - #### setYkno

          public void setYkno(String ykno)

      要求NOをセットします。
      パラメータ:
        `ykno` - 要求NO

    - #### getYkno

          public String getYkno()

      要求NOを取得します。
      戻り値:
        要求NO

    - #### setSystemId

          public void setSystemId(String systemId)

      システムIDをセットします。
      パラメータ:
        `systemId` - システムID

    - #### getSystemId

          public String getSystemId()

      システムIDを取得します。
      戻り値:
        StringシステムID

    - #### setBody

          public void setBody(DBTableModel body)

      ボディー部分のDBTableModelをセットします。
      パラメータ:
        `body` - DBTableModelオブジェクト

    - #### getBody

          public DBTableModel getBody()

      ボディー部分のDBTableModelを取得します。
      戻り値:
        ボディー部分のDBTableModelオブジェクト

    - #### setHeader

          public void setHeader(DBTableModel header)

      ヘッダー部分のDBTableModelをセットします。
      パラメータ:
        `header` - DBTableModelオブジェクト

    - #### getHeader

          public DBTableModel getHeader()

      ヘッダー部分のDBTableModelを取得します。
      戻り値:
        ヘッダー部分のDBTableModelオブジェクト

    - #### setFooter

          public void setFooter(DBTableModel footer)

      フッター部分のDBTableModelをセットします。
      パラメータ:
        `footer` - DBTableModelオブジェクト

    - #### getFooter

          public DBTableModel getFooter()

      フッター部分のDBTableModelを取得します。
      戻り値:
        フッター部分のDBTableModelオブジェクト

    - #### setListId

          public void setListId(String listId)

      帳票IDをセットします。
      パラメータ:
        `listId` - 帳票ID

    - #### getListId

          public String getListId()

      帳票IDを取得します。
      戻り値:
        帳票ID

    - #### setPdfPasswd

          public void setPdfPasswd(String pdfPasswd)

      PDFパスワードをセットします。
      パラメータ:
        `pdfPasswd` - PDFパスワード

    - #### getPdfPasswd

          public String getPdfPasswd()

      PDFパスワードを取得します。
      戻り値:
        PDFパスワード

    - #### setLang

          public void setLang(String lang)

      言語をセットします。
      パラメータ:
        `lang` - 言語

    - #### getLang

          public String getLang()

      言語を取得します。
      戻り値:
        言語

    - #### setTemplateName

          public void setTemplateName(String templateName)

      雛形ファイル名をセットします。
      パラメータ:
        `templateName` - 雛形ファイル名

    - #### getTemplateName

          public String getTemplateName()

      雛形ファイル名を取得します。
      戻り値:
        帳票雛形ファイル名

    - #### setOutputType

          public void setOutputType(String outputType)

      実行方法をセットします。
      パラメータ:
        `outputType` - 実行方法

    - #### getOutputType

          public String getOutputType()

      出力タイプを取得します。
      戻り値:
        出力タイプ

    - #### setPrinterName

          public void setPrinterName(String printerName)

      プリンター名をセットします。
      パラメータ:
        `printerName` - プリンター名

    - #### getPrinterName

          public String getPrinterName()

      プリンター名を取得します。
      戻り値:
        プリンタ名

    - #### setThreadId

          public void setThreadId(String threadId)

      処理要求を処理するスレッドIDをセットします。
      パラメータ:
        `threadId` - スレッドID

    - #### getThreadId

          public String getThreadId()

      処理要求を処理するスレッドIDを取得します。
      戻り値:
        スレッドID

    - #### setOutputName

          public void setOutputName(String outputName)

      出力ファイル名をセットします。
      パラメータ:
        `outputName` - 出力ファイル名

    - #### setOutputName

          public void setOutputName(String outputDir,
                                    String outputFile,
                                    String type,
                                    String yokyu)

      出力ファイル名を設定します。 GE50に設定されていない場合は第四引数(要求番号)を利用する。 その場合、タイプに応じた拡張子が自動設定される。 ".xls" : OUT_ODS_EXCEL ".pdf" : OUT_ODS_PDF , OUT_ODS_PRINT_PDF ".ods" : OUT_ODS_ODS ".xml" : RFID_PRINT , RFID_ALLPRINT , RFID_ALLERASE , RFID_SEQERASE ".csv" : CSV_PINT , CSV_PRINT_EXCEL , CSV_PRINT_PDF
      パラメータ:
        `outputDir` - 出力ディレクトリ名
        `outputFile` - 出力ファイル名
        `type` - タイプ
        `yokyu` - 要求番号(ファイル名が指定されていない場合のファイル名)
      変更履歴:

        4.3.3.4 (2008/11/01) ODS出力対応
        5.4.3.0 (2011/12/26) RFIDデフォルト対応
        5.4.4.1 (2012/02/03) RFID拡張子変更
        5.9.0.0 (2015/09/04) CSV対応

    - #### getOutputName

          public String getOutputName()

      出力ファイル名を取得します。
      戻り値:
        出力先ファイル名
      変更履歴:

        5.1.2.0 (2010/01/01) 256シートを超える場合に対応。2ファイル目以降は、_1、_2･･･をファイル名の後ろにつける
        6.3.9.0 (2015/11/06) コンストラクタで初期化されていないフィールドを null チェックなしで利用している(findbugs)

      このメソッドは、nullを返しません

    - #### setPrgDir

          public void setPrgDir(String dir)

      実行ファイルディレクトリを指定します。
      パラメータ:
        `dir` - ディレクトリ
      変更履歴:

        4.3.3.0 (2008/10/01) 板金RFID対応

    - #### getPrgDir

          public String getPrgDir()

      実行ファイルディレクトリを取得します。
      戻り値:
        プログラムディレクトリ
      変更履歴:

        4.3.3.0 (2008/10/01) 板金RFID対応

    - #### setPrgFile

          public void setPrgFile(String file)

      実行ファイル名をセットします。
      パラメータ:
        `file` - ファイル名
      変更履歴:

        4.3.3.0 (2008/10/01) 板金RFID対応

    - #### getPrgFile

          public String getPrgFile()

      実行ファイル名を取得します。
      戻り値:
        プログラムファイル名
      変更履歴:

        4.3.3.0 (2008/10/01) 板金RFID対応

    - #### setPrtId

          public void setPrtId(String id)

      プリンタIDをセットします。
      パラメータ:
        `id` - プリンタID
      変更履歴:

        4.3.3.0 (2008/10/01) 板金RFID対応

    - #### getPrtId

          public String getPrtId()

      プリンタIDを取得します。
      戻り値:
        プリンタID
      変更履歴:

        4.3.3.0 (2008/10/01) 板金RFID対応

    - #### setGrpId

          public void setGrpId(String id)

      グループIDをセットします。
      パラメータ:
        `id` - グループID
      変更履歴:

        5.9.2.2 (2015/11/20)

    - #### getGrpId

          public String getGrpId()

      グループIDを取得します。
      戻り値:
        グループID
      変更履歴:

        5.9.2.2 (2015/11/20)

    - #### setDmnGrp

          public void setDmnGrp(String name)

      デーモングループをセットします。
      パラメータ:
        `name` - デーモングループ
      変更履歴:

        5.9.2.2 (2015/11/20)

    - #### getDmnGrp

          public String getDmnGrp()

      デーモングループを取得します。
      戻り値:
        デーモングループ
      変更履歴:

        5.9.2.2 (2015/11/20)

    - #### setFglocal

          public void setFglocal(boolean fglocal)

      ローカルリソース使用フラグをセットします(初期値:false)。
      パラメータ:
        `fglocal` - ローカルリソース使用フラグ[true:使用する/false:使用しない]

    - #### isFglocal

          public boolean isFglocal()

      ローカルリソース使用フラグを取得します。
      戻り値:
        ロールリソース使用フラグ[true:使用する/false:使用しない]

    - #### setFgcut

          public void setFgcut(boolean fgcut)

      ページエンドカットフラグをセットします(初期値:false)。
      パラメータ:
        `fgcut` - ページエンドカットの使用可否[true:使用/false:通常]

    - #### isFgcut

          public boolean isFgcut()

      ページエンドカットフラグを取得します。
      戻り値:
        ページエンドカットフラグ

    - #### setUseSheetName

          public void setUseSheetName(boolean useSheetName)

      PAGEBREAKカラムの値を、シート名として使うかどうかをセットします(初期値:false)。
      パラメータ:
        `useSheetName` - PAGEBREAKカラムのシート名使用可否[true:使用/false:使用しない]
      変更履歴:

        5.7.6.2 (2014/05/16) 新規追加

    - #### isUseSheetName

          public boolean isUseSheetName()

      PAGEBREAKカラムの値を、シート名として使うかどうかを取得します。
      戻り値:
        PAGEBREAKカラムのシート名使用可否[true:使用/false:使用しない]
      変更履歴:

        5.7.6.2 (2014/05/16) 新規追加

    - #### setManager

          public void setManager(QueueManager manager)

      キューマネージャーをセットします。
      パラメータ:
        `manager` - キューマネージャー

    - #### setData

          public void setData()

      帳票処理データをセットします。 既にテーブルモデルがセットされている場合は、再セットしません。

    - #### setExecute

          public void setExecute()

      キューを実行中の状態に更新します。

    - #### setComplete

          public void setComplete()

      キューを完了済の状態に更新します。

    - #### setError

          public void setError()

      キューをエラーの状態に更新します。

    - #### addMsg

          public void addMsg(String msg)

      エラーメッセージをセットします。
      パラメータ:
        `msg` - エラーメッセージ

    - #### getMsg

          public String getMsg()

      エラーメッセージを取得します。
      戻り値:
        エラーメッセージ
      このメソッドは、nullを返しません

    - #### addExecPageCnt

          public void addExecPageCnt(int pgs)

      処理したページ数を引数の分だけカウントアップします。
      パラメータ:
        `pgs` - カウントアップするページ数
      変更履歴:

        5.1.2.0 (2010/01/01) 新規追加

    - #### getExecPagesCnt

          public int getExecPagesCnt()

      処理したページ数を返します。
      戻り値:
        処理したページ数
      変更履歴:

        5.1.2.0 (2010/01/01) 新規追加

    - #### setExecRowCnt

          public void setExecRowCnt(int rws)

      処理した行数をセットします。
      パラメータ:
        `rws` - 処理した行数
      変更履歴:

        5.1.2.0 (2010/01/01) 新規追加

    - #### getExecRowCnt

          public int getExecRowCnt()

      処理した行数を返します。
      戻り値:
        処理した行数
      変更履歴:

        5.1.2.0 (2010/01/01) 新規追加

    - #### setEnd

          public void setEnd(boolean flag)

      全ての行が処理されたかをセットします(初期値:false)。 これは、処理結果が、256シートを超えていた場合、再度残りのデータについて 処理を行うかどうかの判定するために、利用します。
      パラメータ:
        `flag` - 全ての行が処理されたか
      変更履歴:

        5.1.2.0 (2010/01/01) 新規追加

    - #### isEnd

          public boolean isEnd()

      全ての行が処理されているかを返します。 これは、処理結果が、256シートを超えていた場合、再度残りのデータについて 処理を行うかどうかの判定するために、利用します。
      戻り値:
        全ての行が処理されたか
      変更履歴:

        5.1.2.0 (2010/01/01) 新規追加

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