Packages

c

com.jafpl.runtime

GraphRuntime

class GraphRuntime extends AnyRef

Execute a pipeline.

The graph runtime executes a pipeline.

If the specified graph is open, it will be closed. If it is not valid, an exception is thrown.

Constructing the runtime builds the network of Akka actors. If for some reason you decide not to run the pipeline, you must call stop to tear it down.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GraphRuntime
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GraphRuntime(graph: Graph, runtime: RuntimeConfiguration)

    A graph runtime.

    A graph runtime.

    graph

    The graph to execute.

    runtime

    Runtime context information for the execution.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def exception: Option[Throwable]

    Returns an optional exception raised during execution.

    Returns an optional exception raised during execution.

    If the pipeline execution halts because an uncaught exception is thrown, the exception is available from here after the pipeline finishes.

  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def finish(cause: Throwable): Unit
    Attributes
    protected[com.jafpl.runtime]
  11. def finish(): Unit
    Attributes
    protected[com.jafpl.runtime]
  12. def finished: Boolean

    Returns true if the pipeline execution has finished.

  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  14. val graph: Graph
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  16. def inputs: Map[String, DataProvider]

    A map of the inputs that the pipeline expects.

    A map of the inputs that the pipeline expects.

    This mapping from names (strings) to com.jafpl.steps.DataConsumers is the set of inputs that the pipeline expects from the outside world. If you do not provide an input, an empty sequence of items will be provided.

    returns

    A map of the expected inputs.

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val logger: Logger
    Attributes
    protected[com.jafpl]
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  22. def outputs: Map[String, DataConsumerProxy]

    A map of the outputs that the pipeline produces.

    A map of the outputs that the pipeline produces.

    This mapping from names (strings) to com.jafpl.steps.DataConsumerProxys is the set of outputs that the pipeline. If you do not call the setProvider method, the output will be discarded.

    returns

    A map of the expected inputs.

  23. def run(): Unit

    Runs the pipeline.

    Runs the pipeline.

    This method will block until pipeline execution finishes.

  24. def runInBackground(): Unit

    Runs the pipeline.

    Runs the pipeline.

    This method starts execution of the pipeline and then returns immediately. The pipeline will continue to run in other threads.

    To determine if execution has completed, check the finished value.

  25. val runtime: RuntimeConfiguration
  26. def setOption(option: String, value: Any): Unit

    Set the value of an option.

    Set the value of an option.

    option

    The option name

    value

    The value

  27. def started: Boolean

    Returns true if the pipeline execution has started.

  28. def stop(): Unit
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. def traceEventManager: TraceEventManager
  32. def traceEventManager_=(manager: TraceEventManager): Unit
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def waitForPipeline(): Unit

    Wait for pipeline execution to complete.

    Wait for pipeline execution to complete.

    If you start a pipeline in the background and then wish to block until execution completes, call this method.

Inherited from AnyRef

Inherited from Any

Ungrouped