Packages

p

com.jafpl

graph

package graph

The graph construction APIs.

A graph is returned by a com.jafpl.config.Jafpl configuration. The core type of a graph is the Node. Nodes cannot be created directly; instead they are created in the Graph or in a container (via its ContainerStart) through methods on those objects.

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

Type Members

  1. class AtomicNode extends Node

    An atomic node.

    An atomic node.

    Atomic nodes are the most common pipeline extension point. The implementation is provided by the step.

  2. class Binding extends Node

    A variable binding.

    A variable binding.

    When pipelines are constructed, variable bindings associate expressions with variable names. At runtime, the association is between the name and its computed value.

  3. class CatchStart extends ContainerStart

    The catch block of a try catch.

    The catch block of a try catch.

    Catch containers are created with the addCatch method of com.jafpl.graph.TryCatchStart.

  4. class ChooseStart extends ContainerStart

    A choose container.

    A choose container.

    Choose containers are created with the addChoose method of com.jafpl.graph.ContainerStart.

  5. class ContainerStart extends Node

    A node that contains other nodes.

    A node that contains other nodes.

    Conceptually, some nodes contain others. A loop, for example, contains the steps that form the body of the loop.

    In practice, containers are represented by a start and an end.

  6. class FinallyStart extends ContainerStart

    The catch block of a try catch.

    The catch block of a try catch.

    Catch containers are created with the addCatch method of com.jafpl.graph.TryCatchStart.

  7. class Graph extends AnyRef

    A pipeline graph.

    A pipeline graph.

    This is the fundamental API for constructing pipeline graphs. Once constructed, graphs can be executed with the com.jafpl.runtime.GraphRuntime.

    Graphs are initially open, meaning that nodes and edges can be added to them, and !valid, meaning that no attempt has been made to validate them.

    When all of the nodes and edges have been added to a graph, the graph is closed and validated by calling the close() method. Only valid graphs can be executed.

    Generally speaking, steps are either atomic (in which case you're responsible for providing their implementation) or containers. Each may have an optional label. The labels have no purpose except clarity in error messages and in the graph diagrams. Labels must begin with a letter and may consist of letters, digits, hyphens, and underscores.

  8. trait Location extends AnyRef

    A location.

    A location.

    This interface indentifies a location for use in subsequent reporting.

  9. class LoopEachStart extends LoopStart

    A for-each container.

    A for-each container.

    ForEach containers are created with the addForEach method of com.jafpl.graph.ContainerStart.

  10. abstract class LoopStart extends ContainerStart

    A looping container.

    A looping container.

    Loops need buffers when they read from steps outside the loop.

    In practice, containers are represented by a start and an end.

  11. abstract class Node extends AnyRef

    A node in the pipeline graph.

    A node in the pipeline graph.

    You can't instantiate nodes directly, see the methods on com.jafpl.graph.Graph and on com.jafpl.graph.ContainerStart and its subtypes.

  12. class NodeLocation extends Location
  13. class OptionBinding extends Binding

    An option binding.

    An option binding.

    When pipelines are constructed, option bindings associate expressions with variable names. At runtime, the association is between the name and its computed value.

    An OptionBinding is just like a Binding except that a specific, computed value may be provided before the graph begins executing. In that case, the provided value is used and the expression is not evaluated.

  14. class TryCatchStart extends ContainerStart

Value Members

  1. object JoinMode extends Enumeration
  2. object NodeLocation

Inherited from AnyRef

Inherited from Any

Ungrouped