Package com.atgenomix.seqslab.piper.plugin.api

Class PluginContext

java.lang.Object
com.atgenomix.seqslab.piper.plugin.api.PluginContext
All Implemented Interfaces:
Serializable
public class PluginContext extends Object implements Serializable
An object returned when initializing this SeqsLab piper. It stores PiperContext and represents a persistent set of plugin-specific properties, which will be passed to registered operator factory to create the plugin-specific pipeline operators.
See Also:

  • Field Details

    • piper

      public final PiperContext piper
      An object used in all operations of a workflow task execution.

    • properties

      protected Map<String,Object> properties
      A persistent set of plugin-specific properties.

  • Constructor Details

    • PluginContext

      public PluginContext(PiperContext piperContext)
      Creates a plugin context object with Seqslab piper context.
      Parameters:
      piperContext - A PiperContext object.

  • Method Details

    • getProperty

      public Object getProperty(String key)
      Calls the Hashtable method get.
      Parameters:
      key - The property key.
      Returns:
      The value of the specified key.

    • setProperty

      public Object setProperty(String key, Object value)
      Calls the Hashtable method put. The value returned is the result of the Hashtable call to put.
      Parameters:
      key - The key to be placed into this PluginContext property list.
      value - The value corresponding to the key.
      Returns:
      The result of the Hashtable put call.