クラス ExecQueue

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

public class ExecQueue extends Object
帳票処理要求を管理するキューオブジェクトです。 このオブジェクトでは、帳票の定義及びデータと、処理中に発生したエラーメッセージを管理します。 また、このキューを生成したオブジェクトもこのオブジェクトにセットされます。
機能分類
帳票システム
導入されたバージョン:
JDK1.6
  • フィールドの概要

    フィールド
    修飾子とタイプ
    フィールド
    説明
    protected static final int
    最大シート数 999
    protected static final String
    実行方法(FGRUN) "E"
    protected static final String
    実行方法(FGRUN) "S"
    protected static final String
    実行方法(FGRUN) "1"
    protected static final String
    実行方法(FGRUN) "P"
    protected static final String
    実行方法(FGRUN) "3"
    protected static final String
    実行方法(FGRUN) "Q"
    protected static final String
    実行方法(FGRUN) "F"
    protected static final String
    実行方法(FGRUN) "2"
  • コンストラクタの概要

    コンストラクタ
    コンストラクタ
    説明
    デフォルトコンストラクター
  • メソッドの概要

    修飾子とタイプ
    メソッド
    説明
    void
    addExecPageCnt(int pgs)
    処理したページ数を引数の分だけカウントアップします。 これは、256シート以上を印刷する場合、ファイル名に"_"を付けて 出力する機能と、GE50のSUPAGEカラムに印刷ページ数をセットするのに 使用しています。 openOfficeのシート制限は解除されていますが、SUPAGEカラムが NUMBER(3) でDB定義されているため、1000以上のページを、GE50 に セットすると、エラーになります。 DB定義を変更するまでの間、最大ページ数を、999 としておきます。
    void
    エラーメッセージをセットします。
    ボディー部分のDBTableModelを取得します。
    ボディー部分のテキスト区分の配列を取得します。
    int
    処理したページ数を返します。
    int
    処理した行数を返します。
    フッター部分のDBTableModelを取得します。
    ヘッダー部分のDBTableModelを取得します。
    言語を取得します。
    帳票IDを取得します。
    エラーメッセージを取得します。
    出力ファイル名を取得します。
    出力タイプ:実行方法(FGRUN)を取得します。
    PDFパスワードを取得します。
    プリンター名を取得します。
    システムIDを取得します。
    テンポラリ出力のキーとなる文字列を生成して返します。 systemId + FS + listId + FS + ykno を連結します。
    雛形ファイル名を取得します。
    処理要求を処理するスレッドIDを取得します。
    要求NOを取得します。
    boolean
    全ての行が処理されているかを返します。 これは、処理結果が、256シートを超えていた場合、再度残りのデータについて 処理を行うかどうかの判定するために、利用します。
    boolean
    ページエンドカットフラグを取得します。
    boolean
    ローカルリソース使用フラグを取得します。
    boolean
    PAGEBREAKカラムの値を、シート名として使うかどうかを取得します。
    void
    ボディー部分のDBTableModelをセットします。
    void
    setBodyTypes(String[] bodyTypes)
    ボディー部分のテキスト区分の配列をセットします。
    void
    キューを完了済の状態に更新します。
    void
    帳票処理データをセットします。 既にテーブルモデルがセットされている場合は、再セットしません。
    void
    setEnd(boolean flag)
    全ての行が処理されたかをセットします(初期値:false)。 これは、処理結果が、256シートを超えていた場合、再度残りのデータについて 処理を行うかどうかの判定するために、利用します。
    void
    キューをエラーの状態に更新します。
    void
    setExecRowCnt(int rws)
    処理した行数をセットします。
    void
    キューを実行中の状態に更新します。
    void
    setFgcut(boolean fgcut)
    ページエンドカットフラグをセットします(初期値:false)。
    void
    setFglocal(boolean fglocal)
    ローカルリソース使用フラグをセットします(初期値:false)。
    void
    フッター部分のDBTableModelをセットします。
    void
    ヘッダー部分のDBTableModelをセットします。
    void
    言語をセットします。
    void
    setListId(String listId)
    帳票IDをセットします。
    void
    キューマネージャーをセットします。
    void
    setOutputName(String outputName)
    出力ファイル名をセットします。
    void
    setOutputName(String outputDir, String outputFile, String fgrun, String yokyu)
    出力ファイル名を設定します。 GE50に設定されていない場合は第四引数(要求番号)を利用する。 その場合、タイプ:実行方法(FGRUN)に応じた拡張子が自動設定される。 ".xls" : OUT_ODS_EXCEL ".xlsx" : OUT_ODS_XLSX // 8.0.1.0 (2021/10/29) ".pdf" : OUT_ODS_PDF , OUT_ODS_PRINT_PDF ".ods" : OUT_ODS_ODS // * ".xml" : RFID_PRINT , RFID_ALLPRINT , RFID_ALLERASE , RFID_SEQERASE 7.4.4.0 (2021/06/30) Delete // * ".csv" : CSV_PRINT , CSV_PRINT_EXCEL , CSV_PRINT_PDF
    void
    setOutputType(String outputType)
    実行方法(FGRUN)をセットします。
    void
    setPdfPasswd(String pdfPasswd)
    PDFパスワードをセットします。
    void
    setPrinterName(String printerName)
    プリンター名をセットします。
    void
    setSystemId(String systemId)
    システムIDをセットします。
    void
    setTemplateName(String templateName)
    雛形ファイル名をセットします。
    void
    setThreadId(String threadId)
    処理要求を処理するスレッドIDをセットします。
    void
    setUseSheetName(boolean useSheetName)
    PAGEBREAKカラムの値を、シート名として使うかどうかをセットします(初期値:false)。
    void
    要求NOをセットします。

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

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • フィールド詳細

  • コンストラクタの詳細

    • 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

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

      public void setBodyTypes(String[] bodyTypes)
      ボディー部分のテキスト区分の配列をセットします。
      パラメータ:
      bodyTypes - ボディー部分のテキスト区分の配列
      変更履歴:
      8.0.3.0 (2021/12/17) 新規追加
    • getBodyTypes

      public String[] getBodyTypes()
      ボディー部分のテキスト区分の配列を取得します。
      戻り値:
      ボディー部分のテキスト区分の配列
      変更履歴:
      8.0.3.0 (2021/12/17) 新規追加
    • setHeader

      public void setHeader(DBTableModel header)
      ヘッダー部分のDBTableModelをセットします。
      パラメータ:
      header - DBTableModelオブジェクト
    • getHeader

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

      public void setFooter(DBTableModel footer)
      フッター部分のDBTableModelをセットします。
      パラメータ:
      footer - 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

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

      public void setOutputType(String outputType)
      実行方法(FGRUN)をセットします。
      パラメータ:
      outputType - 実行方法(FGRUN)
    • getOutputType

      出力タイプ:実行方法(FGRUN)を取得します。
      戻り値:
      出力タイプ:実行方法(FGRUN)
    • setPrinterName

      public void setPrinterName(String printerName)
      プリンター名をセットします。
      パラメータ:
      printerName - プリンター名
    • 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 fgrun, String yokyu)
      出力ファイル名を設定します。 GE50に設定されていない場合は第四引数(要求番号)を利用する。 その場合、タイプ:実行方法(FGRUN)に応じた拡張子が自動設定される。 ".xls" : OUT_ODS_EXCEL ".xlsx" : OUT_ODS_XLSX // 8.0.1.0 (2021/10/29) ".pdf" : OUT_ODS_PDF , OUT_ODS_PRINT_PDF ".ods" : OUT_ODS_ODS // * ".xml" : RFID_PRINT , RFID_ALLPRINT , RFID_ALLERASE , RFID_SEQERASE 7.4.4.0 (2021/06/30) Delete // * ".csv" : CSV_PRINT , CSV_PRINT_EXCEL , CSV_PRINT_PDF
      パラメータ:
      outputDir - 出力ディレクトリ名
      outputFile - 出力ファイル名 // * @param type タイプ:実行方法(FGRUN)
      fgrun - 実行方法(FGRUN)
      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対応, 7.4.4.0 (2021/06/30) openGionV8事前準備(RFID出力廃止), 8.0.1.0 (2021/10/29) CSV出力対応(ユリニタ帳票)は、一旦保留にします。, 8.0.1.0 (2021/10/29) OUT_ODS_XLSX (Excel2007形式) 評価用
    • getOutputName

      出力ファイル名を取得します。
      戻り値:
      出力先ファイル名
      変更履歴:
      5.1.2.0 (2010/01/01) 256シートを超える場合に対応。2ファイル目以降は、_1、_2・・・をファイル名の後ろにつける, 6.3.9.0 (2015/11/06) コンストラクタで初期化されていないフィールドを null チェックなしで利用している(findbugs)
      このメソッドは、nullを返しません
    • 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)
      処理したページ数を引数の分だけカウントアップします。 これは、256シート以上を印刷する場合、ファイル名に"_"を付けて 出力する機能と、GE50のSUPAGEカラムに印刷ページ数をセットするのに 使用しています。 openOfficeのシート制限は解除されていますが、SUPAGEカラムが NUMBER(3) でDB定義されているため、1000以上のページを、GE50 に セットすると、エラーになります。 DB定義を変更するまでの間、最大ページ数を、999 としておきます。
      パラメータ:
      pgs - カウントアップするページ数
      変更履歴:
      5.1.2.0 (2010/01/01) 新規追加, 7.1.0.0 (2020/01/27) 256シート制限を999にしておく。
    • 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) 新規追加
    • getTempKey

      public String getTempKey()
      テンポラリ出力のキーとなる文字列を生成して返します。 systemId + FS + listId + FS + ykno を連結します。
      戻り値:
      テンポラリ出力のキーとなる文字列
      変更履歴:
      8.0.3.0 (2021/12/17) 新規追加