Packages

t

com.jafpl.steps

ViewportComposer

trait ViewportComposer extends AnyRef

Decompose and recompose data for viewport processing.

Viewports operate on sub-portions of a resource (some of the children in an XML document, some of the properties in a JSON object, etc.).

The decompose method is called before the viewport processing begins. It extracts the sub-portions that should be processed and returns them. Each returned item is mutable and will be updated by the viewport processing.

The method by which sub-portions are selected is irrelevant to the pipeline engine. Often it will be convenient to pass an expression or other data to the implementation of the composer to control the selection.

Note: it's an implementation detail whether the items returned are pointers into the original data structure or copies of them. If they are pointers into the original data structure, then viewport steps may be able to navigate outside the confines of the sub-portion selected. For better or worse.

The recompose method is called after viewport processing is complete. The composer reassembles the resource using the transformed portions and returns the resulting resource.

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

Abstract Value Members

  1. abstract def decompose(message: Message): List[ViewportItem]

    Decompose the specified item into sub-portions for viewport processing.

    Decompose the specified item into sub-portions for viewport processing.

    message

    The message containing the item to be processed by the viewport.

    returns

    A list of sub-portions to process in the viewport.

  2. abstract def recompose(): Message

    Recompose the item.

    Recompose the item.

    returns

    The recomposed item.

  3. abstract def runtimeBindings(bindings: Map[String, Message]): Unit

    Inform the composer of any in-scope bindings

    Inform the composer of any in-scope bindings

    bindings

    The map of name/binding message pairs

Concrete 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 clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped