Package de.dlr.proseo.model.joborder

Class JobOrder

java.lang.Object
de.dlr.proseo.model.joborder.JobOrder
public class JobOrder extends Object
Ipf_Job_Order information For details see Generic IPF Interface Specification issue 1 revision 8 - 03/08/2009 MMFI-GSEG-EOPG-TN-07-0003
Author:
Ernst Melchinger

  • Constructor Details

    • JobOrder

      public JobOrder(Conf conf)
      Constructor with Ipf_Conf argument
      Parameters:
      conf - the Job Order configuration to set

    • JobOrder

      public JobOrder()
      No-argument constructor

  • Method Details

    • getFileName

      public String getFileName()
      Gets the Job Order file name
      Returns:
      the fileName

    • setFileName

      public void setFileName(String fileName)
      Sets the Job Order file name
      Parameters:
      fileName - the file name to set

    • getConf

      public Conf getConf()
      Gets the Conf Job Order element
      Returns:
      the Job Order configuration

    • setConf

      public void setConf(Conf conf)
      Sets the Conf Job Order element
      Parameters:
      conf - the Job Order configuration to set

    • getListOfProcs

      public List<Proc> getListOfProcs()
      Gets the List_of_Ipf_Procs element
      Returns:
      the list of processors

    • setListOfProcs

      public void setListOfProcs(List<Proc> listOfProcs)
      Sets the List_of_Ipf_Procs element
      Parameters:
      listOfProcs - the list of processors

    • writeXML

      @Deprecated public Boolean writeXML(String fileName, Boolean prosEOAttributes)
      Deprecated.
      Use writeXML(String,JobOrderVersion,Boolean) instead
      Build XML tree and write it to file named fileName.
      Parameters:
      fileName - the file name
      prosEOAttributes - if true, write attributes of prosEO specific data
      Returns:
      true after success, else false

    • writeXML

      public Boolean writeXML(String fileName, JobOrderVersion jobOrderVersion, Boolean prosEOAttributes)
      Build XML tree and write it to file named fileName.
      Parameters:
      fileName - the file name
      jobOrderVersion - the Job Order file specification version to apply
      prosEOAttributes - if true, write attributes of prosEO specific data
      Returns:
      true after success, else false

    • buildBase64String

      public String buildBase64String(JobOrderVersion jobOrderVersion, Boolean prosEOAttributes)
      Create a Base64-coded string from the XML representation of this Job Order
      Parameters:
      jobOrderVersion - the Job Order file specification version to apply
      prosEOAttributes - if true, write attributes of prosEO specific data
      Returns:
      the Base64-coded string

    • writeXMLToStream

      @Deprecated public Boolean writeXMLToStream(OutputStream aStream, Boolean prosEOAttributes)
      Deprecated.
      Use writeXMLToStream(OutputStream,Boolean,JobOrderVersion) instead
      Writes the content of the Job Order to an XML-formatted output stream conforming to the MMFI_1_8 Job Order file syntax
      Parameters:
      aStream - the stream to write to
      prosEOAttributes - if true, write attributes of prosEO specific data
      Returns:
      true, if the operation completed successfully, false otherwise

    • writeXMLToStream

      public Boolean writeXMLToStream(OutputStream aStream, Boolean prosEOAttributes, JobOrderVersion jobOrderVersion)
      Writes the content of the Job Order to an XML-formatted output stream
      Parameters:
      aStream - the stream to write to
      prosEOAttributes - if true, write attributes of prosEO specific data
      jobOrderVersion - the Job Order file specification version to apply
      Returns:
      true, if the operation completed successfully, false otherwise

    • read

      public JobOrder read(String jobOrderString)
      Read a Job Order from an XML-formatted string
      Parameters:
      jobOrderString - the XML-formatted Job Order File
      Returns:
      the modified Job Order object or null, if the string cannot be parsed into a Job Order object