public abstract class AbstractReportExportJob extends AbstractGenericExportJob
ReportBuilder用のエクスポートジョブ抽象クラスです。
エクスポートジョブに指定可能なパラメータについて
AbstractGenericImportJob
で指定可能なパラメータに加え、次のパラメータを指定可能です。
AbstractGenericJob で指定可能なパラメータ | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
キー | 値 | 設定 | 省略時 | ||||||||
error_skip | 会社別処理エラー時の後続処理スキップ | 任意 | スキップしない(false) | ||||||||
lock_wait | ロック待ち時間 | 任意 | 10(秒) | ||||||||
company_group_set_cd | 会社グループセットコード | 任意 | 会社グループの絞り込みを行わない | ||||||||
company_group_cd | 会社グループコード | 任意 | 会社グループの絞り込みを行わない | ||||||||
company_cd | 会社コード(カンマ区切りで複数指定可) | 任意 | 会社の絞り込みを行わない | ||||||||
conductor | ジョブの各処理間で実行されるコンダクター(カンマ区切りで複数指定可)AbstractGenericJobConductor を継承したクラスのコンポーネント名を指定してください。 |
任意 | コンダクターを使用しない | ||||||||
AbstractGenericExportJob で指定可能なパラメータ | |||||||||||
export_mode | エクスポートモード
| 任意 | 1 | ||||||||
target_date | エクスポート対象データの検索対象日 (エクスポートモード2,3で使用します。) | 任意 | ジョブの実行日 | ||||||||
shift_date | エクスポート対象データの検索対象日に対する増減日数 (エクスポートモード2,3で使用します。) | 任意 | 0 (日) | ||||||||
file_path | エクスポートファイルのパス | 任意 | kaiden/generic/report/{レポートID}/export.csv | ||||||||
file_mode | エクスポート時の既存ファイル操作モード
| 任意 | 1 | ||||||||
archive_path | エクスポートファイルのアーカイブ先パス | 任意 | kaiden/generic/report/{レポートID}/export_{YMDHMSN}.csv | ||||||||
character | エクスポートファイルの文字コード UTF-8 SHIFT-JIS | 任意 | UTF-8 | ||||||||
delimiter | エクスポートファイルの区切り文字 , (カンマ) \\t (タブ) | 任意 | , (カンマ) | ||||||||
enclosing | エクスポートファイルの囲み文字 none (なし) " (ダブルクォーテーション) | 任意 | " (ダブルクォーテーション) | ||||||||
header_row | エクスポートファイルのヘッダー出力有無 | 任意 | false (出力しない) | ||||||||
無効(設定した場合でも無視されます。) | |||||||||||
無効(設定した場合でも無視されます。) | |||||||||||
本クラス(AbstractReportExportJob )で追加指定可能なパラメータ | |||||||||||
キー | 値 | 設定 | 省略時 | ||||||||
reportId | レポートID | 必須 | - | ||||||||
queryId | (パブリック)クエリーID | 必須 | - |
AbstractGenericExportJob.ExportFileMode, AbstractGenericExportJob.ExportMode
AbstractGenericJob.FileProcessType, AbstractGenericJob.IllegalJobParametersException, AbstractGenericJob.ProcessFile
修飾子とタイプ | フィールドと説明 |
---|---|
static String |
JOBPARAM_QUERY_ID
ジョブパラメータキー:(パブリック)クエリーID(queryId).
|
static String |
JOBPARAM_REPORT_ID
ジョブパラメータキー:レポートID(reportId).
|
protected XmlSettingsHelper |
xmlSettingsHelper
XmlSettingsHelper.
|
JOBPARAM_ARCHIVE_PATH, JOBPARAM_CHARACTER, JOBPARAM_COLUMNS, JOBPARAM_DELIMITER, JOBPARAM_ENCLOSING, JOBPARAM_EXPORT_MODE, JOBPARAM_FILE_MODE, JOBPARAM_FILE_PATH, JOBPARAM_HEADER_ROW, JOBPARAM_SHIFT_DATE, JOBPARAM_SORT_COLUMNS, JOBPARAM_TARGET_DATE
contextHelper, dateHelper, dateValidator, formatHelper, identifierHelper, JOBPARAM_COMPANY_CD, JOBPARAM_COMPANY_GROUP_CD, JOBPARAM_COMPANY_GROUP_SET_CD, JOBPARAM_CONDUCTOR, JOBPARAM_ERROR_SKIP, JOBPARAM_JOB_ID, JOBPARAM_JOB_NAME, JOBPARAM_JOB_NET_ID, JOBPARAM_JOB_NET_NAME, JOBPARAM_LOCK_WAIT, JOBPARAM_MONITOR_ID, JOBPARAM_OUTPUT_LOG, JOBPARAM_PROCESS_COMPANY, JOBPARAM_PROCESS_DATE, JOBPARAM_TASK_ID, JOBPARAM_TENANT_ID, jobResultList, localeValidator, parameters, processCompany, processDate, processFiles, propertyHelper, result, systemLocaleHelper, transactionHelper, xmlOutputHelper
コンストラクタと説明 |
---|
AbstractReportExportJob()
コンストラクタ.
|
AbstractReportExportJob(Map<String,String> parameters)
コンストラクタ.
|
修飾子とタイプ | メソッドと説明 |
---|---|
protected Map<String,String> |
convertExportData(Map<String,Object> data)
データコンバート.
|
protected void |
exportData(jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.report_builder_settings.ReportBuilderSettings settings,
List<Map<String,Object>> mapList,
Map<String,Object> criteria)
エクスポートデータの出力.
|
protected boolean |
exportModeCheck(AbstractGenericExportJob.ExportMode mode)
エクスポートモード利用可否判定.
|
protected String |
getArchiveFilePath()
アーカイブ先のパスを返却.
|
protected String |
getCharacter()
エクスポートファイルの文字コードを返却.
|
protected List<String> |
getColumnList()
カラムリストを返却.
|
protected String |
getDelimiter()
エクスポートファイルの区切り文字を返却.
|
protected String |
getEnclosing()
エクスポートファイルの囲み文字を返却.
|
protected String |
getExportFilePath()
エクスポートファイルのパスを返却.
|
protected Map<String,String> |
getHeaderColumn(List<String> columnList)
ヘッダーカラムを返却.
|
protected com.miragesql.miragesql.IterationCallback<Map,Void> |
getIterationCallback(String filePath,
List<String> columnList,
String character)
IterationCallbackを返却.
|
protected String |
getLockKey()
ロックキーを返却.
|
protected String |
getOrder()
ソート条件を返却.
|
protected Map<String,String> |
getParameters()
パラメータを返却.
|
protected Map<String,Object> |
getSearchCriteria(AbstractGenericExportJob.ExportMode mode)
検索条件を返却.
|
protected jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.report_builder_settings.ReportBuilderSettings |
getSettings()
ReportBuilder定義を返却.
|
protected boolean |
isHeaderRow()
エクスポートファイルのヘッダー出力有無を返却.
|
protected void |
processExport(Map<String,Object> criteria,
com.miragesql.miragesql.IterationCallback<Map,Void> callback)
エクスポートデータの出力処理.
|
protected String |
replace(String target)
文字列変換.
|
protected void |
validateParameters()
パラメータバリデート.
|
changeCharToString, exportData, getExportMode, getFileMode, getProcessType, getTargetDate, postProcessExport, preProcessExport, process
addArchiveFile, addDeleteFile, addReadFile, addWriteFile, execute, getCompanyCdList, getConductor, getEndMessage, getJobResult, getLockWait, getMessage, getParameter, getStartMessage, getSurface, initializeJobResult, isCompanyProcess, isOutputLog, outputJobProcessResult, postExecute, postProcess, preExecute, preProcess, run
public static final String JOBPARAM_REPORT_ID
public static final String JOBPARAM_QUERY_ID
protected XmlSettingsHelper xmlSettingsHelper
protected void validateParameters() throws jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException
ジョブパラメータなどで必須の場合は本メソッドでバリデートを実施してください。
本メソッドでバリデートエラーとなった内容はジョブネットモニターに表示され、ログファイルに出力されません。
validateParameters
クラス内 AbstractGenericJob
jp.co.intra_mart.foundation.job_scheduler.exception.JobExecuteException
- JobExecuteException
protected boolean exportModeCheck(AbstractGenericExportJob.ExportMode mode)
exportModeCheck
クラス内 AbstractGenericExportJob
mode
- エクスポートモードprotected List<String> getColumnList() throws KaidenSystemException, KaidenApplicationException
getColumnList
クラス内 AbstractGenericExportJob
KaidenSystemException
- KaidenSystemException
KaidenApplicationException
- KaidenApplicationException
protected Map<String,String> getHeaderColumn(List<String> columnList) throws KaidenSystemException, KaidenApplicationException
getHeaderColumn
クラス内 AbstractGenericExportJob
columnList
- カラムリストKaidenSystemException
- KaidenSystemException
KaidenApplicationException
- KaidenApplicationException
protected Map<String,Object> getSearchCriteria(AbstractGenericExportJob.ExportMode mode) throws KaidenSystemException, KaidenApplicationException
getSearchCriteria
クラス内 AbstractGenericExportJob
mode
- エクスポートモードKaidenSystemException
- KaidenSystemException
KaidenApplicationException
- KaidenApplicationException
protected String getOrder() throws KaidenSystemException, KaidenApplicationException
getOrder
クラス内 AbstractGenericExportJob
KaidenSystemException
- KaidenSystemException
KaidenApplicationException
- KaidenApplicationException
protected void processExport(Map<String,Object> criteria, com.miragesql.miragesql.IterationCallback<Map,Void> callback) throws KaidenSystemException, KaidenApplicationException
processExport
クラス内 AbstractGenericExportJob
criteria
- 抽出条件callback
- IterationCallback
KaidenSystemException
- KaidenSystemException
KaidenApplicationException
- KaidenApplicationException
protected void exportData(jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.report_builder_settings.ReportBuilderSettings settings, List<Map<String,Object>> mapList, Map<String,Object> criteria) throws KaidenSystemException, KaidenApplicationException
settings
- GenericMasterSettings
mapList
- エクスポートデータcriteria
- 検索条件KaidenSystemException
- KaidenSystemException
KaidenApplicationException
- KaidenApplicationException
protected com.miragesql.miragesql.IterationCallback<Map,Void> getIterationCallback(String filePath, List<String> columnList, String character) throws KaidenSystemException, KaidenApplicationException
getIterationCallback
クラス内 AbstractGenericExportJob
filePath
- エクスポートファイルパスcolumnList
- カラムリストcharacter
- 文字コードIterationCallback
KaidenSystemException
- KaidenSystemException
KaidenApplicationException
- KaidenApplicationException
protected Map<String,String> convertExportData(Map<String,Object> data) throws KaidenSystemException, KaidenApplicationException
convertExportData
クラス内 AbstractGenericExportJob
data
- エクスポートデータKaidenSystemException
- KaidenSystemException
KaidenApplicationException
- KaidenApplicationException
protected jp.co.slcs.kaiden.v2.base.foundation.model.xml_schema.report_builder_settings.ReportBuilderSettings getSettings() throws KaidenSystemException, KaidenApplicationException
ReportBuilderSettings
KaidenSystemException
- KaidenSystemException
KaidenApplicationException
- KaidenApplicationException
protected String getLockKey()
getLockKey
クラス内 AbstractGenericJob
protected String getCharacter()
getCharacter
クラス内 AbstractGenericExportJob
protected String getDelimiter()
getDelimiter
クラス内 AbstractGenericExportJob
protected String getEnclosing()
getEnclosing
クラス内 AbstractGenericExportJob
protected boolean isHeaderRow()
isHeaderRow
クラス内 AbstractGenericExportJob
protected String getExportFilePath()
getExportFilePath
クラス内 AbstractGenericExportJob
protected String getArchiveFilePath()
getArchiveFilePath
クラス内 AbstractGenericExportJob
protected Map<String,String> getParameters()
getParameters
クラス内 AbstractGenericJob
protected String replace(String target)
次の文字列を変換します。
変換対象 | 変換内容 | 補足 |
---|---|---|
{COMPANY_CD} | 会社コード | 会社別処理ではない場合は変換しません。 |
{YMD} | ジョブの実行日 | 「yyyyMMdd」形式 |
{YMDHMSN} | ジョブの実行日 | 「yyyyMMddHHmmssSSS」形式 |
{JOB_NET_ID} | ジョブネットID | ジョブネットIDが設定されていない場合は変換しません。 |
{JOB_NET_NAME} | ジョブネット名 | ジョブネット名が設定されていない場合は変換しません。 |
{JOB_ID} | ジョブID | ジョブIDが設定されていない場合は変換しません。 |
{JOB_NAME} | ジョブ名 | ジョブ名が設定されていない場合は変換しません。 |
{REPORT_ID} | レポートID | |
{QUERY_ID} | (パブリック)クエリーID |
replace
クラス内 AbstractGenericJob
target
- 変換対象の文字列Copyright © 2024 Sumitomo Life Information Systems Co., Ltd. All Rights Reserved.