com.norconex.jef4.job.group

Class AbstractJobGroup

java.lang.Object

com.norconex.jef4.job.group.AbstractJobGroup

All Implemented Interfaces:

IJobGroup, IJob

Direct Known Subclasses:

AsyncJobGroup, SyncJobGroup

public abstract class AbstractJobGroup
extends Object
implements IJobGroup

Base implementation for job groups. The group progress is an average of all job progress it contains.

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
AbstractJobGroup(String id, IJob... jobs) Constructor.

Method Summary

Modifier and Type	Method and Description
void	execute(JobStatusUpdater statusUpdater, JobSuite suite) Executes this job.
abstract void	executeGroup(JobSuite suite)
String	getId() Gets the job unique identifier.
IJob[]	getJobs() Gets all jobs part of this group.
void	groupProgressed(IJobStatus childJobStatus)
void	stop(IJobStatus status, JobSuite suite) Stops this job.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJobGroup

public AbstractJobGroup(String id,
                        IJob... jobs)

Constructor.

Parameters:

id - job unique identifier

jobs - jobs to be run by the group

Method Detail

getJobs

public final IJob[] getJobs()

Description copied from interface: IJobGroup

Gets all jobs part of this group.

Specified by:

getJobs in interface IJobGroup

Returns:

jobs in the group

getId

public final String getId()

Description copied from interface: IJob

Gets the job unique identifier. All characters are valid and regular words can be used, as long as the returned string is unique.

Specified by:

getId in interface IJob

Returns:

job unique identifier

execute

public void execute(JobStatusUpdater statusUpdater,
                    JobSuite suite)

Description copied from interface: IJob

Executes this job. Implementors are responsible for updating execution progress on the given JobProgress.

Specified by:

execute in interface IJob

Parameters:

statusUpdater - status updater

suite - job suite this job is part of

executeGroup

public abstract void executeGroup(JobSuite suite)

groupProgressed

public void groupProgressed(IJobStatus childJobStatus)

Specified by:

groupProgressed in interface IJobGroup

stop

public void stop(IJobStatus status,
                 JobSuite suite)

Description copied from interface: IJob

Stops this job. Implementors are responsible for terminating the execution of this job. The progress and other contextual information can be set, but the "status" should not be overwritten, as the framework will take care of assigning it.

Specified by:

stop in interface IJob

Parameters:

status - current job status

suite - job suite this job is part of