Package omero.grid

Class JobParams

  • All Implemented Interfaces:
    Ice.Object, java.io.Serializable, java.lang.Cloneable
    public class JobParams
extends Internal
    Complete job description with all input and output Params. JobParams contain information about who wrote a script, what its purpose is, and how it should be used, and are defined via the "omero.scripts.client" method. 
     c = omero.scripts.client(name="my algorithm", version="0.0.1")
    Alternatively, a JobParams instance can be passed into the constructor: 
     params = omero.grid.JobParams()
 params.authors = \["Andy", "Kathy"]
 params.version = "0.0.1"
 params.description = """
 Clever way to count to 5
 """
 c = omero.scripts.client(params)
    A single JobParam instance is parsed from a script and stored by the server. Later invocations re-use this instance until the script changes.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String[] __ids  
      java.lang.String[] authors
      Information about the authors who took part in creating this script.
      int[][] authorsInstitutions
      For authors\[i], authorInstitutions\[i] should be and array of indexes j such that author i is a member of authorsInstitutions\[i]\[j].
      java.lang.String contact
      Single, human-readable string for how to contact the script author.
      java.lang.String description
      A general description of a script, including documentation on how it should be used, what data it will access, and other metrics like how long it takes to execute, etc.
      java.util.Map<java.lang.String,​Param> inputs
      Definitive list of the inputs which MAY or MUST be provided to the script, based on the "optional" flag.
      java.lang.String[] institutions
      Information about the institutions which took part in creating this script.
      java.lang.String name
      Descriptive name for this script.
      java.util.List<java.lang.String> namespaces
      Defines machine readable interpretations for this JobParams.
      java.util.Map<java.lang.String,​Param> outputs
      Definitive list of the outputs which MAY or MUST be provided to the script, based on the "optional" flag.
      static long serialVersionUID  
      java.lang.String stderrFormat
      omero.model.Format.value of the stderr stream produced by the script.
      java.lang.String stdoutFormat
      omero.model.Format.value of the stdout stream produced by the script.
      java.lang.String version
      Author-given version number for this script.

      • Fields inherited from interface Ice.Object

        ice_staticId

    • Constructor Summary

      Constructors 
      Constructor Description
      JobParams()  
      JobParams​(java.lang.String name, java.lang.String version, java.lang.String description, java.lang.String contact, java.lang.String[] authors, java.lang.String[] institutions, int[][] authorsInstitutions, java.util.Map<java.lang.String,​Param> inputs, java.util.Map<java.lang.String,​Param> outputs, java.lang.String stdoutFormat, java.lang.String stderrFormat, java.util.List<java.lang.String> namespaces)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void __readImpl​(IceInternal.BasicStream __is)  
      protected void __writeImpl​(IceInternal.BasicStream __os)  
      JobParams clone()  
      static Ice.ObjectFactory ice_factory()  
      java.lang.String ice_id()  
      java.lang.String ice_id​(Ice.Current __current)  
      java.lang.String[] ice_ids()  
      java.lang.String[] ice_ids​(Ice.Current __current)  
      boolean ice_isA​(java.lang.String s)  
      boolean ice_isA​(java.lang.String s, Ice.Current __current)  
      static java.lang.String ice_staticId()  

      • Methods inherited from class Ice.ObjectImpl

        ___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __dispatch, __read, __read, __readImpl, __write, __write, __writeImpl, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • __ids

        public static final java.lang.String[] __ids

      • name

        public java.lang.String name
        Descriptive name for this script. This value should be unique where possible, but no assurance is provided by the server that multiple scripts with the same name are not present.

      • version

        public java.lang.String version
        Author-given version number for this script. Please see the script authors' guide for information about choosing version numbers.

      • description

        public java.lang.String description
        A general description of a script, including documentation on how it should be used, what data it will access, and other metrics like how long it takes to execute, etc.

      • contact

        public java.lang.String contact
        Single, human-readable string for how to contact the script author.

      • authors

        public java.lang.String[] authors
        Information about the authors who took part in creating this script. No particular format is required.

      • institutions

        public java.lang.String[] institutions
        Information about the institutions which took part in creating this script. No particular format is required.

      • authorsInstitutions

        public int[][] authorsInstitutions
        For authors\[i], authorInstitutions\[i] should be and array of indexes j such that author i is a member of authorsInstitutions\[i]\[j]. Example: authors = \["Jane", "Mike"] institutions = \["Acme U.", "Private Corp."] authorsInstitutions = \[\[1, 2], \[1]] which means that Jane is a member of both "Acme U." and "Private Corp." while Mike is only a member of "Acme U." An empty authorsInstitutions array implies that all authors are from all institutions.

      • inputs

        public java.util.Map<java.lang.String,​Param> inputs
        Definitive list of the inputs which MAY or MUST be provided to the script, based on the "optional" flag.

      • outputs

        public java.util.Map<java.lang.String,​Param> outputs
        Definitive list of the outputs which MAY or MUST be provided to the script, based on the "optional" flag.

      • stdoutFormat

        public java.lang.String stdoutFormat
        omero.model.Format.value of the stdout stream produced by the script. If this value is not otherwise set (i.e. is None), the default of "text/plain" will be set. This is typically a good idea if the script uses "print" or the logging module. If you would like to disable stdout upload, set the value to "" (the empty string). "text/html" or "application/octet-stream" might also be values of interest.

      • stderrFormat

        public java.lang.String stderrFormat
        omero.model.Format.value of the stderr stream produced by the script. If this value is not otherwise set (i.e. is None), the default of "text/plain" will be set. This is typically a good idea if the script uses "print" or the logging module. If you would like to disable stderr upload, set the value to "" (the empty string). "text/html" or "application/octet-stream" might also be values of interest.

      • namespaces

        public java.util.List<java.lang.String> namespaces
        Defines machine readable interpretations for this JobParams.

        Where the description field should provide information for users, the assigned namespaces can define how clients may interpret the script, including which categories or algorithm types the script belongs to.

    • Constructor Detail

      • JobParams

        public JobParams()

      • JobParams

        public JobParams​(java.lang.String name,
                 java.lang.String version,
                 java.lang.String description,
                 java.lang.String contact,
                 java.lang.String[] authors,
                 java.lang.String[] institutions,
                 int[][] authorsInstitutions,
                 java.util.Map<java.lang.String,​Param> inputs,
                 java.util.Map<java.lang.String,​Param> outputs,
                 java.lang.String stdoutFormat,
                 java.lang.String stderrFormat,
                 java.util.List<java.lang.String> namespaces)

    • Method Detail

      • ice_factory

        public static Ice.ObjectFactory ice_factory()

      • ice_isA

        public boolean ice_isA​(java.lang.String s)
        Specified by:
        ice_isA in interface Ice.Object
        Overrides:
        ice_isA in class Internal

      • ice_isA

        public boolean ice_isA​(java.lang.String s,
                       Ice.Current __current)
        Specified by:
        ice_isA in interface Ice.Object
        Overrides:
        ice_isA in class Internal

      • ice_ids

        public java.lang.String[] ice_ids()
        Specified by:
        ice_ids in interface Ice.Object
        Overrides:
        ice_ids in class Internal

      • ice_ids

        public java.lang.String[] ice_ids​(Ice.Current __current)
        Specified by:
        ice_ids in interface Ice.Object
        Overrides:
        ice_ids in class Internal

      • ice_id

        public java.lang.String ice_id()
        Specified by:
        ice_id in interface Ice.Object
        Overrides:
        ice_id in class Internal

      • ice_id

        public java.lang.String ice_id​(Ice.Current __current)
        Specified by:
        ice_id in interface Ice.Object
        Overrides:
        ice_id in class Internal

      • ice_staticId

        public static java.lang.String ice_staticId()

      • __writeImpl

        protected void __writeImpl​(IceInternal.BasicStream __os)
        Overrides:
        __writeImpl in class Internal

      • __readImpl

        protected void __readImpl​(IceInternal.BasicStream __is)
        Overrides:
        __readImpl in class Internal

      • clone

        public JobParams clone()
        Specified by:
        clone in interface Ice.Object
        Overrides:
        clone in class Internal