Packages

abstract class Node extends AnyRef

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.

Linear Supertypes
AnyRef, Any
Known Subclasses
AtomicNode, Binding, CatchStart, ChooseStart, ContainerStart, FinallyStart, LoopEachStart, LoopStart, OptionBinding, TryCatchStart
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Node
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Node(graph: Graph, step: Option[Step], userLabel: Option[String])

    A node in the pipeline graph.

    A node in the pipeline graph.

    graph

    The graph into which this node is to be inserted.

    step

    An optional implementation step.

    userLabel

    An optional user-defined label.

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. val _staticBindings: HashMap[Binding, Message]
    Attributes
    protected[com.jafpl]
  5. def addInputInjectable(injectable: PortInjectable): Unit
  6. def addOutputInjectable(injectable: PortInjectable): Unit
  7. def addStepInjectable(injectable: StepInjectable): Unit
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def bindings: Set[String]

    The names of this step's variable bindings.

    The names of this step's variable bindings.

    This method returns the names of the variables for which this step will receive bindings at runtime.

    returns

    The variable names.

  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  11. def dependsOn(node: Node): Unit

    Add a dependency edge.

    Add a dependency edge.

    This method asserts that the current node depends on another node. Ordinarily, data flow establishes dependencies automatically. If step A consumes the output of step B, the pipeline will assure that step B runs before step A.

    In cases where there is no data flow dependency, but it's still necessary to force an order, you can impose one by saying that A.dependsOn(B).

    node

    The node in the graph which must be run before this one

  12. def dumpClosed(depth: Int): Elem
    Attributes
    protected[com.jafpl.graph]
  13. def dumpClosedChildren(depth: Int): scala.xml.Node
    Attributes
    protected[com.jafpl.graph]
  14. def dumpOpen(depth: Int): Elem
    Attributes
    protected[com.jafpl.graph]
  15. def dumpOpenChildren(depth: Int): scala.xml.Node
    Attributes
    protected[com.jafpl.graph]
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. val graph: Graph
  21. def hasOutputEdge(port: String): Boolean
    Attributes
    protected[com.jafpl]
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. val id: String

    A unique identifier for this node.

    A unique identifier for this node.

    Every node has a unique identifier.

  24. val inputCardinalities: HashMap[String, Long]
    Attributes
    protected[com.jafpl]
  25. def inputEdge(port: String): Edge
    Attributes
    protected[com.jafpl]
  26. val inputInjectables: ListBuffer[PortInjectable]
    Attributes
    protected[com.jafpl]
  27. def inputs: Set[String]

    The names of this step's input ports.

    The names of this step's input ports.

    returns

    The input port names.

  28. def internal_name: String
    Attributes
    protected[com.jafpl.graph]
  29. def internal_name_=(newname: String): Unit
    Attributes
    protected[com.jafpl.graph]
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def label: String

    The node label.

    The node label.

    Labels are used in output to help identify the node in question. The id of the node is always appended to the label.

  32. def location: Option[Location]

    The node's location.

    The node's location.

    The node location will be used for reporting (for example in errors).

  33. def location_=(loc: Location): Unit
    Attributes
    protected[com.jafpl]
  34. val logger: Logger
    Attributes
    protected
  35. def manifold: Option[ManifoldSpecification]
  36. def manifold_=(man: ManifoldSpecification): Unit
    Attributes
    protected[com.jafpl]
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. val outputCardinalities: HashMap[String, Long]
    Attributes
    protected[com.jafpl]
  41. def outputEdge(port: String): Edge
    Attributes
    protected[com.jafpl]
  42. val outputInjectables: ListBuffer[PortInjectable]
    Attributes
    protected[com.jafpl]
  43. def outputs: Set[String]

    The names of this step's output ports.

    The names of this step's output ports.

    returns

    The output port names.

  44. def parent: Option[ContainerStart]

    This node's parent.

    This node's parent.

    returns

    This node's parent.

  45. def state: NodeState
  46. def stateTransition(newState: NodeState): Unit
  47. def staticBindings: Map[Binding, Message]
  48. def staticBindings_=(bindings: Map[Binding, Message]): Unit

    Specify the static bindings that are in scope for this node.

    Specify the static bindings that are in scope for this node.

    Static bindings are known at "compile time" and don't appear in the graph. (You aren't required to have statics in your graph.)

    This method provides the node with the set of static bindings that are in-scope.

    bindings

    The static bindings that are in-scope for this node.

  49. val step: Option[Step]
  50. val stepInjectables: ListBuffer[StepInjectable]
    Attributes
    protected[com.jafpl]
  51. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  52. def toString(): String

    A string representation of this node.

    A string representation of this node.

    Definition Classes
    Node → AnyRef → Any
  53. val userLabel: Option[String]
  54. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped