クラス StepExecution
java.lang.ObjectSE
org.springframework.batch.core.Entity
org.springframework.batch.core.StepExecution
- 実装されたすべてのインターフェース:
SerializableSE
ステップを実行するためのバッチドメインオブジェクト表現。
JobExecution
とは異なり、追加のプロパティは、コミット数などのアイテムの処理に関連しています。- 作成者:
- Lucas Ward, Dave Syer, Mahmoud Ben Hassine, Taeik Lim
- 関連事項:
コンストラクターのサマリー
コンストラクター説明StepExecution
(StringSE stepName, JobExecution jobExecution) 実行 ID に null を代入するコンストラクター。StepExecution
(StringSE stepName, JobExecution jobExecution, LongSE id) 必須プロパティを持つコンストラクター。メソッドのサマリー
修飾子と型メソッド説明void
addFailureException
(ThrowableSE throwable) 障害例外にThrowable
SE を追加します。void
apply
(StepContribution contribution) このメソッドは、実行が成功したときに、チャンクコミットの直前に呼び出す必要があります。StepContribution
のファクトリメソッド。boolean
両方が存在する場合は、id
に基づいて ID を確立しようとします。long
この実行の現在のコミット数を返します。この実行が作成された時刻を取得しますこの実行が終了した時刻、またはステップが実行中の場合はnull
を返します。この実行のExecutionContext
を返します。long
この実行から除外されたアイテムの現在の数を返します。エンクロージングジョブの実行コンテキスト情報のアクセサー。ジョブ実行 ID のアクセサー。現在のジョブパラメーターを取得するための簡易メソッド。long
long
この実行のために読み取られたアイテムの現在の数を返します。long
long
この実行の現在のロールバック数を返します。long
この実行が開始された時刻を取得します。このステップの現在のステータスを返します。long
この実行のために書き込まれたアイテムの現在の数を返します。long
int
hashCode()
存在する場合はid
を使用して、ハッシュコードを確立します。void
コミット数を増やします。void
ロールバックカウントを増やします。boolean
void
setCommitCount
(long commitCount) この実行の現在のコミット数を設定します。void
setCreateTime
(LocalDateTimeSE createTime) この実行が作成された時刻を設定しますvoid
setEndTime
(LocalDateTimeSE endTime) この実行が終了した時刻を設定します。void
setExecutionContext
(ExecutionContext executionContext) この実行のExecutionContext
を設定します。void
setExitStatus
(ExitStatus exitStatus) void
setFilterCount
(long filterCount) この実行から除外されるアイテムの数を設定します。void
setLastUpdated
(LocalDateTimeSE lastUpdated) 永続化する前にStepExecution
が最後に更新された時刻を設定します。void
setProcessSkipCount
(long processSkipCount) 処理中にスキップされるレコードの数を設定します。void
setReadCount
(long readCount) この実行の現在の読み取り項目数を設定します。void
setReadSkipCount
(long readSkipCount) 読み取り時にスキップされるレコード数を設定します。void
setRollbackCount
(long rollbackCount) この実行のロールバック数を設定します。void
setStartTime
(LocalDateTimeSE startTime) この実行が開始された時刻を設定します。void
setStatus
(BatchStatus status) このステップの現在のステータスを設定します。void
この実行 (およびその周囲のジョブ) が終了しようとしていることを実行環境に通知するフラグを設定します。void
setWriteCount
(long writeCount) この実行のために書き込まれたアイテムの現在の数を設定します。void
setWriteSkipCount
(long writeSkipCount) 書き込み時にスキップされるレコード数を設定します。toString()
id
、version
、クラス名を含むEntity
の文字列表現を作成します。void
upgradeStatus
(BatchStatus status) 指定された値が既存の値より大きい場合、ステータスフィールドをアップグレードします。クラス org.springframework.batch.core.Entity から継承されたメソッド
getId, getVersion, incrementVersion, setId, setVersion
コンストラクターの詳細
StepExecution
必須プロパティを持つコンストラクター。- パラメーター:
stepName
- この実行が属するステップ。jobExecution
- 現在のジョブ実行。id
- この実行の ID。
StepExecution
実行 ID に null を代入するコンストラクター。- パラメーター:
stepName
- この実行が属するステップ。jobExecution
- 現在のジョブ実行。
メソッドの詳細
getExecutionContext
この実行のExecutionContext
を返します。- 戻り値:
- 属性。
setExecutionContext
この実行のExecutionContext
を設定します。- パラメーター:
executionContext
- 属性。
getCommitCount
public long getCommitCount()この実行の現在のコミット数を返します。- 戻り値:
- 現在のコミット数。
setCommitCount
public void setCommitCount(long commitCount) この実行の現在のコミット数を設定します。- パラメーター:
commitCount
- 現在のコミット数。
getEndTime
この実行が終了した時刻、またはステップが実行中の場合はnull
を返します。- 戻り値:
- この実行が終了した時刻、またはステップが実行中の場合は
null
。
setEndTime
この実行が終了した時刻を設定します。- パラメーター:
endTime
- この実行が終了した時刻。
getReadCount
public long getReadCount()この実行のために読み取られたアイテムの現在の数を返します。- 戻り値:
- この実行のために読み取られたアイテムの現在の数。
setReadCount
public void setReadCount(long readCount) この実行の現在の読み取り項目数を設定します。- パラメーター:
readCount
- この実行の読み取り項目の現在の数。
getWriteCount
public long getWriteCount()この実行のために書き込まれたアイテムの現在の数を返します。- 戻り値:
- この実行のために書き込まれたアイテムの現在の数。
setWriteCount
public void setWriteCount(long writeCount) この実行のために書き込まれたアイテムの現在の数を設定します。- パラメーター:
writeCount
- この実行で書き込まれたアイテムの現在の数。
getRollbackCount
public long getRollbackCount()この実行の現在のロールバック数を返します。- 戻り値:
- この実行の現在のロールバック数。
getFilterCount
public long getFilterCount()この実行から除外されたアイテムの現在の数を返します。- 戻り値:
- この実行から除外されたアイテムの現在の数。
setFilterCount
public void setFilterCount(long filterCount) この実行から除外されるアイテムの数を設定します。- パラメーター:
filterCount
- この実行から除外されて設定されるアイテムの数。
setRollbackCount
public void setRollbackCount(long rollbackCount) この実行のロールバック数を設定します。- パラメーター:
rollbackCount
-long
ロールバックの数。
getCreateTime
この実行が作成された時刻を取得します- 戻り値:
- この実行が作成された時刻。
setCreateTime
この実行が作成された時刻を設定します- パラメーター:
createTime
- この実行の作成時間。
getStartTime
この実行が開始された時刻を取得します。- 戻り値:
- この実行が開始された時刻。
setStartTime
この実行が開始された時刻を設定します。- パラメーター:
startTime
- この実行が開始された時刻。
getStatus
このステップの現在のステータスを返します。- 戻り値:
- このステップの現在のステータス。
setStatus
このステップの現在のステータスを設定します。- パラメーター:
status
- このステップの現在のステータス。
upgradeStatus
指定された値が既存の値より大きい場合は、ステータスフィールドをアップグレードします。このメソッドを使用してステータスを設定するクライアントは、失敗したステータスを成功したステータスで上書きしないことを確認できます。- パラメーター:
status
- 新しいステータス値
getStepName
- 戻り値:
- ステップの名前。
getJobExecutionId
ジョブ実行 ID のアクセサー。- 戻り値:
jobExecutionId
setExitStatus
- パラメーター:
exitStatus
- 終了ステータスを確立するために使用されるExitStatus
インスタンス。
getExitStatus
- 戻り値:
ExitStatus
getJobExecution
エンクロージングジョブの実行コンテキスト情報のアクセサー。- 戻り値:
- このステップの実行を開始するために使用された
JobExecution
。
createStepContribution
StepContribution
のファクトリメソッド。- 戻り値:
- 新しい
StepContribution
apply
このメソッドは、実行が成功したときに、チャンクコミットの直前に呼び出す必要があります。変更がアトミックになるように、StepExecution
へのアクセスを同期します。- パラメーター:
contribution
-StepExecution
状態の更新に使用されるStepContribution
インスタンス。
incrementRollbackCount
public void incrementRollbackCount()ロールバックカウントを増やします。チャンクがロールバックされた後に実行が失敗した場合に使用する必要があります。isTerminateOnly
public boolean isTerminateOnly()- 戻り値:
- 実行を停止する必要があることを示すフラグ。
setTerminateOnly
public void setTerminateOnly()この実行 (およびその周囲のジョブ) が終了しようとしていることを実行環境に通知するフラグを設定します。getSkipCount
public long getSkipCount()- 戻り値:
- スキップされたアイテムの総数。
incrementCommitCount
public void incrementCommitCount()コミット数を増やします。getJobParameters
現在のジョブパラメーターを取得するための簡易メソッド。- 戻り値:
- 含まれているジョブからの
JobParameters
、またはそれがnull
の場合は空。
getReadSkipCount
public long getReadSkipCount()- 戻り値:
- 読み取り時にスキップされたレコードの数。
getWriteSkipCount
public long getWriteSkipCount()- 戻り値:
- 書き込み時にスキップされたレコードの数。
setReadSkipCount
public void setReadSkipCount(long readSkipCount) 読み取り時にスキップされるレコード数を設定します。- パラメーター:
readSkipCount
- ステップの実行に使用される読み取りスキップカウントを含むlong
。
setWriteSkipCount
public void setWriteSkipCount(long writeSkipCount) 書き込み時にスキップされるレコード数を設定します。- パラメーター:
writeSkipCount
- ステップの実行に使用される書き込みスキップカウントを含むlong
。
getProcessSkipCount
public long getProcessSkipCount()- 戻り値:
- 処理中にスキップされたレコードの数
setProcessSkipCount
public void setProcessSkipCount(long processSkipCount) 処理中にスキップされるレコードの数を設定します。- パラメーター:
processSkipCount
- ステップの実行に使用されるプロセススキップカウントを含むlong
。
getLastUpdated
- 戻り値:
- この実行が最後に保持された日付を表す日付。
setLastUpdated
永続化する前にStepExecution
が最後に更新された時刻を設定します。- パラメーター:
lastUpdated
-StepExecution
の最終更新日を確立するために使用されるLocalDateTime
SE インスタンス。
getFailureExceptions
- 戻り値:
Throwable
SE オブジェクトのList
SE。
addFailureException
障害例外にThrowable
SE を追加します。- パラメーター:
throwable
- 失敗の例外に追加するThrowable
SE。
equals
クラスからコピーされた説明:Entity
両方が存在する場合は、id
に基づいて ID を確立しようとします。どちらのid
も存在しない場合は、Object.equals()
を使用します。hashCode
public int hashCode()クラスからコピーされた説明:Entity
存在する場合はid
を使用して、ハッシュコードを確立します。それ以外の場合はObject.hashCode()
にフォールバックします。equals
と同じ情報に基づいているため、変更された場合は変更されます。これはObject.hashCode()
の契約に従いますが、保存されていないEntity
をSet
に追加すると、Set.contains()
は保存後にEntity
に対してほぼ確実に false を返すため、問題が発生することに注意してください。当然のことながら、Spring Batch はそのエンティティをセットに格納しないため、これは内部的に一貫しています。クライアントは、保存されていないエンティティに公開されるべきではありません。toString
クラスからコピーされた説明:Entity
id
、version
、クラス名を含むEntity
の文字列表現を作成します。getSummary
- 戻り値:
- ステップ実行の要約を含む
String
SE。