Class JobStep


@Entity public class JobStep extends PersistentObject
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
  • Constructor Details

    • JobStep

      public JobStep()
  • Method Details

    • getStdoutLogLevel

      public JobStep.StdLogLevel getStdoutLogLevel()
      Returns:
      the stdoutLogLevel
    • getStderrLogLevel

      public JobStep.StdLogLevel getStderrLogLevel()
      Returns:
      the stderrLogLevel
    • setStdoutLogLevel

      public void setStdoutLogLevel(JobStep.StdLogLevel stdoutLogLevel)
      Parameters:
      stdoutLogLevel - the stdoutLogLevel to set
    • setStderrLogLevel

      public void setStderrLogLevel(JobStep.StdLogLevel stderrLogLevel)
      Parameters:
      stderrLogLevel - the stderrLogLevel to set
    • getIsFailed

      public Boolean getIsFailed()
      Returns:
      the isFailed
    • isFailed

      public Boolean isFailed()
      Returns:
      the isFailed
    • setIsFailed

      public void setIsFailed(Boolean isFailed)
      Parameters:
      isFailed - the isFailed to set
    • getJob

      public Job getJob()
      Gets the enclosing job
      Returns:
      the job
    • setJob

      public void setJob(Job job)
      Sets the enclosing job
      Parameters:
      job - the job to set
    • getJobStepState

      public JobStep.JobStepState 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

      public Integer getPriority()
      Gets the processing priority
      Returns:
      the priority
    • setPriority

      public void setPriority(Integer priority)
      Sets the processing priority
      Parameters:
      priority - the priority to set
    • getOutputParameters

      public Map<String,Parameter> getOutputParameters()
      Gets the output parameters
      Returns:
      the outputParameters
    • setOutputParameters

      public void setOutputParameters(Map<String,Parameter> outputParameters)
      Sets the output parameters
      Parameters:
      outputParameters - the outputParameters to set
    • getProcessingMode

      public String getProcessingMode()
      Gets the processing mode to run the processor in
      Returns:
      the processingMode
    • setProcessingMode

      public void setProcessingMode(String processingMode)
      Sets the processing mode to run the processor in
      Parameters:
      processingMode - the processingMode to set
    • getInputProductQueries

      public Set<ProductQuery> getInputProductQueries()
      Gets the product queries for the input products
      Returns:
      the inputProductQueries
    • setInputProductQueries

      public void setInputProductQueries(Set<ProductQuery> inputProductQueries)
      Sets the product queries for the input products
      Parameters:
      inputProductQueries - the inputProductQueries to set
    • getOutputProduct

      public Product getOutputProduct()
      Gets the output product
      Returns:
      the outputProduct
    • setOutputProduct

      public void setOutputProduct(Product outputProduct)
      Sets the output product
      Parameters:
      outputProduct - the outputProduct to set
    • getProcessingStartTime

      public Instant getProcessingStartTime()
      Gets the start time of the processing job
      Returns:
      the processing start time
    • setProcessingStartTime

      public void setProcessingStartTime(Instant processingStartTime)
      Sets the start time of the processing job
      Parameters:
      processingStartTime - the processing start time to set
    • getProcessingCompletionTime

      public Instant getProcessingCompletionTime()
      Gets the completion time of the processing job
      Returns:
      the processing completion time
    • setProcessingCompletionTime

      public void setProcessingCompletionTime(Instant processingCompletionTime)
      Sets the completion time of the processing job
      Parameters:
      processingCompletionTime - the processing completion time to set
    • getProcessingStdOut

      public String getProcessingStdOut()
      Gets the standard output of the processing job
      Returns:
      the processing standard output
    • setProcessingStdOut

      public void setProcessingStdOut(String processingStdOut)
      Sets the standard output of the processing job
      Parameters:
      processingStdOut - the processing standard output to set
    • getProcessingStdErr

      public String getProcessingStdErr()
      Gets the standard error output of the processing job
      Returns:
      the processing standard error output
    • setProcessingStdErr

      public void setProcessingStdErr(String processingStdErr)
      Sets the standard error output of the processing job
      Parameters:
      processingStdErr - the processing standard error output to set
    • getJobOrderFilename

      public String getJobOrderFilename()
      Gets the Job Order filename
      Returns:
      the Job Order filename
    • setJobOrderFilename

      public void setJobOrderFilename(String jobOrderFilename)
      Sets the Job Order filename
      Parameters:
      jobOrderFilename - the Job Order filename to set
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class PersistentObject
    • equals

      public boolean equals(Object obj)
      Description copied from class: PersistentObject
      Test equality of persistent objects based on their unique ID.
      Overrides:
      equals in class PersistentObject
      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

      public String toString()
      Overrides:
      toString in class Object