com.norconex.jef4.suite

Class JobSuite

java.lang.Object

com.norconex.jef4.suite.JobSuite

public final class JobSuite
extends Object

A job suite is an amalgamation of jobs, represented as a single executable unit. It can be seen as of one big job made of several sub-jobs. Configurations applied to a suite affects all jobs associated with the suite. All jobs making up a suite must have unique identifiers.

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
JobSuite(IJob rootJob)
JobSuite(IJob rootJob, JobSuiteConfig config)

Method Summary

Modifier and Type	Method and Description
void	accept(IJobStatusVisitor visitor)
void	accept(IJobVisitor visitor) Accepts a job suite visitor.
void	accept(IJobVisitor visitor, Class<IJob> jobClassFilter) Accepts a job suite visitor, filtering jobs and job progresses to those of the same type as the specified job class instance.
boolean	execute()
boolean	execute(boolean resumeIfIncomplete)
JobSuiteConfig	getConfig()
static String	getCurrentJobId() Gets the job identifier representing the currently running job for the current thread.
String	getId()
IJobStatus	getJobStatus(IJob job)
IJobStatus	getJobStatus(String jobId)
ILogManager	getLogManager()
IJob	getRootJob()
IJobStatus	getStatus() Gets the job status for the root job.
String	getWorkdir()
boolean	runJob(IJob job)
static void	setCurrentJobId(String jobId) Sets a job identifier as the currently running job for the the current thread.
void	stop()
static void	stop(File indexFile)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobSuite

public JobSuite(IJob rootJob)

JobSuite

public JobSuite(IJob rootJob,
                JobSuiteConfig config)

Method Detail

getRootJob

public IJob getRootJob()

getConfig

public JobSuiteConfig getConfig()

getStatus

public IJobStatus getStatus()

Gets the job status for the root job. Has the same effect as invoking getJobStatus(getRootJob()).

Returns:

root job status

getJobStatus

public IJobStatus getJobStatus(IJob job)

getJobStatus

public IJobStatus getJobStatus(String jobId)

execute

public boolean execute()

execute

public boolean execute(boolean resumeIfIncomplete)

accept

public void accept(IJobStatusVisitor visitor)

accept

public void accept(IJobVisitor visitor)

Accepts a job suite visitor.

Parameters:

visitor - job suite visitor

Since:

1.1

accept

public void accept(IJobVisitor visitor,
                   Class<IJob> jobClassFilter)

Accepts a job suite visitor, filtering jobs and job progresses to those of the same type as the specified job class instance.

Parameters:

visitor - job suite visitor

jobClassFilter - type to filter jobs and job progresses

Since:

1.1

getCurrentJobId

public static String getCurrentJobId()

Gets the job identifier representing the currently running job for the current thread.

Returns:

job identifier or null if no job is currently associated with the current thread

setCurrentJobId

public static void setCurrentJobId(String jobId)

Sets a job identifier as the currently running job for the the current thread. This method is called by the framework. Framework users may call this method when implementing their own threads to associated a job with the thread. Framework code may rely on this to behave as expected. Otherwise, it is best advised not to use this method.

Parameters:

jobId - job identifier

getId

public String getId()

getWorkdir

public String getWorkdir()

getLogManager

public ILogManager getLogManager()

runJob

public boolean runJob(IJob job)

stop

public void stop()
          throws IOException

Throws:

IOException

stop

public static void stop(File indexFile)
                 throws IOException

Throws:

IOException