io.dylemma.spac

Splitter

trait Splitter[In, +Context] extends AnyRef

A stream transformation which divides a stream of In events into substreams, where each substream is associated with a Context value.

A splitter must be combined with a Consumer via the through method. The consumer will be run on each of the substreams created by this splitter, generating a single value for each substream. The combination of a Splitter and a Consumer/Parser yields a Transformer.

For example, given a stream of symbols like

A A [ 1 2 3 ] B C [ 4 5 6 ]

an example Splitter might use [ and ] as signals that a context is starting or ending, respectively. So the substreams identified by that splitter would be

The example splitter would need to be combined with a Consumer/Parser that understands those substreams individually. For example, a Consumer that calculates the sum of the numbers between the [ and ] would generate the following results for each respective substream:

Thus the combination of the example splitter and the summing consumer would yield a transformer that turns the stream A A [ 1 2 3 ] B C [ 4 5 6 ] into the stream 6 15. That transformer will need to be attached to some downstream handler to produce a meaningful value from the transformed stream, e.g. a Consumer.toList could consume the 6 15 stream as a List(6, 15).

In
Context

Self Type
Splitter[In, Context]
Source
Splitter.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Splitter
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def makeHandler[Out](downstream: ContextSensitiveHandler[In, Context, Out]): Handler[In, Out]

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Splitter[In, Context] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Splitter[In, Context], B)

    Implicit information
    This member is added by an implicit conversion from Splitter[In, Context] to ArrowAssoc[Splitter[In, Context]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. def as[P](implicit parser: (Context) ⇒ HandlerFactory[In, P]): Transformer[In, P]

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ensuring(cond: (Splitter[In, Context]) ⇒ Boolean, msg: ⇒ Any): Splitter[In, Context]

    Implicit information
    This member is added by an implicit conversion from Splitter[In, Context] to Ensuring[Splitter[In, Context]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Splitter[In, Context]) ⇒ Boolean): Splitter[In, Context]

    Implicit information
    This member is added by an implicit conversion from Splitter[In, Context] to Ensuring[Splitter[In, Context]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Splitter[In, Context]

    Implicit information
    This member is added by an implicit conversion from Splitter[In, Context] to Ensuring[Splitter[In, Context]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Splitter[In, Context]

    Implicit information
    This member is added by an implicit conversion from Splitter[In, Context] to Ensuring[Splitter[In, Context]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def flatMap[P](joiner: (Context) ⇒ Transformer[In, P]): Transformer[In, P]

  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Splitter[In, Context] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  23. def map[P](joiner: (Context) ⇒ HandlerFactory[In, P]): Transformer[In, P]

    Combine this splitter with a "joiner" which obtains a consumer (generalized as a HandlerFactory for its substreams based on a Context value.

    Combine this splitter with a "joiner" which obtains a consumer (generalized as a HandlerFactory for its substreams based on a Context value. If the consumer logic is independent of any Context value, you can pass a HandlerFactory directly instead of wrapping it as a function, since HandlerFactory extends Any => HandlerFactory.

    P

    The result type returned by the consumer logic

    joiner

    The consumer logic for substreams generated by this Splitter

    returns

    A Transformer that feeds inputs through this splitter to create substreams, then feeds those substreams into the joiner to create Out values that will be passed downstream.

  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  28. def toString(): String

    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def [B](y: B): (Splitter[In, Context], B)

    Implicit information
    This member is added by an implicit conversion from Splitter[In, Context] to ArrowAssoc[Splitter[In, Context]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Splitter[In, Context] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (splitter: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Splitter[In, Context] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (splitter: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def through[P](joiner: (Context) ⇒ HandlerFactory[In, P]): Transformer[In, P]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.6) Use .map instead

  2. def x: Splitter[In, Context]

    Implicit information
    This member is added by an implicit conversion from Splitter[In, Context] to ArrowAssoc[Splitter[In, Context]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (splitter: ArrowAssoc[Splitter[In, Context]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: Splitter[In, Context]

    Implicit information
    This member is added by an implicit conversion from Splitter[In, Context] to Ensuring[Splitter[In, Context]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (splitter: Ensuring[Splitter[In, Context]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Splitter[In, Context] to StringAdd

Inherited by implicit conversion any2stringfmt from Splitter[In, Context] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Splitter[In, Context] to ArrowAssoc[Splitter[In, Context]]

Inherited by implicit conversion any2Ensuring from Splitter[In, Context] to Ensuring[Splitter[In, Context]]

Ungrouped