Package io.github.kaststream.api

Interface FlatMapper

  • All Superinterfaces:
    Serializable
    public interface FlatMapper
extends Serializable
    Implement this interface to provide your own flat map function.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()
      Tear-down method for the user code.
      void flatMap​(org.apache.flink.types.Row row, org.apache.flink.util.Collector<org.apache.flink.types.Row> out)
      Your function implementation.
      org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> getProducedType​(org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> typeInfo)
      Declare the data type information of the data produced by your function.
      void open​(org.apache.flink.configuration.Configuration configuration, org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> typeInfo)
      Initialization method for the function.

    • Method Detail

      • flatMap

        void flatMap​(org.apache.flink.types.Row row,
             org.apache.flink.util.Collector<org.apache.flink.types.Row> out)
      throws Exception
        Your function implementation. Do what you need on the received rows.
        Parameters:
        row - the received row
        out - the output row collector
        Throws:
        Exception - The function may throw exceptions which cause the streaming program to fail and go into recovery.

      • getProducedType

        org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> getProducedType​(org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> typeInfo)
        Declare the data type information of the data produced by your function.
        Parameters:
        typeInfo - the input row type information
        Returns:
        the produced data typeInfo

      • open

        void open​(org.apache.flink.configuration.Configuration configuration,
          org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> typeInfo)
   throws Exception
        Initialization method for the function.
        Parameters:
        configuration - The configuration containing the parameters attached to the contract
        typeInfo - the input row type information
        Throws:
        Exception - The function may throw exceptions which cause the streaming program to fail and go into recovery.

      • close

        void close()
    throws Exception
        Tear-down method for the user code. It is called after the last call to the main working methods. For functions that are part of an iteration, this method will be invoked after each iteration superstep.

        This method can be used for clean up work.

        Throws:
        Exception - The function may throw exceptions which cause the streaming program to fail and go into recovery.