Packages

c

com.jafpl.graph

ContainerStart

class ContainerStart extends Node

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.

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

Instance Constructors

  1. new ContainerStart(graph: Graph, end: ContainerEnd, userLabel: Option[String])

    A container in the pipeline graph.

    A container in the pipeline graph.

    graph

    The graph into which this node is to be inserted.

    end

    The end of this container.

    userLabel

    An optional user-defined label.

    Attributes
    protected[com.jafpl]

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. def addAtomic(step: Step, label: Option[String]): Node

    Add a new atomic step to this container.

    Add a new atomic step to this container.

    step

    The step implementation.

    label

    An optional, user-defined label.

    returns

    The node added.

  5. def addAtomic(step: Step, label: String): Node

    Add a new atomic step to this container.

    Add a new atomic step to this container.

    step

    The step implementation.

    label

    A user-defined label.

    returns

    The node added.

  6. def addAtomic(step: Step): Node

    Add a new atomic step to this container.

    Add a new atomic step to this container.

    step

    The step implementation.

    returns

    The node added.

  7. def addChild(node: Node): Unit
    Attributes
    protected[com.jafpl.graph]
  8. def addChoose(label: Option[String]): ChooseStart

    Add a new choose/when container to this container.

    Add a new choose/when container to this container.

    label

    An optional, user-defined label.

    returns

    The node added.

  9. def addChoose(label: String): ChooseStart

    Add a new choose/when container to this container.

    Add a new choose/when container to this container.

    label

    A user-defined label.

    returns

    The node added.

  10. def addChoose(): ChooseStart

    Add a new choose/when container to this container.

    Add a new choose/when container to this container.

    returns

    The node added.

  11. def addEmptySource(): EmptySource
    Attributes
    protected[com.jafpl.graph]
  12. def addFor(label: Option[String], countFrom: Long, countTo: Long, countBy: Long, manifold: ManifoldSpecification): LoopForStart

    Add a new for-loop container to this container.

    Add a new for-loop container to this container.

    label

    An optional, user-defined label.

    returns

    The node added.

  13. def addFor(label: String, countFrom: Long, countTo: Long, countBy: Long, manifold: ManifoldSpecification): LoopForStart
  14. def addFor(countFrom: Long, countTo: Long, countBy: Long, manifold: ManifoldSpecification): LoopForStart
  15. def addFor(label: String, countFrom: Long, countTo: Long, manifold: ManifoldSpecification): LoopForStart
  16. def addFor(countFrom: Long, countTo: Long, manifold: ManifoldSpecification): LoopForStart
  17. def addFor(label: String, countTo: Long, manifold: ManifoldSpecification): LoopForStart

    Add a new for-loop container to this container.

    Add a new for-loop container to this container.

    label

    A user-defined label.

    returns

    The node added.

  18. def addFor(countTo: Long, manifold: ManifoldSpecification): LoopForStart

    Add a new for-loop container to this container.

    Add a new for-loop container to this container.

    returns

    The node added.

  19. def addForEach(label: Option[String], manifold: ManifoldSpecification): LoopEachStart

    Add a new for-each container to this container.

    Add a new for-each container to this container.

    label

    An optional, user-defined label.

    returns

    The node added.

  20. def addForEach(label: String, manifold: ManifoldSpecification): LoopEachStart

    Add a new for-each container to this container.

    Add a new for-each container to this container.

    label

    A user-defined label.

    returns

    The node added.

  21. def addForEach(manifold: ManifoldSpecification): LoopEachStart

    Add a new for-each container to this container.

    Add a new for-each container to this container.

    returns

    The node added.

  22. def addGroup(label: Option[String], manifold: ManifoldSpecification): ContainerStart

    Add a new group container to this container.

    Add a new group container to this container.

    label

    An optional, user-defined label.

    returns

    The node added.

  23. def addGroup(label: String, manifold: ManifoldSpecification): ContainerStart

    Add a new group container to this container.

    Add a new group container to this container.

    label

    A user-defined label.

    returns

    The node added.

  24. def addGroup(manifold: ManifoldSpecification): ContainerStart

    Add a new group container to this container.

    Add a new group container to this container.

    returns

    The node added.

  25. def addInputInjectable(injectable: PortInjectable): Unit
    Definition Classes
    Node
  26. def addJoiner(mode: JoinMode): Joiner
    Attributes
    protected[com.jafpl.graph]
  27. def addOption(name: String, expression: Any, staticValue: Option[Any], options: Any): Binding
  28. def addOption(name: String, expression: Any, staticValue: Option[Any]): Binding
  29. def addOption(name: String, expression: Any): Binding

    Add a option to this container.

    Add a option to this container.

    This method inserts an option binding into the container. This binding is effectively the source of a options's value. Other steps may connect to this binding in order to read its computed value at runtime.

    Option bindings consist of a name and an expression. The name and expression are arbitrary. At runtime the com.jafpl.runtime.ExpressionEvaluator provided as part of the com.jafpl.runtime.GraphRuntime must understand how to evaluate the expression.

    Unlike a variable, an option value can be supplied at runtime which will be used *instead* of evaluating the expression.

    At runtime, the computed values are provided to steps through binding edges.

    returns

    The node added.

  30. def addOutputInjectable(injectable: PortInjectable): Unit
    Definition Classes
    Node
  31. def addSink(): Sink
    Attributes
    protected[com.jafpl.graph]
  32. def addSplitter(): Splitter
    Attributes
    protected[com.jafpl.graph]
  33. def addStepInjectable(injectable: StepInjectable): Unit
    Definition Classes
    Node
  34. def addTryCatch(label: Option[String]): TryCatchStart

    Add a new try/catch container to this container.

    Add a new try/catch container to this container.

    label

    An optional, user-defined label.

    returns

    The node added.

  35. def addTryCatch(label: String): TryCatchStart

    Add a new try/catch container to this container.

    Add a new try/catch container to this container.

    label

    A user-defined label.

    returns

    The node added.

  36. def addTryCatch(): TryCatchStart

    Add a new try/catch container to this container.

    Add a new try/catch container to this container.

    returns

    The node added.

  37. def addUntil(comparator: ItemComparator, label: Option[String], manifold: ManifoldSpecification): LoopUntilStart

    Add a new until container to this container.

    Add a new until container to this container.

    comparator

    The comparator.

    label

    An optional, user-defined label.

    returns

    The node added.

  38. def addUntil(comparator: ItemComparator, label: String, manifold: ManifoldSpecification): LoopUntilStart

    Add a new until container to this container.

    Add a new until container to this container.

    comparator

    The comparator.

    label

    A user-defined label.

    returns

    The node added.

  39. def addUntil(comparator: ItemComparator, manifold: ManifoldSpecification): LoopUntilStart

    Add a new until container to this container.

    Add a new until container to this container.

    comparator

    The comparator.

    returns

    The node added.

  40. def addVariable(name: String, expression: Any, staticValue: Option[Any], options: Any): Binding
  41. def addVariable(name: String, expression: Any, staticValue: Option[Any]): Binding
  42. def addVariable(name: String, expression: Any): Binding

    Add a variable to this container.

    Add a variable to this container.

    This method inserts a variable binding into the container. This binding is effectively the source of a variable's value. Other steps may connect to this binding in order to read its computed value at runtime.

    Variable bindings consist of a name and an expression. The name and expression are arbitrary. At runtime the com.jafpl.runtime.ExpressionEvaluator provided as part of the com.jafpl.runtime.GraphRuntime must understand how to evaluate the expression.

    At runtime, the computed values are provided to steps through binding edges.

    returns

    The node added.

  43. def addViewport(composer: ViewportComposer, label: Option[String]): ViewportStart

    Add a new viewport container to this container.

    Add a new viewport container to this container.

    label

    An optional, user-defined label.

    returns

    The node added.

  44. def addViewport(composer: ViewportComposer, label: String): ViewportStart

    Add a new viewport container to this container.

    Add a new viewport container to this container.

    label

    A user-defined label.

    returns

    The node added.

  45. def addViewport(composer: ViewportComposer): ViewportStart

    Add a new viewport container to this container.

    Add a new viewport container to this container.

    returns

    The node added.

  46. def addWhile(tester: ItemTester, label: Option[String], manifold: ManifoldSpecification): LoopWhileStart

    Add a new while container to this container.

    Add a new while container to this container.

    tester

    The test evaluator.

    label

    An optional, user-defined label.

    returns

    The node added.

  47. def addWhile(tester: ItemTester, label: String, manifold: ManifoldSpecification): LoopWhileStart

    Add a new while container to this container.

    Add a new while container to this container.

    tester

    The test evaluator.

    label

    A user-defined label.

    returns

    The node added.

  48. def addWhile(tester: ItemTester, manifold: ManifoldSpecification): LoopWhileStart

    Add a new while container to this container.

    Add a new while container to this container.

    tester

    The test evaluator.

    returns

    The node added.

  49. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  50. 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.

    Definition Classes
    Node
  51. def children: List[Node]

    The children of this container.

  52. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. def containerEnd: ContainerEnd
    Attributes
    protected[com.jafpl]
  54. 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

    Definition Classes
    Node
  55. def dump(depth: Int): Elem
    Attributes
    protected[com.jafpl.graph]
    Definition Classes
    Node
  56. def dumpChildren(depth: Int): scala.xml.Node
    Attributes
    protected[com.jafpl.graph]
    Definition Classes
    ContainerStartNode
  57. val end: ContainerEnd
    Attributes
    protected
  58. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  59. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  60. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  61. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  62. val graph: Graph
    Definition Classes
    ContainerStartNode
  63. def hasOutputEdge(port: String): Boolean
    Attributes
    protected[com.jafpl]
    Definition Classes
    Node
  64. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  65. val id: String

    A unique identifier for this node.

    A unique identifier for this node.

    Every node has a unique identifier.

    Definition Classes
    Node
  66. val inputCardinalities: HashMap[String, Long]
    Attributes
    protected[com.jafpl]
    Definition Classes
    Node
  67. def inputEdge(port: String): Edge
    Attributes
    protected[com.jafpl]
    Definition Classes
    Node
  68. val inputInjectables: ListBuffer[PortInjectable]
    Attributes
    protected[com.jafpl]
    Definition Classes
    Node
  69. 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.

    Definition Classes
    Node
  70. def internal_name: String
    Attributes
    protected[com.jafpl.graph]
    Definition Classes
    Node
  71. def internal_name_=(newname: String): Unit
    Attributes
    protected[com.jafpl.graph]
    Definition Classes
    Node
  72. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  73. 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.

    Definition Classes
    Node
  74. def location: Option[Location]

    The node's location.

    The node's location.

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

    Definition Classes
    Node
  75. def location_=(loc: Location): Unit
    Attributes
    protected[com.jafpl]
    Definition Classes
    Node
  76. val logger: Logger
    Attributes
    protected
    Definition Classes
    Node
  77. def manifold: Option[ManifoldSpecification]
    Definition Classes
    Node
  78. def manifold_=(man: ManifoldSpecification): Unit
    Attributes
    protected[com.jafpl]
    Definition Classes
    Node
  79. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  80. final def notify(): Unit
    Definition Classes
    AnyRef
  81. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  82. val outputCardinalities: HashMap[String, Long]
    Attributes
    protected[com.jafpl]
    Definition Classes
    Node
  83. def outputEdge(port: String): Edge
    Attributes
    protected[com.jafpl]
    Definition Classes
    Node
  84. val outputInjectables: ListBuffer[PortInjectable]
    Attributes
    protected[com.jafpl]
    Definition Classes
    Node
  85. 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.

    Definition Classes
    Node
  86. def parent: Option[ContainerStart]

    This node's parent.

    This node's parent.

    returns

    This node's parent.

    Definition Classes
    Node
  87. val step: Option[Step]
    Definition Classes
    Node
  88. val stepInjectables: ListBuffer[StepInjectable]
    Attributes
    protected[com.jafpl]
    Definition Classes
    Node
  89. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  90. def toString(): String

    A string representation of this node.

    A string representation of this node.

    Definition Classes
    Node → AnyRef → Any
  91. val userLabel: Option[String]
    Definition Classes
    ContainerStartNode
  92. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  93. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  94. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Node

Inherited from AnyRef

Inherited from Any

Ungrouped