Package de.dlr.proseo.model
Class JobStep
java.lang.Object
de.dlr.proseo.model.PersistentObject
de.dlr.proseo.model.JobStep
A single processor execution to produce a defined output product based on a defined set of required input product
(modelled as ProductQuery objects). A JobStep can be executed as soon as all its ProductQuerys are satisfied.
- Author:
- Dr. Thomas Bassler
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThe possible processing states for a job stepstatic enumThe possible log levels for stdout and stderr -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanTest equality of persistent objects based on their unique ID.Gets the product queries for the input productsgetJob()Gets the enclosing jobGets the Job Order filenameGets the state of the job stepGets the output parametersGets the output productGets the processing priorityGets the completion time of the processing jobGets the processing mode to run the processor inGets the start time of the processing jobGets the standard error output of the processing jobGets the standard output of the processing jobinthashCode()isFailed()voidsetInputProductQueries(Set<ProductQuery> inputProductQueries) Sets the product queries for the input productsvoidsetIsFailed(Boolean isFailed) voidSets the enclosing jobvoidsetJobOrderFilename(String jobOrderFilename) Sets the Job Order filenamevoidsetJobStepState(JobStep.JobStepState jobStepState) Sets the state of the job step (and optionally its failure flag) and propagates this state to the jobvoidsetOutputParameters(Map<String, Parameter> outputParameters) Sets the output parametersvoidsetOutputProduct(Product outputProduct) Sets the output productvoidsetPriority(Integer priority) Sets the processing priorityvoidsetProcessingCompletionTime(Instant processingCompletionTime) Sets the completion time of the processing jobvoidsetProcessingMode(String processingMode) Sets the processing mode to run the processor invoidsetProcessingStartTime(Instant processingStartTime) Sets the start time of the processing jobvoidsetProcessingStdErr(String processingStdErr) Sets the standard error output of the processing jobvoidsetProcessingStdOut(String processingStdOut) Sets the standard output of the processing jobvoidsetStderrLogLevel(JobStep.StdLogLevel stderrLogLevel) voidsetStdoutLogLevel(JobStep.StdLogLevel stdoutLogLevel) toString()Methods inherited from class de.dlr.proseo.model.PersistentObject
getId, getVersion, incrementVersion, setId
-
Constructor Details
-
JobStep
public JobStep()
-
-
Method Details
-
getStdoutLogLevel
- Returns:
- the stdoutLogLevel
-
getStderrLogLevel
- Returns:
- the stderrLogLevel
-
setStdoutLogLevel
- Parameters:
stdoutLogLevel- the stdoutLogLevel to set
-
setStderrLogLevel
- Parameters:
stderrLogLevel- the stderrLogLevel to set
-
getIsFailed
- Returns:
- the isFailed
-
isFailed
- Returns:
- the isFailed
-
setIsFailed
- Parameters:
isFailed- the isFailed to set
-
getJob
Gets the enclosing job- Returns:
- the job
-
setJob
Sets the enclosing job- Parameters:
job- the job to set
-
getJobStepState
Gets the state of the job step- Returns:
- the jobStepState
-
setJobStepState
@Transactional public void setJobStepState(JobStep.JobStepState jobStepState) throws IllegalStateException Sets the state of the job step (and optionally its failure flag) and propagates this state to the job- Parameters:
jobStepState- the jobStepState to set- Throws:
IllegalStateException- if the intended job step state transition is illegal
-
getPriority
Gets the processing priority- Returns:
- the priority
-
setPriority
Sets the processing priority- Parameters:
priority- the priority to set
-
getOutputParameters
Gets the output parameters- Returns:
- the outputParameters
-
setOutputParameters
Sets the output parameters- Parameters:
outputParameters- the outputParameters to set
-
getProcessingMode
Gets the processing mode to run the processor in- Returns:
- the processingMode
-
setProcessingMode
Sets the processing mode to run the processor in- Parameters:
processingMode- the processingMode to set
-
getInputProductQueries
Gets the product queries for the input products- Returns:
- the inputProductQueries
-
setInputProductQueries
Sets the product queries for the input products- Parameters:
inputProductQueries- the inputProductQueries to set
-
getOutputProduct
Gets the output product- Returns:
- the outputProduct
-
setOutputProduct
Sets the output product- Parameters:
outputProduct- the outputProduct to set
-
getProcessingStartTime
Gets the start time of the processing job- Returns:
- the processing start time
-
setProcessingStartTime
Sets the start time of the processing job- Parameters:
processingStartTime- the processing start time to set
-
getProcessingCompletionTime
Gets the completion time of the processing job- Returns:
- the processing completion time
-
setProcessingCompletionTime
Sets the completion time of the processing job- Parameters:
processingCompletionTime- the processing completion time to set
-
getProcessingStdOut
Gets the standard output of the processing job- Returns:
- the processing standard output
-
setProcessingStdOut
Sets the standard output of the processing job- Parameters:
processingStdOut- the processing standard output to set
-
getProcessingStdErr
Gets the standard error output of the processing job- Returns:
- the processing standard error output
-
setProcessingStdErr
Sets the standard error output of the processing job- Parameters:
processingStdErr- the processing standard error output to set
-
getJobOrderFilename
Gets the Job Order filename- Returns:
- the Job Order filename
-
setJobOrderFilename
Sets the Job Order filename- Parameters:
jobOrderFilename- the Job Order filename to set
-
hashCode
public int hashCode()- Overrides:
hashCodein classPersistentObject
-
equals
Description copied from class:PersistentObjectTest equality of persistent objects based on their unique ID.- Overrides:
equalsin classPersistentObject- Parameters:
obj- the object to compare this object to- Returns:
- true, if obj is a persistent object and has the same ID, false otherwise
- See Also:
-
toString
-