de.cau.cs.kieler.kiml.grana.batch
Class BatchJob<T>

java.lang.Object
  extended by de.cau.cs.kieler.kiml.grana.batch.BatchJob<T>
Type Parameters:
T - the type of the parameter

public class BatchJob<T>
extends Object

The class which represents an analysis batch job.

Rating red

Constructor Summary
BatchJob(T param, IKGraphProvider<T> provider)
          Constructs an AnalysisBatchJob.
BatchJob(T param, KNode graph)
          The alternative constructor for an AnalysisBatchJob using a KGraph instance instead of a KGraph provider.
 
Method Summary
 BatchJobResult<T> execute(List<AbstractInfoAnalysis> analyses, IKielerProgressMonitor monitor)
          Executes the job which consists of retrieving a KGraph instance through the KGraph provider and performing the given analyses on it.
 T getParameter()
          Returns the parameter of the job.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BatchJob

public BatchJob(T param,
                IKGraphProvider<T> provider)
Constructs an AnalysisBatchJob.

Parameters:
param - the parameter
provider - the KGraph provider

BatchJob

public BatchJob(T param,
                KNode graph)
The alternative constructor for an AnalysisBatchJob using a KGraph instance instead of a KGraph provider.

Parameters:
param - the parameter
graph - the KGraph instance
Method Detail

getParameter

public T getParameter()
Returns the parameter of the job.

Returns:
the parameter

execute

public BatchJobResult<T> execute(List<AbstractInfoAnalysis> analyses,
                                 IKielerProgressMonitor monitor)
                          throws Exception
Executes the job which consists of retrieving a KGraph instance through the KGraph provider and performing the given analyses on it.

Parameters:
analyses - the analyses
monitor - the progress monitor
Returns:
the job result
Throws:
Exception - any kind of exception