com.streambase.sb

## Interface TupleCaptureTransformer

-     public interface TupleCaptureTransformer

  A TupleCaptureTransformer represents a way of converting tuples with capture fields from inside the application to tuples without capture fields, with all of the fields stored in the capture expanded out to the same level as the capture field itself.
  Since:
    7.2

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `Tuple` | `collapse(Tuple in)` Capture all the extra fields in 'in' into their correct capture fields.
    `Tuple` | `expand(Tuple in)` Expand all the capture fields in 'in'
    `Schema` | `getCollapsedSchema()`
    `Schema` | `getExpandedSchema()`

- - ### Method Detail

    - #### getCollapsedSchema

          Schema getCollapsedSchema()

      Returns:
        the collapsed schema for this transformer. All applicable fields are inside their captures.

    - #### getExpandedSchema

          Schema getExpandedSchema()

      Returns:
        the destination schema for this transformer. All capture fields have been expanded out.

    - #### expand

          Tuple expand(Tuple in)
                throws TupleException

      Expand all the capture fields in 'in'
      Parameters:
        `in` -
      Returns:
        the expanded tuple
      Throws:
        `TupleException` - if in has the wrong schema

    - #### collapse

          Tuple collapse(Tuple in)
                  throws TupleException

      Capture all the extra fields in 'in' into their correct capture fields.
      Parameters:
        `in` -
      Returns:
        the tuple with all extra fields captured
      Throws:
        `TupleException` - if in has the wrong schema

Copyright © 2015–2018 Cloud Software Group, Inc.. All rights reserved.