salto.batch.lanceur.thread
Class Traitement

java.lang.Object
  salto.batch.lanceur.thread.Traitement

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

BaseBatch

public abstract class Traitement
extends java.lang.Object
implements java.lang.Cloneable

Base class of a Batch.
Subclasses will typically implement:

• Optional : Traitement#initialize() to do some job before getting data, this method is called in Monothreaded mode
• Mandatory : Traitement#exec(Object[]) to call the business classes that do the Job on the Data, this method is called in Multi threaded mode if batch is multi threaded
• Optional : Traitement#finalizeBatch() to do some job after all data have been treated, this method is called in Monothreaded mode

Author:

Etienne Loiez, Philippe Mouawad

See Also:

BaseBatch} is the prefered Class since signature of methods is clear.

Field Summary

protected IBatchAppender

batchAppender Appender used to log executions of batch

Constructor Summary

Traitement()


Method Summary

boolean	canExec(java.lang.Object[] dataEnCours, java.lang.Object[] data) Called before execution of Traitement#exec(Object[]).
protected Traitement	childClone(Traitement clone) Clone method for Traitement.
java.lang.Object	clone() Clones the Traitement
abstract void	exec(java.lang.Object[] data) Implement this method to execute the business code on the Block of data PART OF PUBLIC API
void	execute(long numJob, java.lang.Object[] data, java.lang.String ids) Called to execute a Job
void	finalizeBatch() Called when batch has finished treating all data or has encountered an error.
BatchExecutionContext	getBatchExecutionContext() Get access to BatchExecutionContext one per execution PART OF PUBLIC API
protected java.util.Map	getBatchParameters() Deprecated. use getBatchExecutionContext()
protected java.util.Map	getBatchPhysicalsFileNames() Deprecated. use getBatchExecutionContext()
void	initialize() Called when batch is triggered.
void	postExec(long numJob, java.lang.Object[] data, java.lang.Object ids, java.lang.Throwable ex) NOT PART OF PUBLIC API Called after execution of exec
void	preExec(long numJob, java.lang.Object[] data, java.lang.Object ids) NOT PART OF PUBLIC API Called after execution on a block of data.
void	setBatchAppender(IBatchAppender batchAppenderToClone) Initialize Appender.
protected void	setReturnStatus(int codeValue, java.lang.String message) Method that call IReturnStatusSystem service qui to create the Return code and stores it in BatchExecutionContext
void	vetoExecution(java.lang.String message) Stop batch execution from initialize PART OF PUBLIC API

Methods inherited from class java.lang.Object

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

Field Detail

batchAppender

protected transient IBatchAppender batchAppender

Appender used to log executions of batch

Constructor Detail

Traitement

public Traitement()

Method Detail

execute

public final void execute(long numJob,
                          java.lang.Object[] data,
                          java.lang.String ids)
                   throws BatchException

Called to execute a Job

Parameters:

numJob - Job number

data - Object[] data

ids - String Ids

Throws:

BatchException

preExec

public void preExec(long numJob,
                    java.lang.Object[] data,
                    java.lang.Object ids)

NOT PART OF PUBLIC API Called after execution on a block of data.

Parameters:

numJob - Job Id

data - Object[]

ids - Ids of data

postExec

public void postExec(long numJob,
                     java.lang.Object[] data,
                     java.lang.Object ids,
                     java.lang.Throwable ex)

NOT PART OF PUBLIC API Called after execution of exec

Parameters:

numJob -

data -

ids -

ex -

exec

public abstract void exec(java.lang.Object[] data)
                   throws java.lang.Exception

Implement this method to execute the business code on the Block of data
PART OF PUBLIC API

Parameters:

data - Object[] Array of Data as specified by IBatchStart

Throws:

java.lang.Exception

vetoExecution

public final void vetoExecution(java.lang.String message)
                         throws VetoBatchExecutionException

Stop batch execution from initialize PART OF PUBLIC API

Parameters:

message - Explanation message, may be null

Throws:

VetoBatchExecutionException

canExec

public boolean canExec(java.lang.Object[] dataEnCours,
                       java.lang.Object[] data)

Called before execution of Traitement#exec(Object[]).
Implement if you have some business rule that forbides executing (in case of multithreaded batch) same treatment on related datas.

Parameters:

dataEnCours - Data currently treated by concurrent threads of the batch

data - New block of data

Returns:

boolean true if execution can happen(defaults to true)

clone

public final java.lang.Object clone()
                             throws java.lang.CloneNotSupportedException

Clones the Traitement


Overrides:

clone in class java.lang.Object

Returns:

Traitement

Throws:

java.lang.CloneNotSupportedException

childClone

protected Traitement childClone(Traitement clone)
                         throws java.lang.CloneNotSupportedException

Clone method for Traitement.
Default implementation throws CloneNotSupportedException NOT PART OF PUBLIC API

Parameters:

clone - Traitement to clone

Returns:

Traitement

Throws:

java.lang.CloneNotSupportedException

setBatchAppender

public final void setBatchAppender(IBatchAppender batchAppenderToClone)

Initialize Appender. To avoid concurency issues, appender is cloned.
If clone is not implemented, IBatchAppender must be thread-safe.
NOT PART OF PUBLIC API

Parameters:

batchAppenderToClone - IBatchAppender

initialize

public void initialize()
                throws java.lang.Exception

Called when batch is triggered.
. It is called in mono-threaded mode and before data has been extracted from IBatchStart.
Default implementatin is NOOP. PART OF PUBLIC API

Throws:

java.lang.Exception

finalizeBatch

public void finalizeBatch()

Called when batch has finished treating all data or has encountered an error.
. It is called in mono-threaded mode.
Default implementatin is NOOP. PART OF PUBLIC API

getBatchExecutionContext

public final BatchExecutionContext getBatchExecutionContext()

Get access to BatchExecutionContext one per execution PART OF PUBLIC API

Returns:

BatchExecutionContext Exécution context of the batch.

setReturnStatus

protected final void setReturnStatus(int codeValue,
                                     java.lang.String message)

Method that call IReturnStatusSystem service qui to create the Return code and stores it in BatchExecutionContext

Parameters:

codeValue - int Return code value

message - String Message to display for return code

getBatchParameters

protected final java.util.Map getBatchParameters()

Deprecated. use getBatchExecutionContext()

Returns:

Map : Map of parameters for the batch

See Also:

BatchExecutionContext.getBatchParameters(), getBatchExecutionContext()

getBatchPhysicalsFileNames

protected final java.util.Map getBatchPhysicalsFileNames()

Deprecated. use getBatchExecutionContext()

Return Map of logical/physical file names for batch

Returns:

Map of logical/physical file names for batch