Packages

class PortSpecification extends AnyRef

Specify the valid bindings for step inputs or outputs

The core engine doesn't care what steps are connected or what ports they're connected on. But in practice, many steps do care. If you have a step that expects to read a single document off the source port and to write a sequence of documents to the result port, it does no good to run a pipeline where those ports aren't connected.

A port binding specification identifies the ports that the step expects to read from (or write to) and what the acceptable cardinality of documents is on those ports.

The port named PortSpecification.WILDCARD serves as a wildcard for ports of any name

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

Instance Constructors

  1. new PortSpecification(spec: Map[String, PortCardinality])

    A port binding specification.

    A port binding specification.

    spec

    A map from port names to cardinalities.

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 cardinality(port: String): Option[PortCardinality]
  6. def checkInputCardinality(port: String, count: Long): Unit

    Check the actual input cardinality against the specification.

    Check the actual input cardinality against the specification.

    This method throws a com.jafpl.exceptions.JafplException if the count of documents provided on this port is not acceptable according to the defined cardinality.

    port

    The port name.

    count

    The number of documents that appeared on that port.

  7. def checkOutputCardinality(port: String, count: Long): Unit

    Check the actual output cardinality against the specification.

    Check the actual output cardinality against the specification.

    This method throws a com.jafpl.exceptions.JafplException if the count of documents provided on this port is not acceptable according to the defined cardinality.

    port

    The port name.

    count

    The number of documents that appeared on that port.

  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def ports: Set[String]

    List the ports in this specification.

    List the ports in this specification.

    returns

    the set of ports

  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped