Summer.Batch.Core.Partition.Support.PartitionStep Class Reference

Implementation of IStep which partitions the execution and spreads the load using an IPartitionHandler. More...

Inheritance diagram for Summer.Batch.Core.Partition.Support.PartitionStep:
Summer.Batch.Core.Step.AbstractStep Summer.Batch.Core.IStep Summer.Batch.Common.Factory.IInitializationPostOperations

Public Member Functions

 PartitionStep ()
 Default constructor. More...
 
 PartitionStep (string name)
 Custom constructor using a name. More...
 
override void AfterPropertiesSet ()
 Asserts that mandatory properties are set (stepExecutionSplitter, partitionHandler) and delegate to superclass. More...
 
- Public Member Functions inherited from Summer.Batch.Core.Step.AbstractStep
void Execute (StepExecution stepExecution)
 Template method for step execution logic - calls abstract methods for resource initialization ( Open), execution Logic (DoExecute) and resource closing (Close). More...
 
void RegisterStepExecutionListener (IStepExecutionListener listener)
 Registers step execution listener. More...
 
void SetStepExecutionListeners (IStepExecutionListener[] listeners)
 Registers an array of step execution listeners. More...
 
override string ToString ()
 ToString override. More...
 

Protected Member Functions

override void DoExecute (StepExecution stepExecution)
 Delegates execution to the provided IPartitionHandler. The StepExecution passed in here becomes the parent or master execution for the partition, summarising the status on exit of the logical grouping of work carried out by the PartitionHandler. The individual step executions and their input parameters (through ExecutionContext) for the partition elements are provided by the StepExecutionSplitter. More...
 
- Protected Member Functions inherited from Summer.Batch.Core.Step.AbstractStep
 AbstractStep (string name)
 Custom constructor with name. More...
 
 AbstractStep ()
 Default constructor. More...
 
virtual void Open (ExecutionContext ctx)
 Extension point for subclasses to provide callbacks to their collaborators at the beginning of a step, to open or acquire resources. Does nothing by default. More...
 
virtual void Close (ExecutionContext ctx)
 Extension point for subclasses to provide callbacks to their collaborators at the end of a step, to close or release resources. Does nothing by default. More...
 
void DoExecutionRelease ()
 Releases the most recent StepExecution More...
 
void DoExecutionRegistration (StepExecution stepExecution)
 Registers the StepExecution for property resolution via StepScope More...
 

Properties

IStepExecutionSplitter StepExecutionSplitter [protected get, set]
 Step Execution splitter property. More...
 
IPartitionHandler PartitionHandler [protected get, set]
 Partition handler property. More...
 
IStepExecutionAggregator StepExecutionAggregator [set]
 Step execution aggregator property. More...
 
- Properties inherited from Summer.Batch.Core.Step.AbstractStep
string Name [get, set]
 Name property. More...
 
bool AllowStartIfComplete [get, set]
 Allow start if complete flag property. More...
 
int StartLimit [get, set]
 Start limit for this step. More...
 
IJobRepository JobRepository [get, set]
 Job repository property. More...
 
- Properties inherited from Summer.Batch.Core.IStep
string Name [get]
 Name. More...
 
bool AllowStartIfComplete [get, set]
 Allow start if complete flag. More...
 
int StartLimit [get, set]
 Start limit. More...
 

Detailed Description

Implementation of IStep which partitions the execution and spreads the load using an IPartitionHandler.

Constructor & Destructor Documentation

Summer.Batch.Core.Partition.Support.PartitionStep.PartitionStep ( )

Default constructor.

Summer.Batch.Core.Partition.Support.PartitionStep.PartitionStep ( string  name)

Custom constructor using a name.

Parameters
name

Member Function Documentation

override void Summer.Batch.Core.Partition.Support.PartitionStep.AfterPropertiesSet ( )
virtual

Asserts that mandatory properties are set (stepExecutionSplitter, partitionHandler) and delegate to superclass.

See also
IInitializationPostOperations::AfterPropertiesSet
Exceptions
Exception 

Reimplemented from Summer.Batch.Core.Step.AbstractStep.

override void Summer.Batch.Core.Partition.Support.PartitionStep.DoExecute ( StepExecution  stepExecution)
protectedvirtual

Delegates execution to the provided IPartitionHandler. The StepExecution passed in here becomes the parent or master execution for the partition, summarising the status on exit of the logical grouping of work carried out by the PartitionHandler. The individual step executions and their input parameters (through ExecutionContext) for the partition elements are provided by the StepExecutionSplitter.

Parameters
stepExecutionthe master step execution for the partition
Exceptions
Exception 

Implements Summer.Batch.Core.Step.AbstractStep.

Property Documentation

IPartitionHandler Summer.Batch.Core.Partition.Support.PartitionStep.PartitionHandler
protected getset

Partition handler property.

IStepExecutionAggregator Summer.Batch.Core.Partition.Support.PartitionStep.StepExecutionAggregator
set

Step execution aggregator property.

IStepExecutionSplitter Summer.Batch.Core.Partition.Support.PartitionStep.StepExecutionSplitter
protected getset

Step Execution splitter property.


The documentation for this class was generated from the following file:
  • Summer.Batch.Core/Core/Partition/Support/PartitionStep.cs